SyZero.OpenTelemetry
1.1.5-dev.1
This is a prerelease version of SyZero.OpenTelemetry.
dotnet add package SyZero.OpenTelemetry --version 1.1.5-dev.1
NuGet\Install-Package SyZero.OpenTelemetry -Version 1.1.5-dev.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="SyZero.OpenTelemetry" Version="1.1.5-dev.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SyZero.OpenTelemetry" Version="1.1.5-dev.1" />
<PackageReference Include="SyZero.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 SyZero.OpenTelemetry --version 1.1.5-dev.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SyZero.OpenTelemetry, 1.1.5-dev.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 SyZero.OpenTelemetry@1.1.5-dev.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=SyZero.OpenTelemetry&version=1.1.5-dev.1&prerelease
#tool nuget:?package=SyZero.OpenTelemetry&version=1.1.5-dev.1&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
SyZero.OpenTelemetry
SyZero 框架的 OpenTelemetry 可观测性模块,提供分布式追踪和指标收集。
📦 安装
dotnet add package SyZero.OpenTelemetry
✨ 特性
- 🚀 分布式追踪 - 自动追踪 HTTP 请求和数据库调用
- 📊 指标收集 - 收集应用性能指标
- 🔗 链路追踪 - 跨服务调用链路追踪
🚀 快速开始
1. 配置 appsettings.json
{
"OpenTelemetry": {
"ServiceName": "my-service",
"Endpoint": "http://localhost:4317",
"EnableTracing": true,
"EnableMetrics": true
}
}
2. 注册服务
// Program.cs
var builder = WebApplication.CreateBuilder(args);
// 添加SyZero
builder.AddSyZero();
// 注册服务方式1 - 使用配置文件
builder.Services.AddSyZeroOpenTelemetry();
// 注册服务方式2 - 使用委托配置
builder.Services.AddSyZeroOpenTelemetry(options =>
{
options.ServiceName = "my-service";
options.Endpoint = "http://localhost:4317";
});
// 注册服务方式3 - 自定义导出器
builder.Services.AddSyZeroOpenTelemetry(options =>
{
options.ServiceName = "my-service";
options.UseJaeger("http://localhost:14268/api/traces");
});
var app = builder.Build();
// 使用SyZero
app.UseSyZero();
app.Run();
3. 使用示例
public class OrderService
{
private readonly ITracer _tracer;
public OrderService(ITracer tracer)
{
_tracer = tracer;
}
public async Task CreateOrderAsync(Order order)
{
using var span = _tracer.StartSpan("CreateOrder");
span.SetAttribute("order.id", order.Id);
// 业务逻辑
span.SetStatus(Status.Ok);
}
}
📖 配置选项
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
ServiceName |
string |
"" |
服务名称 |
Endpoint |
string |
"" |
OTLP 端点地址 |
EnableTracing |
bool |
true |
启用追踪 |
EnableMetrics |
bool |
true |
启用指标 |
📖 API 说明
ITracer 接口
| 方法 | 说明 |
|---|---|
StartSpan(name) |
开始一个新的追踪 Span |
CurrentSpan |
获取当前 Span |
自动追踪 HTTP 请求、数据库调用等
🔧 高级用法
自定义 Span
using var span = _tracer.StartSpan("CustomOperation");
span.SetAttribute("key", "value");
span.AddEvent("Something happened");
添加 Baggage
Baggage.SetBaggage("user.id", userId);
⚠️ 注意事项
- 端点配置 - 确保 OTLP 端点可访问
- 采样率 - 生产环境建议配置采样率
- 性能影响 - 追踪会有轻微性能开销
📄 许可证
MIT License - 详见 LICENSE
| 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 was computed. 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 | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.1 is compatible. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | 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.1
- OpenTelemetry.Exporter.OpenTelemetryProtocol (>= 1.11.2)
- OpenTelemetry.Extensions.Hosting (>= 1.11.2)
- OpenTelemetry.Instrumentation.AspNetCore (>= 1.11.1)
- OpenTelemetry.Instrumentation.Http (>= 1.11.0)
- SyZero (>= 1.1.5-dev.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 1.1.5-dev.1 | 28 | 1/29/2026 |
| 1.1.4 | 82 | 1/2/2026 |
| 1.1.4-dev.2 | 41 | 1/2/2026 |
| 1.1.4-dev.1 | 41 | 12/30/2025 |
| 1.1.3 | 87 | 12/30/2025 |
| 1.1.3-dev.6 | 45 | 12/30/2025 |