Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Ensure we enable preferred options for logging
  • Loading branch information
stevejgordon committed Mar 21, 2025
commit f3800cbb4964bab3855c81a56b5aa3a335637a88
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,12 @@ static void ConfigureBuilder(LoggerProviderBuilder builder, BuilderState builder

builder.ConfigureResource(r => r.WithElasticDefaults(builderState, services));

// When services is not null here, the options will have already been configured by the calling code.
if (services is null)
builder.ConfigureServices(sc => sc.Configure<OtlpExporterOptions>(OtlpExporterDefaults.OtlpExporterOptions));

builder.ConfigureServices(sc => sc.Configure<OpenTelemetryLoggerOptions>(o => o.WithElasticDefaults(logger)));

if (components.Options.SkipOtlpExporter)
{
logger.LogSkippingOtlpExporter(nameof(Signals.Logs), loggingProviderName, builderState.InstanceIdentifier);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ private static void ConfigureBuilder(TracerProviderBuilder builder, BuilderState
#endif

AddWithLogging(builder, logger, "GrpcClient", b => b.AddGrpcClientInstrumentation(), builderState.InstanceIdentifier);

TracerProvderBuilderExtensions.AddActivitySourceWithLogging(builder, logger, "Elastic.Transport", builderState.InstanceIdentifier);

// NOTE: Despite them having no dependencies. We cannot add the OpenTelemetry.Instrumentation.ElasticsearchClient or
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
// 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

using OpenTelemetry;
using OpenTelemetry.Logs;
using Xunit.Abstractions;

namespace Elastic.OpenTelemetry.Tests.Logging;

public class ElasticLoggingDefaults(ITestOutputHelper output)
{
private readonly ITestOutputHelper _output = output;

[Fact]
public async Task FormattedMessageAndScopesOptions_AreEnabled()
{
var exportedItems = new List<LogRecord>();

var host = Host.CreateDefaultBuilder();
host.ConfigureServices(s =>
{
var options = new ElasticOpenTelemetryOptions()
{
SkipOtlpExporter = true,
AdditionalLogger = new TestLogger(_output)
};

s.AddElasticOpenTelemetry(options)
.WithLogging(lpb => lpb.AddInMemoryExporter(exportedItems));
});

var ctx = new CancellationTokenRegistration();

using (var app = host.Build())
{
_ = app.RunAsync(ctx.Token);

var factory = app.Services.GetRequiredService<ILoggerFactory>();
var logger = factory.CreateLogger("Test");

using (logger.BeginScope(new List<KeyValuePair<string, object>>
{
new("customData", "aCustomValue"),
}))
{
logger.LogWarning("This is a {WhatAmI}", "warning");
}

await ctx.DisposeAsync();
}

var logRecord = exportedItems.Last();

Assert.Equal("This is a warning", logRecord.FormattedMessage);

logRecord.ForEachScope<object?>((scope, _) =>
{
var values = scope.Scope as IEnumerable<KeyValuePair<string, object>>;

Assert.NotNull(values);
var entry = Assert.Single(values);

Assert.Equal("customData", entry.Key);
Assert.Equal("aCustomValue", entry.Value);
}, null);
}
}