Lyo.Metrics.OpenTelemetry
2.0.1
.NET 10.0
This package targets .NET 10.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
dotnet add package Lyo.Metrics.OpenTelemetry --version 2.0.1
NuGet\Install-Package Lyo.Metrics.OpenTelemetry -Version 2.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Lyo.Metrics.OpenTelemetry" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Lyo.Metrics.OpenTelemetry" Version="2.0.1" />
<PackageReference Include="Lyo.Metrics.OpenTelemetry" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Lyo.Metrics.OpenTelemetry --version 2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Lyo.Metrics.OpenTelemetry, 2.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Lyo.Metrics.OpenTelemetry@2.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Lyo.Metrics.OpenTelemetry&version=2.0.1
#tool nuget:?package=Lyo.Metrics.OpenTelemetry&version=2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Lyo.Metrics.OpenTelemetry
OpenTelemetry-backed IMetrics that ships metrics to OpenTelemetry-compatible backends.
Features
IMetricsimplementation sitting on OpenTelemetry instruments- Sanitizes metric names to OpenTelemetry conventions
- Converts tags into attributes
- Records metrics in a thread-safe way
OpenTelemetryOptionswithAddLyoMetricsWithOpenTelemetry/FromConfiguration- OTLP export (and
ILogger) whenEndpointorOTEL_EXPORTER_OTLP_ENDPOINTis set - Optional Console / Prometheus exporters via
configureMeterProvider
Examples
Register from a configure delegate
using Lyo.Metrics.OpenTelemetry;
services.AddLyoMetricsWithOpenTelemetry(o =>
{
o.ServiceName = "MyApp.Metrics";
o.Protocol = "grpc";
o.MetricExportIntervalMs = 1000;
// Leave Endpoint empty so OTEL_EXPORTER_OTLP_ENDPOINT (JetBrains plugin) can supply it.
});
Bind from appsettings
services.AddLyoMetricsWithOpenTelemetryFromConfiguration(builder.Configuration);
// appsettings.json:
// "OpenTelemetry": { "ServiceName": "MyApp", "Protocol": "grpc", "MetricExportIntervalMs": 1000 }
Export to Prometheus
services.AddLyoMetricsWithOpenTelemetry(o => o.ServiceName = "MyApp.Metrics", configureMeterProvider: builder =>
{
builder.AddPrometheusExporter(options =>
{
options.ScrapeEndpointPath = "/metrics";
});
});
Add a console exporter
services.AddLyoMetricsWithOpenTelemetry(o => o.ServiceName = "MyApp.Metrics", configureMeterProvider: builder =>
{
builder.AddConsoleExporter();
});
Sample
services.AddLyoMetricsWithOpenTelemetryFromConfiguration(builder.Configuration);
var metrics = serviceProvider.GetRequiredService<IMetrics>();
metrics.IncrementCounter("requests.total", tags: [("method", "GET"), ("status", "200")]);
using (metrics.StartTimer("operation.duration"))
{
// Your operation here
}
OTLP environment
OpenTelemetry:Endpoint— optional collector URL. Leave empty in committed config; the JetBrains plugin injectsOTEL_EXPORTER_OTLP_ENDPOINT(http://localhost:<port>gRPC).OpenTelemetry:Protocol/OTEL_EXPORTER_OTLP_PROTOCOL—grpcorhttp/protobuf. The JetBrains plugin expectsgrpc.OpenTelemetry:MetricExportIntervalMs/OTEL_METRIC_EXPORT_INTERVAL— flush interval in milliseconds (use1000so the plugin updates quickly).- When neither options
Endpointnor the OTLP endpoint variables are set,IMetricsstill records on OpenTelemetry instruments but nothing is exported.
How metric types map
- Counters. OpenTelemetry
Counter<long>is whatIncrementCounterbecomes. - Gauges. OpenTelemetry
Histogram<double>(push-based) is whatRecordGaugebecomes. - Histograms / timings. OpenTelemetry
Histogram<double>is whatRecordHistogram/RecordTimingbecome. - Errors. OpenTelemetry
Counter<long>plus error attributes is whatRecordErrorbecomes. - Events. OpenTelemetry
Counter<long>is whatRecordEventbecomes.
Sanitizing metric names
- Dots (
.) become underscores (_) - Hyphens (
-) become underscores (_) - A leading
_is added when a name starts with a digit
Turning tags into attributes
- Dots and hyphens in tag keys become underscores
- Tag values are left as-is
Dependencies
Generated from ProjectReference / PackageReference (same model as docs/Lyo.ProjectGraph.html).
Lyo.Exceptions(direct, lyo)Lyo.Metrics(direct, lyo)Microsoft.Extensions.DependencyInjection.Abstractions10.0.5(direct, microsoft)Microsoft.Extensions.Options10.0.5(direct, microsoft)OpenTelemetry1.16.0(direct, third-party)OpenTelemetry.Exporter.Console1.16.0(direct, third-party)OpenTelemetry.Exporter.OpenTelemetryProtocol1.16.0(direct, third-party)OpenTelemetry.Extensions.Hosting1.16.0(direct, third-party)
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Lyo.Exceptions (>= 2.0.0)
- Lyo.Metrics (>= 2.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Options (>= 10.0.5)
- OpenTelemetry (>= 1.16.0)
- OpenTelemetry.Exporter.Console (>= 1.16.0)
- OpenTelemetry.Exporter.OpenTelemetryProtocol (>= 1.16.0)
- OpenTelemetry.Extensions.Hosting (>= 1.16.0)
-
net10.0
- Lyo.Exceptions (>= 2.0.0)
- Lyo.Metrics (>= 2.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Options (>= 10.0.5)
- OpenTelemetry (>= 1.16.0)
- OpenTelemetry.Exporter.Console (>= 1.16.0)
- OpenTelemetry.Exporter.OpenTelemetryProtocol (>= 1.16.0)
- OpenTelemetry.Extensions.Hosting (>= 1.16.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.