Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE environment variable #4667

Merged
merged 9 commits into from
Jul 19, 2023
Merged

Add support for OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE environment variable #4667

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
fcbe3a4
Update OTLPExporter extension method
utpilla Jul 6, 2023
f379d06
Add InitializationAction support in DelegatingOptionsFactory.
CodeBlanch Jul 6, 2023
1146438
Merge remote-tracking branch 'origin/main' into utpilla/Add-support-f…
utpilla Jul 7, 2023
fcba290
Use a const string
utpilla Jul 12, 2023
6663152
Merge remote-tracking branch 'origin/main' into utpilla/Add-support-f…
utpilla Jul 15, 2023
1a2fa11
Add unit test
utpilla Jul 17, 2023
21a2160
Code changes
utpilla Jul 18, 2023
1b2eedc
Merge remote-tracking branch 'origin/main' into utpilla/Add-support-f…
utpilla Jul 18, 2023
9d3f89a
Update CHANGELOG
utpilla Jul 18, 2023
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
25 changes: 25 additions & 0 deletions src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpMetricExporterExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
// limitations under the License.
// </copyright>

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using OpenTelemetry.Exporter;
Expand All @@ -26,6 +27,8 @@ namespace OpenTelemetry.Metrics
/// </summary>
public static class OtlpMetricExporterExtensions
{
internal const string OtlpMetricExporterTemporalityPreferenceEnvVarKey = "OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE";

/// <summary>
/// Adds <see cref="OtlpMetricExporter"/> to the <see cref="MeterProviderBuilder"/> using default options.
/// </summary>
Expand Down Expand Up @@ -69,6 +72,17 @@ public static MeterProviderBuilder AddOtlpExporter(
}

OtlpExporterOptions.RegisterOtlpExporterOptionsFactory(services);

services.AddOptions<MetricReaderOptions>(finalOptionsName).Configure<IConfiguration>(
(readerOptions, config) =>
{
var otlpTemporalityPreference = config[OtlpMetricExporterTemporalityPreferenceEnvVarKey];
if (!string.IsNullOrWhiteSpace(otlpTemporalityPreference)
&& Enum.TryParse<MetricReaderTemporalityPreference>(otlpTemporalityPreference, ignoreCase: true, out var enumValue))
{
readerOptions.TemporalityPreference = enumValue;
}
});
});

return builder.AddReader(sp =>
Expand Down Expand Up @@ -135,6 +149,17 @@ public static MeterProviderBuilder AddOtlpExporter(
builder.ConfigureServices(services =>
{
OtlpExporterOptions.RegisterOtlpExporterOptionsFactory(services);

services.AddOptions<MetricReaderOptions>(name).Configure<IConfiguration>(
(readerOptions, config) =>
{
var otlpTemporalityPreference = config[OtlpMetricExporterTemporalityPreferenceEnvVarKey];
if (!string.IsNullOrWhiteSpace(otlpTemporalityPreference)
&& Enum.TryParse<MetricReaderTemporalityPreference>(otlpTemporalityPreference, ignoreCase: true, out var enumValue))
{
readerOptions.TemporalityPreference = enumValue;
}
});
});

return builder.AddReader(sp =>
Expand Down
46 changes: 46 additions & 0 deletions test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpMetricsExporterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
// </copyright>

using System.Diagnostics.Metrics;
using System.Reflection;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation;
using OpenTelemetry.Metrics;
Expand Down Expand Up @@ -704,6 +706,50 @@ public void TestHistogramToOtlpMetric(string name, string description, string un
Assert.Empty(dataPoint.Exemplars);
}

[Theory]
[InlineData("cumulative", MetricReaderTemporalityPreference.Cumulative)]
[InlineData("Cumulative", MetricReaderTemporalityPreference.Cumulative)]
[InlineData("CUMULATIVE", MetricReaderTemporalityPreference.Cumulative)]
[InlineData("delta", MetricReaderTemporalityPreference.Delta)]
[InlineData("Delta", MetricReaderTemporalityPreference.Delta)]
[InlineData("DELTA", MetricReaderTemporalityPreference.Delta)]
public void TestTemporalityPreferenceConfiguration(string configValue, MetricReaderTemporalityPreference expectedTemporality)
{
var configData = new Dictionary<string, string> { ["OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE"] = configValue };
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Use the constant OtlpMetricExporterExtensions.OtlpMetricExporterTemporalityPreferenceEnvVarKey here (I'm assuming the tests can see internals)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was done on purpose. If someone accidentally changes the environment variable key name in the src file, then our tests should complain about it. If I use the const string defined in the src file then our tests would simply pass even when the value of the key is changed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't necessarily disagree with your logic, but it does break with all other envvar tests that I can recall seeing. Ex:

opentelemetry-dotnet/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpExporterOptionsTests.cs

Lines 62 to 65 in e7f7cd6

Environment.SetEnvironmentVariable(OtlpExporterOptions.EndpointEnvVarName, "http://test:8888");
Environment.SetEnvironmentVariable(OtlpExporterOptions.HeadersEnvVarName, "A=2,B=3");
Environment.SetEnvironmentVariable(OtlpExporterOptions.TimeoutEnvVarName, "2000");
Environment.SetEnvironmentVariable(OtlpExporterOptions.ProtocolEnvVarName, "http/protobuf");

I would probably go with the constant to be consistent and follow DRY principle. If someone does have a valid reason to change it they should only have to do it in one spot.

But I made this a "nit" comment because I figured you might disagree 🤣 Up to you!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should think about what do we want to test? If we want to test, that a user a can configure something by providing a value for a particular string in the config, then our tests shouldn't be using the same const as the src file. Our tests would be too dynamic for their own good. 😄

var configuration = new ConfigurationBuilder()
.AddInMemoryCollection(configData)
.Build();

// Check for both the code paths:
// 1. The final extension method which accepts `Action<OtlpExporterOptions>`.
// 2. The final extension method which accepts `Action<OtlpExporterOptions, MetricReaderOptions>`.

// Test 1st code path
using var meterProvider1 = Sdk.CreateMeterProviderBuilder()
.ConfigureServices(services => services.AddSingleton<IConfiguration>(configuration))
.AddOtlpExporter() // This would in turn call the extension method which accepts `Action<OtlpExporterOptions>`
.Build();

var assembly = typeof(Sdk).Assembly;
var type = assembly.GetType("OpenTelemetry.Metrics.MeterProviderSdk");
var fieldInfo = type.GetField("reader", BindingFlags.Instance | BindingFlags.NonPublic);
var reader = fieldInfo.GetValue(meterProvider1) as MetricReader;
var temporality = reader.TemporalityPreference;

Assert.Equal(expectedTemporality, temporality);

// Test 2nd code path
using var meterProvider2 = Sdk.CreateMeterProviderBuilder()
.ConfigureServices(services => services.AddSingleton<IConfiguration>(configuration))
.AddOtlpExporter((_, _) => { }) // This would in turn call the extension method which accepts `Action<OtlpExporterOptions, MetricReaderOptions>`
.Build();

reader = fieldInfo.GetValue(meterProvider2) as MetricReader;
temporality = reader.TemporalityPreference;

Assert.Equal(expectedTemporality, temporality);
}

private static IEnumerable<KeyValuePair<string, object>> ToAttributes(object[] keysValues)
{
var keys = keysValues?.Where((_, index) => index % 2 == 0).ToArray();
Expand Down