| | | 1 | | using System.Reflection; |
| | | 2 | | using OpenTelemetry; |
| | | 3 | | using OpenTelemetry.Exporter; |
| | | 4 | | using OpenTelemetry.Metrics; |
| | | 5 | | using OpenTelemetry.Resources; |
| | | 6 | | using OpenTelemetry.Trace; |
| | | 7 | | using ProjectTemplate.Web.Options; |
| | | 8 | | |
| | | 9 | | namespace ProjectTemplate.Web.Extensions; |
| | | 10 | | |
| | | 11 | | /// <summary> |
| | | 12 | | /// Provides extension methods to register OpenTelemetry services for the application. |
| | | 13 | | /// </summary> |
| | | 14 | | public static class OpenTelemetryServiceExtensions |
| | | 15 | | { |
| | | 16 | | /// <summary> |
| | | 17 | | /// Adds baseline OpenTelemetry tracing and metrics support. |
| | | 18 | | /// </summary> |
| | | 19 | | /// <param name="services">The service collection to add OpenTelemetry services to.</param> |
| | | 20 | | /// <param name="configuration">The application configuration source.</param> |
| | | 21 | | /// <param name="environment">The current hosting environment.</param> |
| | | 22 | | /// <returns>The same service collection instance so calls can be chained.</returns> |
| | | 23 | | public static IServiceCollection AddApplicationOpenTelemetry( |
| | | 24 | | this IServiceCollection services, |
| | | 25 | | IConfiguration configuration, |
| | | 26 | | IHostEnvironment environment) |
| | | 27 | | { |
| | 116 | 28 | | services |
| | 116 | 29 | | .AddOptions<ApplicationOpenTelemetryOptions>() |
| | 116 | 30 | | .Bind(configuration.GetSection(ApplicationOpenTelemetryOptions.SectionName)) |
| | 116 | 31 | | .Validate(options => !string.IsNullOrWhiteSpace(options.ServiceName), |
| | 116 | 32 | | "ProjectTemplate:OpenTelemetry:ServiceName must not be empty.") |
| | 116 | 33 | | .Validate(options => !options.Otlp.Enabled || Uri.TryCreate(options.Otlp.Endpoint, UriKind.Absolute, out _), |
| | 116 | 34 | | "ProjectTemplate:OpenTelemetry:Otlp:Endpoint must be a valid absolute URI when OTLP export is enabled.") |
| | 116 | 35 | | .ValidateOnStart(); |
| | | 36 | | |
| | 116 | 37 | | ApplicationOpenTelemetryOptions options = configuration |
| | 116 | 38 | | .GetSection(ApplicationOpenTelemetryOptions.SectionName) |
| | 116 | 39 | | .Get<ApplicationOpenTelemetryOptions>() ?? new ApplicationOpenTelemetryOptions(); |
| | | 40 | | |
| | 116 | 41 | | if (!options.Enabled) |
| | | 42 | | { |
| | 3 | 43 | | return services; |
| | | 44 | | } |
| | | 45 | | |
| | 113 | 46 | | string serviceVersion = ResolveServiceVersion(options); |
| | | 47 | | |
| | 113 | 48 | | OpenTelemetryBuilder openTelemetryBuilder = services |
| | 113 | 49 | | .AddOpenTelemetry() |
| | 113 | 50 | | .ConfigureResource(resource => resource |
| | 113 | 51 | | .AddService( |
| | 113 | 52 | | serviceName: options.ServiceName, |
| | 113 | 53 | | serviceVersion: serviceVersion) |
| | 113 | 54 | | .AddAttributes(new Dictionary<string, object> |
| | 113 | 55 | | { |
| | 113 | 56 | | ["deployment.environment.name"] = environment.EnvironmentName |
| | 113 | 57 | | })); |
| | | 58 | | |
| | 113 | 59 | | if (options.EnableTracing) |
| | | 60 | | { |
| | 112 | 61 | | openTelemetryBuilder.WithTracing(tracing => |
| | 112 | 62 | | { |
| | 112 | 63 | | if (options.EnableAspNetCoreInstrumentation) |
| | 112 | 64 | | { |
| | 112 | 65 | | tracing.AddAspNetCoreInstrumentation(); |
| | 112 | 66 | | } |
| | 112 | 67 | | |
| | 112 | 68 | | if (options.EnableHttpClientInstrumentation) |
| | 112 | 69 | | { |
| | 112 | 70 | | tracing.AddHttpClientInstrumentation(); |
| | 112 | 71 | | } |
| | 112 | 72 | | |
| | 112 | 73 | | if (options.Otlp.Enabled) |
| | 112 | 74 | | { |
| | 112 | 75 | | tracing.AddOtlpExporter(exporterOptions => ConfigureOtlpExporter(exporterOptions, options.Otlp)); |
| | 112 | 76 | | } |
| | 112 | 77 | | }); |
| | | 78 | | } |
| | | 79 | | |
| | 113 | 80 | | if (options.EnableMetrics) |
| | | 81 | | { |
| | 112 | 82 | | openTelemetryBuilder.WithMetrics(metrics => |
| | 112 | 83 | | { |
| | 112 | 84 | | if (options.EnableAspNetCoreInstrumentation) |
| | 112 | 85 | | { |
| | 112 | 86 | | metrics.AddAspNetCoreInstrumentation(); |
| | 112 | 87 | | } |
| | 112 | 88 | | |
| | 112 | 89 | | if (options.EnableHttpClientInstrumentation) |
| | 112 | 90 | | { |
| | 112 | 91 | | metrics.AddHttpClientInstrumentation(); |
| | 112 | 92 | | } |
| | 112 | 93 | | |
| | 112 | 94 | | if (options.Otlp.Enabled) |
| | 112 | 95 | | { |
| | 112 | 96 | | metrics.AddOtlpExporter(exporterOptions => ConfigureOtlpExporter(exporterOptions, options.Otlp)); |
| | 112 | 97 | | } |
| | 112 | 98 | | }); |
| | | 99 | | } |
| | | 100 | | |
| | 113 | 101 | | return services; |
| | | 102 | | } |
| | | 103 | | |
| | | 104 | | private static void ConfigureOtlpExporter( |
| | | 105 | | OtlpExporterOptions exporterOptions, |
| | | 106 | | ApplicationOtlpExporterOptions options) |
| | | 107 | | { |
| | 4 | 108 | | exporterOptions.Endpoint = new Uri(options.Endpoint); |
| | 4 | 109 | | exporterOptions.Protocol = string.Equals( |
| | 4 | 110 | | options.Protocol, |
| | 4 | 111 | | "HttpProtobuf", |
| | 4 | 112 | | StringComparison.OrdinalIgnoreCase) |
| | 4 | 113 | | ? OtlpExportProtocol.HttpProtobuf |
| | 4 | 114 | | : OtlpExportProtocol.Grpc; |
| | 4 | 115 | | } |
| | | 116 | | |
| | | 117 | | private static string ResolveServiceVersion(ApplicationOpenTelemetryOptions options) |
| | | 118 | | { |
| | 117 | 119 | | if (!string.IsNullOrWhiteSpace(options.ServiceVersion)) |
| | | 120 | | { |
| | 114 | 121 | | return options.ServiceVersion.Trim(); |
| | | 122 | | } |
| | | 123 | | |
| | 3 | 124 | | Assembly assembly = typeof(Program).Assembly; |
| | | 125 | | |
| | 3 | 126 | | string? informationalVersion = assembly |
| | 3 | 127 | | .GetCustomAttribute<AssemblyInformationalVersionAttribute>() |
| | 3 | 128 | | ?.InformationalVersion; |
| | | 129 | | |
| | 3 | 130 | | return !string.IsNullOrWhiteSpace(informationalVersion) ? informationalVersion : assembly.GetName().Version?.ToS |
| | | 131 | | } |
| | | 132 | | } |