Skip to content

Commit

Permalink
Remove code handling ELASTIC_ environment variables (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
@stevejgordon
stevejgordon authored Feb 21, 2024
1 parent b43cbf1 commit 4356e95
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 223 deletions.
27 changes: 5 additions & 22 deletions src/Elastic.OpenTelemetry/AgentBuilder.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
using Elastic.OpenTelemetry.DependencyInjection;
using Elastic.OpenTelemetry.Diagnostics;
using Elastic.OpenTelemetry.Extensions;
using Elastic.OpenTelemetry.Resources;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
Expand All @@ -23,15 +22,6 @@ namespace Elastic.OpenTelemetry;
/// </summary>
public class AgentBuilder
{
private static readonly Action<ResourceBuilder> DefaultResourceBuilderConfiguration = builder =>
builder
.Clear()
.AddDetector(new DefaultServiceDetector())
.AddTelemetrySdk()
.AddDetector(new ElasticEnvironmentVariableDetector())
.AddEnvironmentVariableDetector()
.AddDistroAttributes();

private readonly MeterProviderBuilder _meterProvider =
Sdk.CreateMeterProviderBuilder()
.AddProcessInstrumentation()
Expand All @@ -40,7 +30,7 @@ public class AgentBuilder

private readonly string[] _activitySourceNames = [];
private Action<TracerProviderBuilder> _tracerProviderBuilderAction = tpb => { };
private Action<ResourceBuilder>? _resourceBuilderAction;
private Action<ResourceBuilder>? _resourceBuilderAction = rb => { };
private Action<OtlpExporterOptions>? _otlpExporterConfiguration;
private string? _otlpExporterName;
private readonly IDisposable? _diagnosticSourceSubscription;
Expand Down Expand Up @@ -237,20 +227,13 @@ public IServiceCollection Register(IServiceCollection serviceCollection)

tracerProviderBuilder.AddElasticProcessors();

if (_resourceBuilderAction is not null)
{
var action = _resourceBuilderAction;
action += b => b.AddDistroAttributes();
tracerProviderBuilder.ConfigureResource(action);
}
else
{
tracerProviderBuilder.ConfigureResource(DefaultResourceBuilderConfiguration);
}
var action = _resourceBuilderAction;
action += b => b.AddDistroAttributes();
tracerProviderBuilder.ConfigureResource(action);

_tracerProviderBuilderAction?.Invoke(tracerProviderBuilder);

tracerProviderBuilder.AddElasticOtlpExporter(_otlpExporterConfiguration, _otlpExporterName);
tracerProviderBuilder.AddOtlpExporter(_otlpExporterName, _otlpExporterConfiguration);
};

/// <summary>
Expand Down
5 changes: 2 additions & 3 deletions src/Elastic.OpenTelemetry/Diagnostics/ElasticDiagnosticLoggingObserver.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information
using System.Diagnostics;
using Elastic.OpenTelemetry.Extensions;

namespace Elastic.OpenTelemetry.Diagnostics;

Expand Down Expand Up @@ -103,13 +102,13 @@ void TransactionIdAdded(KeyValuePair<string, object?> data)

void ProcessorAdded(KeyValuePair<string, object?> data)
{
if (data.Value is DiagnosticEvent<AddProcessorEvent> diagnostic)
if (data.Value is DiagnosticEvent<AddProcessorPayload> diagnostic)
_logFileWriter.LogProcessorAdded(diagnostic);
}

void SourceAdded(KeyValuePair<string, object?> data)
{
if (data.Value is DiagnosticEvent<AddSourceEvent> diagnostic)
if (data.Value is DiagnosticEvent<AddSourcePayload> diagnostic)
_logFileWriter.LogSourceAdded(diagnostic);
}
}
Expand Down
5 changes: 2 additions & 3 deletions src/Elastic.OpenTelemetry/Diagnostics/ElasticOpenTelemetryDiagnostics.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
// See the LICENSE file in the project root for more information
using System.Diagnostics;
using Elastic.OpenTelemetry.DependencyInjection;
using Elastic.OpenTelemetry.Extensions;
using Microsoft.Extensions.Logging.Abstractions;

namespace Elastic.OpenTelemetry.Diagnostics;
Expand Down Expand Up @@ -84,13 +83,13 @@ public static void LogAddedTransactionIdTag(this LogFileWriter logFileWriter, Di
logFileWriter.WriteTraceLogLine(diagnostic, LoggerMessages.TransactionIdProcessorTagAddedLog);
}

public static void LogProcessorAdded(this LogFileWriter logFileWriter, DiagnosticEvent<AddProcessorEvent> diagnostic)
public static void LogProcessorAdded(this LogFileWriter logFileWriter, DiagnosticEvent<AddProcessorPayload> diagnostic)
{
var message = $"Added '{diagnostic.Data.ProcessorType}' processor to '{diagnostic.Data.BuilderType.Name}'.";
logFileWriter.WriteInfoLogLine(diagnostic, message);
}

public static void LogSourceAdded(this LogFileWriter logFileWriter, DiagnosticEvent<AddSourceEvent> diagnostic)
public static void LogSourceAdded(this LogFileWriter logFileWriter, DiagnosticEvent<AddSourcePayload> diagnostic)
{
var message = $"Added '{diagnostic.Data.ActivitySourceName}' ActivitySource to '{diagnostic.Data.BuilderType.Name}'.";
logFileWriter.WriteInfoLogLine(diagnostic, message);
Expand Down
6 changes: 6 additions & 0 deletions src/Elastic.OpenTelemetry/Diagnostics/Payloads/AddProcessorPayload.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Licensed to Elasticsearch B.V under one or more agreements.
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information
namespace Elastic.OpenTelemetry.Diagnostics;

internal readonly record struct AddProcessorPayload(Type ProcessorType, Type BuilderType);
6 changes: 6 additions & 0 deletions src/Elastic.OpenTelemetry/Diagnostics/Payloads/AddSourcePayload.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Licensed to Elasticsearch B.V under one or more agreements.
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information
namespace Elastic.OpenTelemetry.Diagnostics;

internal readonly record struct AddSourcePayload(string ActivitySourceName, Type BuilderType);
147 changes: 2 additions & 145 deletions src/Elastic.OpenTelemetry/Extensions/TraceBuilderProviderExtensions.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information
using Elastic.OpenTelemetry.Processors;
using OpenTelemetry.Exporter;
using OpenTelemetry.Trace;
using OpenTelemetry;
using System.Diagnostics;
Expand All @@ -12,10 +11,6 @@

namespace Elastic.OpenTelemetry.Extensions;

internal readonly record struct AddProcessorEvent(Type ProcessorType, Type BuilderType);

internal readonly record struct AddSourceEvent(string ActivitySourceName, Type BuilderType);

/// <summary> Provides Elastic APM extensions to <see cref="TracerProviderBuilder"/> </summary>
public static class TraceBuilderProviderExtensions
{
Expand All @@ -26,151 +21,13 @@ public static TracerProviderBuilder AddElasticProcessors(this TracerProviderBuil

internal static TracerProviderBuilder LogAndAddProcessor(this TracerProviderBuilder builder, BaseProcessor<Activity> processor)
{
Log(ProcessorAddedEvent, () => new DiagnosticEvent<AddProcessorEvent>(new(processor.GetType(), builder.GetType())));
Log(ProcessorAddedEvent, () => new DiagnosticEvent<AddProcessorPayload>(new(processor.GetType(), builder.GetType())));
return builder.AddProcessor(processor);
}

internal static TracerProviderBuilder LogAndAddSource(this TracerProviderBuilder builder, string sourceName)
{
Log(SourceAddedEvent, () => new DiagnosticEvent<AddSourceEvent>(new(sourceName, builder.GetType())));
Log(SourceAddedEvent, () => new DiagnosticEvent<AddSourcePayload>(new(sourceName, builder.GetType())));
return builder.AddSource(sourceName);
}

/// <summary>
/// Adds the OTLP exporter to the tracer, configured to send data to an Elastic APM backend.
/// </summary>
public static TracerProviderBuilder AddElasticOtlpExporter(this TracerProviderBuilder builder) =>
AddElasticOtlpExporter(builder, null, null);

/// <summary>
/// Adds the OTLP exporter to the tracer, configured to send data to an Elastic APM backend.
/// </summary>
/// <remarks>
///
/// </remarks>
/// <param name="builder"></param>
/// <param name="configure"></param>
/// <param name="name"></param>
/// <returns></returns>
public static TracerProviderBuilder AddElasticOtlpExporter(this TracerProviderBuilder builder, Action<OtlpExporterOptions>? configure, string? name)
{
// TODO - We need a clean way to test this behaviour
// TODO - Logging

const string tracesPath = "/v1/traces";

// If the consumer provides an action to configure the exporter, we use that directly.
// TODO - This does mean that if we end up relying on the HttpClientFactory action (see below), we cannot apply the
// User-Agent header here unless we also update this action. That's okay unless the consumer provides their own action.
if (configure is not null)
return name is not null ? builder.AddOtlpExporter(name, configure): builder.AddOtlpExporter(configure);

// Access OpenTelemetry environment variables used to configure the OTLP exporter.
// When these are present, we won't attempt to fallback to elastic environment variables.
var otlpExporterTracesEndpoint = Environment.GetEnvironmentVariable("OTEL_EXPORTER_OTLP_TRACES_ENDPOINT");
var otlpExporterEndpoint = Environment.GetEnvironmentVariable("OTEL_EXPORTER_OTLP_ENDPOINT");
var otlpExporterHeaders = Environment.GetEnvironmentVariable("OTEL_EXPORTER_OTLP_HEADERS");

Uri? endpoint = null;

if (string.IsNullOrEmpty(otlpExporterTracesEndpoint) && string.IsNullOrEmpty(otlpExporterEndpoint))
{
var elasticApmServerUrl = Environment.GetEnvironmentVariable("ELASTIC_APM_SERVER_URL");

if (!string.IsNullOrEmpty(elasticApmServerUrl))
{
endpoint = new Uri($"{elasticApmServerUrl}{tracesPath}");
}
}
else if (string.IsNullOrEmpty(otlpExporterTracesEndpoint))
{
endpoint = new Uri($"{otlpExporterEndpoint}{tracesPath}");
}

var headersIsNullOrEmpty = string.IsNullOrEmpty(otlpExporterHeaders);

if (headersIsNullOrEmpty || !otlpExporterHeaders!.Contains("Authorization="))
{
var elasticApmSecretToken = Environment.GetEnvironmentVariable("ELASTIC_APM_SECRET_TOKEN");

if (!string.IsNullOrEmpty(elasticApmSecretToken))
{
if (headersIsNullOrEmpty)
otlpExporterHeaders = $"Authorization=Bearer {elasticApmSecretToken}";
else
otlpExporterHeaders += otlpExporterHeaders + $",Authorization=Bearer {elasticApmSecretToken}";
}
}

// TODO - We can't implement this right now as the Otel SDK will also try to add this header and this causes an
// exception if we set this first. https://github.com/open-telemetry/opentelemetry-dotnet/issues/5146 has been opened to discuss
// that behaviour in the SDK. Until then, a partial workaround has been added below.

//if (!string.IsNullOrEmpty(otlpExporterHeaders))
// otlpExporterHeaders += ",User-Agent=TEST-AGENT";
//else
// otlpExporterHeaders = "User-Agent=TEST-AGENT";

if (endpoint is not null || otlpExporterHeaders is not null)
{
// TODO - This is only to demonstrate the workaround (for now).
// If we end up relying on this, we need to set this outside of this if block so it applies even
// when we have no endpoint or headers to add.
#pragma warning disable IDE0053 // Use expression body for lambda expression
configure = o =>
{
// NOTE: this only applies if we also force the protocol to HTTP protobuf (see below) which we avoid for now.
o.HttpClientFactory = () => new HttpClient(new UserAgentMessageHandler(new SocketsHttpHandler()))
{
Timeout = TimeSpan.FromMilliseconds(o.TimeoutMilliseconds)
};

// We prefer gRPC for performance
// TODO - Investigate if multiple gRPC metadata entries for `User-Agent` apply when sent over the wire.
//o.Protocol = OtlpExportProtocol.HttpProtobuf;
};
#pragma warning restore IDE0053 // Use expression body for lambda expression

if (endpoint is not null)
configure += options => options.Endpoint = endpoint;

if (otlpExporterHeaders is not null)
configure += options => options.Headers = otlpExporterHeaders;

#if DEBUG
configure += options => options.ExportProcessorType = ExportProcessorType.Simple;
#endif

return builder.AddOtlpExporter(configure);
}

return builder.AddOtlpExporter();
}
}

internal sealed class UserAgentMessageHandler(HttpMessageHandler handler) : DelegatingHandler(handler)
{
protected override HttpResponseMessage Send(HttpRequestMessage request, CancellationToken cancellationToken)
{
UpdateUserAgent(request);
return base.Send(request, cancellationToken);
}

protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
UpdateUserAgent(request);
return base.SendAsync(request, cancellationToken);
}

private static void UpdateUserAgent(HttpRequestMessage request)
{
var headers = request.Headers.UserAgent;
var firstProduct = headers.FirstOrDefault();

headers.Clear();
headers.Add(new System.Net.Http.Headers.ProductInfoHeaderValue("Elastic-Otel-Distro-Dotnet", Agent.InformationalVersion));

if (firstProduct is not null)
headers.Add(firstProduct);
}
}
50 changes: 0 additions & 50 deletions src/Elastic.OpenTelemetry/Resources/ElasticEnvironmentVariableDetector.cs
View file

This file was deleted.

0 comments on commit 4356e95

Please sign in to comment.