Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
8d9bb6c
Support dependency injection in logging. Add AddOpenTelemetryEventSou…
CodeBlanch Jul 29, 2022
a3616bb
Merge branch 'main' into loggerprovider-dependencyinjection
CodeBlanch Jul 29, 2022
0836b09
CHANGELOG update.
CodeBlanch Jul 29, 2022
013ab59
Bug fixes and a test.
CodeBlanch Jul 29, 2022
9ee35f2
More fixes and more tests.
CodeBlanch Jul 29, 2022
c0fe823
Tweak comments for clarity.
CodeBlanch Jul 29, 2022
5b4ffc1
Added OpenTelemetryLoggerOptions.Services xml detail remarks.
CodeBlanch Jul 29, 2022
a1fe108
More tests.
CodeBlanch Jul 29, 2022
d2ba768
More tests.
CodeBlanch Jul 29, 2022
a8f8238
Test fix.
CodeBlanch Jul 29, 2022
6daf110
More tests.
CodeBlanch Jul 29, 2022
71cdfbf
Tests and fixes.
CodeBlanch Jul 29, 2022
0c73626
Warning cleanup.
CodeBlanch Jul 29, 2022
c5c93e0
Added resource test.
CodeBlanch Jul 29, 2022
3632366
Smooth out multiple resource configurations.
CodeBlanch Jul 29, 2022
e78734c
Resource chaining fix.
CodeBlanch Jul 29, 2022
8aeb08e
Remove throw for additional SetResourceBuilder calls.
CodeBlanch Jul 29, 2022
570ab37
Warning fixes.
CodeBlanch Jul 29, 2022
813bacc
Moved OpenTelemetryEventSourceLogEmitter extension to OpenTelemetryLo…
CodeBlanch Jul 30, 2022
6ffd623
Tweaks.
CodeBlanch Jul 30, 2022
fad5a6c
Switched from static to builder pattern.
CodeBlanch Aug 1, 2022
d477d8d
Tweaks.
CodeBlanch Aug 1, 2022
2c4195d
More tests.
CodeBlanch Aug 1, 2022
ce2a932
Merge remote-tracking branch 'upstream/main' into loggerprovider-depe…
CodeBlanch Aug 4, 2022
6284ff1
Fix CHANGELOG for release.
CodeBlanch Aug 4, 2022
d416e1b
Merge remote-tracking branch 'upstream/main' into loggerprovider-depe…
CodeBlanch Aug 5, 2022
2b26cb0
Tweaks.
CodeBlanch Aug 5, 2022
280ad5d
Test updates.
CodeBlanch Aug 5, 2022
251ff81
Added a detached configuration option.
CodeBlanch Aug 5, 2022
5f2b5b5
Prevent double registration to be consistent with tracer builder patt…
CodeBlanch Aug 5, 2022
28301d8
API review.
CodeBlanch Aug 5, 2022
e389a5d
Merge remote-tracking branch 'upstream/main' into loggerprovider-depe…
CodeBlanch Aug 5, 2022
7cc2865
Warning cleanup.
CodeBlanch Aug 5, 2022
8ecfdaf
Build fixes.
CodeBlanch Aug 5, 2022
7057343
Test fix.
CodeBlanch Aug 5, 2022
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
Prev Previous commit
Next Next commit
Moved OpenTelemetryEventSourceLogEmitter extension to OpenTelemetryLo…
…ggerOptions.
  • Loading branch information
CodeBlanch committed Jul 30, 2022
commit 813bacc43b7f53cd6ba3e4b9413c2fdbdeac2762
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#nullable enable
OpenTelemetry.Logs.OpenTelemetryEventSourceLogEmitter
OpenTelemetry.Logs.OpenTelemetryEventSourceLogEmitter.OpenTelemetryEventSourceLogEmitter(OpenTelemetry.Logs.OpenTelemetryLoggerProvider! openTelemetryLoggerProvider, System.Func<string!, System.Diagnostics.Tracing.EventLevel?>! shouldListenToFunc, bool disposeProvider = true) -> void
OpenTelemetry.Logs.OpenTelemetryEventSourceServiceCollectionExtensions
OpenTelemetry.Logs.OpenTelemetryEventSourceLoggerOptionsExtensions
override OpenTelemetry.Logs.OpenTelemetryEventSourceLogEmitter.Dispose() -> void
static OpenTelemetry.Logs.OpenTelemetryEventSourceServiceCollectionExtensions.AddOpenTelemetryEventSourceLogEmitter(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Func<string!, System.Diagnostics.Tracing.EventLevel?>! shouldListenToFunc) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
static OpenTelemetry.Logs.OpenTelemetryEventSourceLoggerOptionsExtensions.AddEventSourceLogEmitter(this OpenTelemetry.Logs.OpenTelemetryLoggerOptions! options, System.Func<string!, System.Diagnostics.Tracing.EventLevel?>! shouldListenToFunc) -> OpenTelemetry.Logs.OpenTelemetryLoggerOptions!
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#nullable enable
OpenTelemetry.Logs.OpenTelemetryEventSourceLogEmitter
OpenTelemetry.Logs.OpenTelemetryEventSourceLogEmitter.OpenTelemetryEventSourceLogEmitter(OpenTelemetry.Logs.OpenTelemetryLoggerProvider! openTelemetryLoggerProvider, System.Func<string!, System.Diagnostics.Tracing.EventLevel?>! shouldListenToFunc, bool disposeProvider = true) -> void
OpenTelemetry.Logs.OpenTelemetryEventSourceServiceCollectionExtensions
OpenTelemetry.Logs.OpenTelemetryEventSourceLoggerOptionsExtensions
override OpenTelemetry.Logs.OpenTelemetryEventSourceLogEmitter.Dispose() -> void
static OpenTelemetry.Logs.OpenTelemetryEventSourceServiceCollectionExtensions.AddOpenTelemetryEventSourceLogEmitter(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Func<string!, System.Diagnostics.Tracing.EventLevel?>! shouldListenToFunc) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
static OpenTelemetry.Logs.OpenTelemetryEventSourceLoggerOptionsExtensions.AddEventSourceLogEmitter(this OpenTelemetry.Logs.OpenTelemetryLoggerOptions! options, System.Func<string!, System.Diagnostics.Tracing.EventLevel?>! shouldListenToFunc) -> OpenTelemetry.Logs.OpenTelemetryLoggerOptions!
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// <copyright file="OpenTelemetryEventSourceServiceCollectionExtensions.cs" company="OpenTelemetry Authors">
// <copyright file="OpenTelemetryEventSourceLoggerOptionsExtensions.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -24,42 +24,40 @@
namespace OpenTelemetry.Logs
{
/// <summary>
/// Contains extension methods for registering OpenTelemetry EventSource utilities into application services.
/// Contains extension methods for registering OpenTelemetry EventSource utilities into logging services.
/// </summary>
public static class OpenTelemetryEventSourceServiceCollectionExtensions
public static class OpenTelemetryEventSourceLoggerOptionsExtensions
{
/// <summary>
/// Registers into application services an <see cref="EventListener"/>
/// which will convert <see cref="EventSource"/> events into
/// OpenTelemetry logs.
/// Registers an <see cref="EventListener"/> which will convert <see
/// cref="EventSource"/> events into OpenTelemetry logs.
/// </summary>
/// <param name="services"><see cref="IServiceCollection"/>.</param>
/// <param name="options"><see
/// cref="OpenTelemetryLoggerOptions"/>.</param>
/// <param name="shouldListenToFunc">Callback function used to decide if
/// events should be captured for a given <see
/// cref="EventSource.Name"/>. Return <see langword="null"/> if no
/// events should be captured.</param>
/// <returns>Supplied <see cref="IServiceCollection"/> for chaining calls.</returns>
public static IServiceCollection AddOpenTelemetryEventSourceLogEmitter(
this IServiceCollection services,
/// <returns>Supplied <see cref="OpenTelemetryLoggerOptions"/> for
/// chaining calls.</returns>
public static OpenTelemetryLoggerOptions AddEventSourceLogEmitter(
this OpenTelemetryLoggerOptions options,
Func<string, EventLevel?> shouldListenToFunc)
{
Guard.ThrowIfNull(services);
Guard.ThrowIfNull(options);
Guard.ThrowIfNull(shouldListenToFunc);

services.TryAddSingleton<EventSourceManager>();
options.Services.TryAddSingleton<EventSourceManager>();

services.Configure<OpenTelemetryLoggerOptions>(options =>
options.Configure((sp, provider) =>
{
options.Configure((sp, provider) =>
{
var manager = sp.GetRequiredService<EventSourceManager>();
var manager = sp.GetRequiredService<EventSourceManager>();

manager.Emitters.Add(
new OpenTelemetryEventSourceLogEmitter(provider, shouldListenToFunc, disposeProvider: false));
});
manager.Emitters.Add(
new OpenTelemetryEventSourceLogEmitter(provider, shouldListenToFunc, disposeProvider: false));
});

return services;
return options;
}

internal sealed class EventSourceManager : IDisposable
Expand Down
10 changes: 3 additions & 7 deletions src/OpenTelemetry.Extensions.EventSource/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,11 @@ IHost host = Host.CreateDefaultBuilder(args)
{
options
.SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("MyService"))
.AddConsoleExporter();
.AddConsoleExporter()
// Step 2: Register OpenTelemetryEventSourceLogEmitter to listen to events...
.AddEventSourceLogEmitter((name) => name == MyEventSource.Name ? EventLevel.Informational : null);
});
})
.ConfigureServices((hostContext, services) =>
{
// Step 2: Register OpenTelemetryEventSourceLogEmitter to listen to events...
services.AddOpenTelemetryEventSourceLogEmitter(
(name) => name == MyEventSource.Name ? EventLevel.Informational : null);
})
.Build();

host.Run();
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// <copyright file="OpenTelemetryEventSourceServiceCollectionExtensionsTests.cs" company="OpenTelemetry Authors">
// <copyright file="OpenTelemetryEventSourceLoggerOptionsExtensionsTests.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -25,7 +25,7 @@

namespace OpenTelemetry.Extensions.EventSource.Tests
{
public class OpenTelemetryEventSourceServiceCollectionExtensionsTests
public class OpenTelemetryEventSourceLoggerOptionsExtensionsTests
{
[Fact]
public void AddOpenTelemetryEventSourceLogEmitterTest()
Expand All @@ -36,19 +36,21 @@ public void AddOpenTelemetryEventSourceLogEmitterTest()

services.AddLogging(configure =>
{
configure.AddOpenTelemetry(options => options.AddInMemoryExporter(exportedItems));
configure.AddOpenTelemetry(options =>
{
options
.AddInMemoryExporter(exportedItems)
.AddEventSourceLogEmitter((name) => name == TestEventSource.EventSourceName ? EventLevel.LogAlways : null);
});
});

services.AddOpenTelemetryEventSourceLogEmitter(
(name) => name == TestEventSource.EventSourceName ? EventLevel.LogAlways : null);

OpenTelemetryEventSourceServiceCollectionExtensions.EventSourceManager? eventSourceManager = null;
OpenTelemetryEventSourceLoggerOptionsExtensions.EventSourceManager? eventSourceManager = null;

using (var serviceProvider = services.BuildServiceProvider())
{
var loggerFactory = serviceProvider.GetRequiredService<ILoggerFactory>();

eventSourceManager = serviceProvider.GetRequiredService<OpenTelemetryEventSourceServiceCollectionExtensions.EventSourceManager>();
eventSourceManager = serviceProvider.GetRequiredService<OpenTelemetryEventSourceLoggerOptionsExtensions.EventSourceManager>();

Assert.Single(eventSourceManager.Emitters);

Expand Down