Skip to content

Commit 085df7a

Browse files
CodeBlanchCodeBlanch
authored
[sdk-logs] Tests and bug fixes for logging builder & provider (#4467)
1 parent 4376564 commit 085df7a

6 files changed

Lines changed: 349 additions & 9 deletions

File tree

‎src/OpenTelemetry.Api.ProviderBuilderExtensions/Logs/OpenTelemetryDependencyInjectionLoggerProviderBuilderExtensions.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ public static LoggerProviderBuilder AddInstrumentation<T>(
106106

107107
loggerProviderBuilder.ConfigureBuilder((sp, builder) =>
108108
{
109-
if (loggerProviderBuilder is ILoggerProviderBuilder iLoggerProviderBuilder
109+
if (builder is ILoggerProviderBuilder iLoggerProviderBuilder
110110
&& iLoggerProviderBuilder.Provider != null)
111111
{
112112
builder.AddInstrumentation(() => instrumentationFactory(sp, iLoggerProviderBuilder.Provider));

‎src/OpenTelemetry/ProviderExtensions.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ public static Resource GetDefaultResource(this BaseProvider baseProvider)
7373
{
7474
return meterProviderSdk.ServiceProvider;
7575
}
76+
else if (baseProvider is LoggerProviderSdk loggerProviderSdk)
77+
{
78+
return loggerProviderSdk.ServiceProvider;
79+
}
7680
else if (baseProvider is OpenTelemetryLoggerProvider openTelemetryLoggerProvider)
7781
{
7882
return openTelemetryLoggerProvider.ServiceProvider;

‎test/OpenTelemetry.Tests/Logs/LoggerProviderBuilderExtensionsTests.cs‎

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
// <copyright file="LoggerProviderBuilderExtensionsTests.cs" company="OpenTelemetry Authors">
2+
// Copyright The OpenTelemetry Authors
3+
//
4+
// Licensed under the Apache License, Version 2.0 (the "License");
5+
// you may not use this file except in compliance with the License.
6+
// You may obtain a copy of the License at
7+
//
8+
// http://www.apache.org/licenses/LICENSE-2.0
9+
//
10+
// Unless required by applicable law or agreed to in writing, software
11+
// distributed under the License is distributed on an "AS IS" BASIS,
12+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
// See the License for the specific language governing permissions and
14+
// limitations under the License.
15+
// </copyright>
16+
17+
#nullable enable
18+
19+
using Microsoft.Extensions.DependencyInjection;
20+
using OpenTelemetry.Resources;
21+
using Xunit;
22+
23+
namespace OpenTelemetry.Logs.Tests;
24+
25+
public sealed class LoggerProviderBuilderExtensionsTests
26+
{
27+
[Fact]
28+
public void LoggerProviderBuilderAddInstrumentationTest()
29+
{
30+
List<object>? instrumentation = null;
31+
32+
using (var provider = Sdk.CreateLoggerProviderBuilder()
33+
.AddInstrumentation<CustomInstrumentation>()
34+
.AddInstrumentation((sp, provider) => new CustomInstrumentation() { Provider = provider })
35+
.AddInstrumentation(new CustomInstrumentation())
36+
.Build() as LoggerProviderSdk)
37+
{
38+
Assert.NotNull(provider);
39+
40+
Assert.Equal(3, provider.Instrumentations.Count);
41+
42+
Assert.Null(((CustomInstrumentation)provider.Instrumentations[0]).Provider);
43+
Assert.False(((CustomInstrumentation)provider.Instrumentations[0]).Disposed);
44+
45+
Assert.NotNull(((CustomInstrumentation)provider.Instrumentations[1]).Provider);
46+
Assert.False(((CustomInstrumentation)provider.Instrumentations[1]).Disposed);
47+
48+
Assert.Null(((CustomInstrumentation)provider.Instrumentations[2]).Provider);
49+
Assert.False(((CustomInstrumentation)provider.Instrumentations[2]).Disposed);
50+
51+
instrumentation = new List<object>(provider.Instrumentations);
52+
}
53+
54+
Assert.True(((CustomInstrumentation)instrumentation[0]).Disposed);
55+
Assert.True(((CustomInstrumentation)instrumentation[1]).Disposed);
56+
Assert.True(((CustomInstrumentation)instrumentation[2]).Disposed);
57+
}
58+
59+
[Theory]
60+
[InlineData(true)]
61+
[InlineData(false)]
62+
public void LoggerProviderBuilderNestedResolutionUsingBuilderTest(bool callNestedConfigure)
63+
{
64+
bool innerConfigureBuilderTestExecuted = false;
65+
bool innerConfigureOpenTelemetryLoggerProviderTestExecuted = false;
66+
67+
using var provider = Sdk.CreateLoggerProviderBuilder()
68+
.ConfigureServices(services =>
69+
{
70+
if (callNestedConfigure)
71+
{
72+
services.ConfigureOpenTelemetryLoggerProvider(
73+
(sp, builder) => innerConfigureOpenTelemetryLoggerProviderTestExecuted = true);
74+
}
75+
})
76+
.ConfigureBuilder((sp, builder) =>
77+
{
78+
innerConfigureBuilderTestExecuted = true;
79+
Assert.Throws<NotSupportedException>(() => sp.GetService<LoggerProvider>());
80+
})
81+
.Build();
82+
83+
Assert.True(innerConfigureBuilderTestExecuted);
84+
Assert.Equal(callNestedConfigure, innerConfigureOpenTelemetryLoggerProviderTestExecuted);
85+
86+
Assert.Throws<NotSupportedException>(() => provider.GetServiceProvider()?.GetService<LoggerProvider>());
87+
}
88+
89+
[Fact]
90+
public void LoggerProviderBuilderSetResourceBuilderTests()
91+
{
92+
using var provider = Sdk.CreateLoggerProviderBuilder()
93+
.SetResourceBuilder(ResourceBuilder
94+
.CreateEmpty()
95+
.AddAttributes(new[] { new KeyValuePair<string, object>("key1", "value1") }))
96+
.Build() as LoggerProviderSdk;
97+
98+
Assert.NotNull(provider);
99+
100+
Assert.NotNull(provider.Resource);
101+
Assert.Contains(provider.Resource.Attributes, value => value.Key == "key1" && (string)value.Value == "value1");
102+
}
103+
104+
[Fact]
105+
public void LoggerProviderBuilderConfigureResourceBuilderTests()
106+
{
107+
using var provider = Sdk.CreateLoggerProviderBuilder()
108+
.ConfigureResource(resource => resource
109+
.Clear()
110+
.AddAttributes(new[] { new KeyValuePair<string, object>("key1", "value1") }))
111+
.Build() as LoggerProviderSdk;
112+
113+
Assert.NotNull(provider);
114+
115+
Assert.NotNull(provider.Resource);
116+
Assert.Contains(provider.Resource.Attributes, value => value.Key == "key1" && (string)value.Value == "value1");
117+
}
118+
119+
[Fact]
120+
public void LoggerProviderBuilderAddProcessorTest()
121+
{
122+
List<CustomProcessor> processors = new();
123+
124+
using (var provider = Sdk.CreateLoggerProviderBuilder()
125+
.AddProcessor<CustomProcessor>()
126+
.AddProcessor(sp => new CustomProcessor())
127+
.AddProcessor(new CustomProcessor())
128+
.Build() as LoggerProviderSdk)
129+
{
130+
Assert.NotNull(provider);
131+
Assert.NotNull(provider.Processor);
132+
133+
var compositeProcessor = provider.Processor as CompositeProcessor<LogRecord>;
134+
135+
Assert.NotNull(compositeProcessor);
136+
137+
var current = compositeProcessor.Head;
138+
while (current != null)
139+
{
140+
var processor = current.Value as CustomProcessor;
141+
Assert.NotNull(processor);
142+
143+
processors.Add(processor);
144+
Assert.False(processor.Disposed);
145+
146+
current = current.Next;
147+
}
148+
}
149+
150+
Assert.Equal(3, processors.Count);
151+
152+
foreach (var processor in processors)
153+
{
154+
Assert.True(processor.Disposed);
155+
}
156+
}
157+
158+
private sealed class CustomInstrumentation : IDisposable
159+
{
160+
public bool Disposed;
161+
public LoggerProvider? Provider;
162+
163+
public void Dispose()
164+
{
165+
this.Disposed = true;
166+
}
167+
}
168+
169+
private sealed class CustomProcessor : BaseProcessor<LogRecord>
170+
{
171+
public bool Disposed;
172+
173+
protected override void Dispose(bool disposing)
174+
{
175+
this.Disposed = true;
176+
177+
base.Dispose(disposing);
178+
}
179+
}
180+
181+
private sealed class CustomExporter : BaseExporter<LogRecord>
182+
{
183+
public override ExportResult Export(in Batch<LogRecord> batch)
184+
{
185+
return ExportResult.Success;
186+
}
187+
}
188+
}

‎test/OpenTelemetry.Tests/Logs/LoggerProviderSdkTests.cs‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
// <copyright file="LoggerProviderSdkTests.cs" company="OpenTelemetry Authors">
2+
// Copyright The OpenTelemetry Authors
3+
//
4+
// Licensed under the Apache License, Version 2.0 (the "License");
5+
// you may not use this file except in compliance with the License.
6+
// You may obtain a copy of the License at
7+
//
8+
// http://www.apache.org/licenses/LICENSE-2.0
9+
//
10+
// Unless required by applicable law or agreed to in writing, software
11+
// distributed under the License is distributed on an "AS IS" BASIS,
12+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
// See the License for the specific language governing permissions and
14+
// limitations under the License.
15+
// </copyright>
16+
17+
#nullable enable
18+
19+
using OpenTelemetry.Exporter;
20+
using Xunit;
21+
22+
namespace OpenTelemetry.Logs.Tests;
23+
24+
public sealed class LoggerProviderSdkTests
25+
{
26+
[Fact]
27+
public void ForceFlushTest()
28+
{
29+
using var provider = Sdk.CreateLoggerProviderBuilder().Build() as LoggerProviderSdk;
30+
31+
Assert.NotNull(provider);
32+
33+
Assert.True(provider.ForceFlush());
34+
35+
List<LogRecord> exportedItems = new();
36+
37+
provider.AddProcessor(new BatchLogRecordExportProcessor(new InMemoryExporter<LogRecord>(exportedItems)));
38+
39+
var logger = provider.GetLogger("TestLogger");
40+
41+
logger.EmitLog(new() { Body = "Hello world" });
42+
43+
Assert.Empty(exportedItems);
44+
45+
Assert.True(provider.ForceFlush());
46+
47+
Assert.Single(exportedItems);
48+
}
49+
50+
[Fact]
51+
public void ThreadStaticPoolUsedByProviderTests()
52+
{
53+
using var provider1 = Sdk.CreateLoggerProviderBuilder().Build() as LoggerProviderSdk;
54+
55+
Assert.NotNull(provider1);
56+
57+
Assert.Equal(LogRecordThreadStaticPool.Instance, provider1.LogRecordPool);
58+
59+
using var provider2 = Sdk.CreateLoggerProviderBuilder()
60+
.AddProcessor(new SimpleLogRecordExportProcessor(new NoopExporter()))
61+
.Build() as LoggerProviderSdk;
62+
63+
Assert.NotNull(provider2);
64+
65+
Assert.Equal(LogRecordThreadStaticPool.Instance, provider2.LogRecordPool);
66+
67+
using var provider3 = Sdk.CreateLoggerProviderBuilder()
68+
.AddProcessor(new SimpleLogRecordExportProcessor(new NoopExporter()))
69+
.AddProcessor(new SimpleLogRecordExportProcessor(new NoopExporter()))
70+
.Build() as LoggerProviderSdk;
71+
72+
Assert.NotNull(provider3);
73+
74+
Assert.Equal(LogRecordThreadStaticPool.Instance, provider3.LogRecordPool);
75+
}
76+
77+
[Fact]
78+
public void SharedPoolUsedByProviderTests()
79+
{
80+
using var provider1 = Sdk.CreateLoggerProviderBuilder()
81+
.AddProcessor(new BatchLogRecordExportProcessor(new NoopExporter()))
82+
.Build() as LoggerProviderSdk;
83+
84+
Assert.NotNull(provider1);
85+
86+
Assert.Equal(LogRecordSharedPool.Current, provider1.LogRecordPool);
87+
88+
using var provider2 = Sdk.CreateLoggerProviderBuilder()
89+
.AddProcessor(new SimpleLogRecordExportProcessor(new NoopExporter()))
90+
.AddProcessor(new BatchLogRecordExportProcessor(new NoopExporter()))
91+
.Build() as LoggerProviderSdk;
92+
93+
Assert.NotNull(provider2);
94+
95+
Assert.Equal(LogRecordSharedPool.Current, provider2.LogRecordPool);
96+
97+
using var provider3 = Sdk.CreateLoggerProviderBuilder()
98+
.AddProcessor(new SimpleLogRecordExportProcessor(new NoopExporter()))
99+
.AddProcessor(new CompositeProcessor<LogRecord>(new BaseProcessor<LogRecord>[]
100+
{
101+
new SimpleLogRecordExportProcessor(new NoopExporter()),
102+
new BatchLogRecordExportProcessor(new NoopExporter()),
103+
}))
104+
.Build() as LoggerProviderSdk;
105+
106+
Assert.NotNull(provider3);
107+
108+
Assert.Equal(LogRecordSharedPool.Current, provider3.LogRecordPool);
109+
}
110+
111+
[Fact]
112+
public void AddProcessorTest()
113+
{
114+
using var provider = Sdk.CreateLoggerProviderBuilder()
115+
.Build() as LoggerProviderSdk;
116+
117+
Assert.NotNull(provider);
118+
Assert.Null(provider.Processor);
119+
120+
provider.AddProcessor(new NoopProcessor());
121+
122+
Assert.NotNull(provider.Processor);
123+
Assert.True(provider.Processor is NoopProcessor);
124+
125+
provider.AddProcessor(new NoopProcessor());
126+
127+
Assert.NotNull(provider.Processor);
128+
Assert.True(provider.Processor is CompositeProcessor<LogRecord>);
129+
}
130+
131+
private sealed class NoopProcessor : BaseProcessor<LogRecord>
132+
{
133+
}
134+
135+
private sealed class NoopExporter : BaseExporter<LogRecord>
136+
{
137+
public override ExportResult Export(in Batch<LogRecord> batch)
138+
{
139+
return ExportResult.Success;
140+
}
141+
}
142+
}

‎test/OpenTelemetry.Tests/Metrics/MeterProviderBuilderExtensionsTests.cs‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -219,24 +219,27 @@ public void ConfigureBuilderIConfigurationModifiableTest()
219219
[InlineData(false)]
220220
public void MeterProviderNestedResolutionUsingBuilderTest(bool callNestedConfigure)
221221
{
222-
bool innerTestExecuted = false;
222+
bool innerConfigureBuilderTestExecuted = false;
223+
bool innerConfigureOpenTelemetryLoggerProviderTestExecuted = false;
223224

224225
using var provider = Sdk.CreateMeterProviderBuilder()
225226
.ConfigureServices(services =>
226227
{
227228
if (callNestedConfigure)
228229
{
229-
services.ConfigureOpenTelemetryMeterProvider((sp, builder) => { });
230+
services.ConfigureOpenTelemetryMeterProvider(
231+
(sp, builder) => innerConfigureOpenTelemetryLoggerProviderTestExecuted = true);
230232
}
231233
})
232234
.ConfigureBuilder((sp, builder) =>
233235
{
234-
innerTestExecuted = true;
236+
innerConfigureBuilderTestExecuted = true;
235237
Assert.Throws<NotSupportedException>(() => sp.GetService<MeterProvider>());
236238
})
237239
.Build();
238240

239-
Assert.True(innerTestExecuted);
241+
Assert.True(innerConfigureBuilderTestExecuted);
242+
Assert.Equal(callNestedConfigure, innerConfigureOpenTelemetryLoggerProviderTestExecuted);
240243

241244
Assert.Throws<NotSupportedException>(() => provider.GetServiceProvider()?.GetService<MeterProvider>());
242245
}

0 commit comments

Comments
 (0)