Attaching logs from ILogger to Activities not working

[JobaDiniz]

I'm trying to attach logs (from ILogger) to activities in a console app. It's working, except the Message of the log is not showing, but CategoryName and LogLevel are.

I've configured the LoggerFactory by adding OpenTelemetry + AttachLogsToActivityEvent (here).

var verbosity = context.ParseResult.GetValueForOption(RpaCommand.VerbosityOption);
                var loggerFactory = LoggerFactory.Create(builder =>
                {
                    var assembly = Assembly.GetEntryAssembly()!.GetName();
                    builder.AddOpenTelemetry(o => o
                        .ConfigureResource(r => r.AddService("rpa cli", serviceVersion: assembly.Version!.ToString()))
                        .AttachLogsToActivityEvent()); //TODO: for some unknown reason, the 'Message' of the LogRecord is empty and not showing in the Jaeger UI.
                });

Adding Jaeger exporter.

var assembly = Assembly.GetEntryAssembly()!.GetName();
                    using var _ = Sdk.CreateTracerProviderBuilder()
                    .ConfigureResource(r => r.AddService("rpa cli", serviceVersion: assembly.Version!.ToString()))
                    .AddHttpClientInstrumentation()
                    .AddSource(assembly.Name!)
                    .AddJaegerExporter()
                    .Build();

This is what I get

Why the log Message is not there?

[cijothomas]

Can you try https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/logs/customizing-the-sdk#includeformattedmessage

[JobaDiniz]

Hum, that config just passed by me, but it did not work.
I've added .SetIncludeFormattedMessage(true)

var loggerFactory = LoggerFactory.Create(builder =>
                {
                    builder.AddOpenTelemetry(o => o
                        .SetIncludeFormattedMessage(true) //TODO: for some unknown reason, the 'Message' of the LogRecord is empty and not showing in the Jaeger UI. (https://github.com/open-telemetry/opentelemetry-dotnet/discussions/3696)
                        .ConfigureResource(r => r.AddService(RpaCommand.ServiceName, serviceVersion: RpaCommand.AssemblyVersion))
                        .AttachLogsToActivityEvent());

[cijothomas]

Can you share minimal repro app for this? Please use ConsoleExporter instead of Jaeger, to rule out issues with Jaeger.

[zhoudi94]

I have the same problem and I can be pretty sure that the upgrade from OpenTelemetry.Extensions.Hosting rc9.5 to 9.6 appears buggy because I have done very much trying.
I need ‘Message’ very much, what should I do? @cijothomas

  .ConfigureLogging((host, logging) =>
               {
                   logging.ClearProviders();
                   logging.AddSerilog();
                   logging.AddOpenTelemetry(options =>
                   {
                       options.IncludeFormattedMessage = true;
                       options.ParseStateValues = true;
                       options.AttachLogsToActivityEvent();
                   });
               })

[zhoudi94]

The console is displayable, but jaegeris not, why is this?
I only upgraded the package OpenTelemetry.Extensions.Hosting

[zhoudi94]

Program

                new HostBuilder()
                .ConfigureLogging((host, logging) =>
                {
                    logging.ClearProviders();
                    logging.AddSerilog();
                    logging.AddOpenTelemetry(options =>
                    {
                        options.IncludeFormattedMessage = true;
                        options.ParseStateValues = true;
                        options.AttachLogsToActivityEvent();
                    });
                })
                .Build()
                .Run();

Startup

services.AddOpenTelemetryTracing(builder =>
            {
                var jwtHandler = new JwtSecurityTokenHandler();

                builder.SetResourceBuilder(ResourceBuilder.CreateDefault().AddService($"{configuration.GetAppId()}_{env.GetEnvironmentName()}"));

                builder.AddAspNetCoreInstrumentation(options =>
                {
                    options.Filter = (httpContext) =>
                     {
                        ...
                     };
                    options.Enrich = (activity, eventName, rawObject) =>
                     {
                         ...
                     };
                });

                builder.AddGrpcClientInstrumentation(options =>
                {
                    options.SuppressDownstreamInstrumentation = false;

                    options.Enrich = (activity, eventName, rawObject) =>
                    {
                       ...
                    };
                });

                builder.AddHttpClientInstrumentation(options =>
                {
                    options.Filter = (httpRequestMessage) =>
                    {
                     ...
                    };

                    options.Enrich = (activity, eventName, rawObject) =>
                    {
                      ...
                    };

                });

                builder.AddSqlClientInstrumentation(options => options.SetDbStatementForText = true);

                builder.AddMySqlDataInstrumentation(options => options.SetDbStatement = true);

                builder.AddHangfireInstrumentation();

                builder.AddMongoDBInstrumentation();

                builder.AddRedisInstrumentation(services.BuildServiceProvider().GetRequiredService<IConnectionMultiplexer>(), options =>
                {
                    options.SetVerboseDatabaseStatements = true;
                });

                builder.AddCapInstrumentation();

                builder.AddJaegerExporter(options => { options.AgentHost = configuration.GetSection("Jaeger:AgentHost").Value; options.AgentPort = configuration.GetValue<int>("Jaeger:AgentPort"); });

            });

This code has been working steadily for a year for me, but after the upgrade it doesn't work

[cijothomas]

@zhoudi94 I cannot repro the issue. Logs are showing up as expected in Jaeger.
Here is my minimal repro (its not a repro as it does work as expected)
csproj

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>net7.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="7.0.4" />
    <PackageReference Include="OpenTelemetry.Exporter.Jaeger" Version="1.4.0" />
    <PackageReference Include="OpenTelemetry.Extensions" Version="1.0.0-beta.4" />
    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.4.0" />
    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.0.0-rc9.14" />
    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.4.0" />
  </ItemGroup>

</Project>

program.cs

using OpenTelemetry.Trace;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
builder.Services.AddOpenTelemetry().WithTracing(builder => builder.AddAspNetCoreInstrumentation().AddJaegerExporter());
builder.Logging.AddOpenTelemetry(options =>
            {
                options.ParseStateValues = true;
                options.IncludeFormattedMessage = true;
                options.AttachLogsToActivityEvent();
            });

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

And I am seeing formatted message in Jaeger:

[zhoudi94]

I found the cause and I am now able to reproduce the problem consistently.
I was using the package OpenTelemetry.Contrib.Preview and you were using OpenTelemetry.Extensions.
Is this a bug caused by the upgrade? Do I need to use the package OpenTelemetry.Extensions

[Kielek]

@zhoudi94, OpenTelemetry.Contrib.Preview is obsolete and it is referencing OTel 1.1.0-beta.3.

The recommendation is to update all packages to latest releases. For most cases all containing Contrib in the name should be removed from the list of you dependencies.

I hope we will be able to mark correctly obsolete packages shortly: open-telemetry/opentelemetry-dotnet-contrib#1100

For now, you can check project names under
https://github.com/open-telemetry/opentelemetry-dotnet-contrib
and
https://github.com/open-telemetry/opentelemetry-dotnet to determine if packages are still supported.