[hosting] Support .NET 8 IMetricsBuilder API #4958
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| // <copyright file="OpenTelemetryMetricListener.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using System.Diagnostics; | ||
| using System.Diagnostics.Metrics; | ||
| using Microsoft.Extensions.Diagnostics.Metrics; | ||
|
|
||
| namespace OpenTelemetry.Metrics; | ||
|
|
||
| internal sealed class OpenTelemetryMetricListener : IMetricsListener, IDisposable | ||
CodeBlanch marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| { | ||
| private readonly MeterProviderSdk meterProviderSdk; | ||
| private IObservableInstrumentsSource? observableInstrumentsSource; | ||
|
|
||
| public OpenTelemetryMetricListener(MeterProvider meterProvider) | ||
| { | ||
| var meterProviderSdk = meterProvider as MeterProviderSdk; | ||
|
|
||
| Debug.Assert(meterProviderSdk != null, "meterProvider was not MeterProviderSdk"); | ||
|
|
||
| this.meterProviderSdk = meterProviderSdk!; | ||
|
|
||
| this.meterProviderSdk.OnCollectObservableInstruments += this.OnCollectObservableInstruments; | ||
| } | ||
|
|
||
| public string Name => "OpenTelemetry"; | ||
|
Member
There was a problem hiding this comment. What are the consequences of an app registering another listener by this same name? Is there any reason we should obscure a name a bit to reduce the chance of collision?
Member
Author
There was a problem hiding this comment. This name is important. It tells the engine how to bind settings for our listener. Similar to how in logging you can have different log levels for each For example you can do things like this: "Metrics": {
"EnabledMetrics": {
"Default": false
},
"SomeMetricsSDK": {
"EnabledMetrics": {
"System.Net": true
}
},
"OpenTelemetry": {
"EnabledMetrics": {
"Default": true
}
}
}The name we use here is what users will need to put in their configuration.
Member
There was a problem hiding this comment. Ok got it. The name is fine by me. Though what is the consequence of registering one by the same name? Does the last one win? Is there any chance that the
Member
Author
There was a problem hiding this comment. The actual registration we do is done via To say that another way, the subscription manager operates on the IEnumerable<IMetricsListener>s registered in the container. It doesn't make like a dictionary using the name(s). The name is only used to look up the config/rules that apply to the listener. |
||
|
|
||
| public void Dispose() | ||
| { | ||
| this.meterProviderSdk.OnCollectObservableInstruments -= this.OnCollectObservableInstruments; | ||
| } | ||
|
|
||
| public MeasurementHandlers GetMeasurementHandlers() | ||
| { | ||
| return new MeasurementHandlers() | ||
| { | ||
| ByteHandler = (instrument, value, tags, state) | ||
| => this.MeasurementRecordedLong(instrument, value, tags, state), | ||
| ShortHandler = (instrument, value, tags, state) | ||
| => this.MeasurementRecordedLong(instrument, value, tags, state), | ||
| IntHandler = (instrument, value, tags, state) | ||
| => this.MeasurementRecordedLong(instrument, value, tags, state), | ||
| LongHandler = this.MeasurementRecordedLong, | ||
| FloatHandler = (instrument, value, tags, state) | ||
| => this.MeasurementRecordedDouble(instrument, value, tags, state), | ||
| DoubleHandler = this.MeasurementRecordedDouble, | ||
| }; | ||
| } | ||
|
|
||
| public bool InstrumentPublished(Instrument instrument, out object? userState) | ||
| { | ||
| userState = this.meterProviderSdk.InstrumentPublished(instrument, listeningIsManagedExternally: true); | ||
| return userState != null; | ||
| } | ||
|
|
||
| public void MeasurementsCompleted(Instrument instrument, object? userState) | ||
| { | ||
| var meterProvider = this.meterProviderSdk; | ||
|
|
||
| if (meterProvider.ViewCount > 0) | ||
| { | ||
| meterProvider.MeasurementsCompleted(instrument, userState); | ||
| } | ||
| else | ||
| { | ||
| meterProvider.MeasurementsCompletedSingleStream(instrument, userState); | ||
| } | ||
| } | ||
|
|
||
| public void Initialize(IObservableInstrumentsSource source) | ||
| { | ||
| this.observableInstrumentsSource = source; | ||
| } | ||
|
|
||
| private void OnCollectObservableInstruments() | ||
| { | ||
| this.observableInstrumentsSource?.RecordObservableInstruments(); | ||
| } | ||
|
|
||
| private void MeasurementRecordedDouble(Instrument instrument, double value, ReadOnlySpan<KeyValuePair<string, object?>> tagsRos, object? userState) | ||
| { | ||
| var meterProvider = this.meterProviderSdk; | ||
|
|
||
| if (meterProvider.ViewCount > 0) | ||
| { | ||
| meterProvider.MeasurementRecordedDouble(instrument, value, tagsRos, userState); | ||
| } | ||
| else | ||
| { | ||
| meterProvider.MeasurementRecordedDoubleSingleStream(instrument, value, tagsRos, userState); | ||
| } | ||
| } | ||
|
|
||
| private void MeasurementRecordedLong(Instrument instrument, long value, ReadOnlySpan<KeyValuePair<string, object?>> tagsRos, object? userState) | ||
| { | ||
| var meterProvider = this.meterProviderSdk; | ||
|
|
||
| if (meterProvider.ViewCount > 0) | ||
| { | ||
| meterProvider.MeasurementRecordedLong(instrument, value, tagsRos, userState); | ||
| } | ||
| else | ||
| { | ||
| meterProvider.MeasurementRecordedLongSingleStream(instrument, value, tagsRos, userState); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| // <copyright file="OpenTelemetryMetricsBuilderExtensions.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using Microsoft.Extensions.DependencyInjection; | ||
| using Microsoft.Extensions.DependencyInjection.Extensions; | ||
| using OpenTelemetry.Internal; | ||
| using OpenTelemetry.Metrics; | ||
|
|
||
| namespace Microsoft.Extensions.Diagnostics.Metrics; | ||
|
|
||
| /// <summary> | ||
| /// Contains extension methods for registering OpenTelemetry metrics with an | ||
| /// <see cref="IMetricsBuilder"/> instance. | ||
| /// </summary> | ||
| internal static class OpenTelemetryMetricsBuilderExtensions | ||
| { | ||
| /// <summary> | ||
| /// Adds an OpenTelemetry <see cref="IMetricsListener"/> named 'OpenTelemetry' to the <see cref="IMetricsBuilder"/>. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Note: This is safe to be called multiple times and by library authors. | ||
utpilla marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| /// Only a single <see cref="MeterProvider"/> will be created for a given | ||
| /// <see cref="IServiceCollection"/>. | ||
| /// </remarks> | ||
| /// <param name="metricsBuilder"><see cref="IMetricsBuilder"/>.</param> | ||
| /// <returns>The supplied <see cref="IMetricsBuilder"/> for chaining | ||
| /// calls.</returns> | ||
| public static IMetricsBuilder UseOpenTelemetry( | ||
| this IMetricsBuilder metricsBuilder) | ||
| => UseOpenTelemetry(metricsBuilder, b => { }); | ||
|
|
||
| /// <summary> | ||
| /// Adds an OpenTelemetry <see cref="IMetricsListener"/> named 'OpenTelemetry' to the <see cref="IMetricsBuilder"/>. | ||
| /// </summary> | ||
| /// <remarks><inheritdoc cref="UseOpenTelemetry(IMetricsBuilder)" path="/remarks"/></remarks> | ||
| /// <param name="metricsBuilder"><see cref="IMetricsBuilder"/>.</param> | ||
| /// <param name="configure"><see cref="MeterProviderBuilder"/> | ||
| /// configuration callback.</param> | ||
| /// <returns>The supplied <see cref="IMetricsBuilder"/> for chaining | ||
| /// calls.</returns> | ||
| public static IMetricsBuilder UseOpenTelemetry( | ||
| this IMetricsBuilder metricsBuilder, | ||
| Action<MeterProviderBuilder> configure) | ||
| { | ||
| Guard.ThrowIfNull(metricsBuilder); | ||
| Guard.ThrowIfNull(configure); | ||
|
|
||
| var builder = new MeterProviderBuilderBase(metricsBuilder.Services); | ||
|
|
||
| metricsBuilder.Services.TryAddEnumerable( | ||
| ServiceDescriptor.Singleton<IMetricsListener, OpenTelemetryMetricListener>()); | ||
|
|
||
| configure(builder); | ||
|
|
||
| return metricsBuilder; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.