Skip to content

[SDK + Jaeger] Support loading environment variables from IConfiguration in Traces & Metrics #3720

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

Merged
CodeBlanch merged 8 commits into from
Oct 12, 2022
Merged

[SDK + Jaeger] Support loading environment variables from IConfiguration in Traces & Metrics #3720

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
81cc629
Support retrieval of environment variables through IConfiguration in …
CodeBlanch Oct 3, 2022
d4ccabf
Update Jaeger to load environment variables through IConfiguration.
CodeBlanch Oct 3, 2022
1405478
Warning fix.
CodeBlanch Oct 3, 2022
b20705e
CHANGELOG patch.
CodeBlanch Oct 3, 2022
df5b8d3
Bug fixes.
CodeBlanch Oct 3, 2022
142dbd2
Warning cleanup.
CodeBlanch Oct 3, 2022
305cfe5
Code review.
CodeBlanch Oct 12, 2022
cff5bc7
Merge from main.
CodeBlanch Oct 12, 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
Bug fixes.
  • Loading branch information
@CodeBlanch
CodeBlanch committed Oct 3, 2022
commit df5b8d363948ffca72f5936d3f4650c5a92ba9f6
2 changes: 1 addition & 1 deletion build/Common.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<MicrosoftExtensionsHostingAbstractionsPkgVer>[2.1.0,)</MicrosoftExtensionsHostingAbstractionsPkgVer>
<MicrosoftExtensionsLoggingPkgVer>[3.1.0,)</MicrosoftExtensionsLoggingPkgVer>
<MicrosoftExtensionsLoggingConfigurationPkgVer>[3.1.0,)</MicrosoftExtensionsLoggingConfigurationPkgVer>
<MicrosoftExtensionsOptionsPkgVer>[3.1.0,)</MicrosoftExtensionsOptionsPkgVer>
<MicrosoftExtensionsOptionsPkgVer>[5.0.0,)</MicrosoftExtensionsOptionsPkgVer>
Comment on lines 35 to +38
Copy link
Member

@alanwest alanwest Oct 11, 2022

Choose a reason for hiding this comment

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

Makes me wonder what the harm would be in bumping all the extension packages to [5.0.0,)?

Just poking around the dependencies of the Microsoft.Extensions.* packages themselves seems to suggest they're always bumped in unison.

Copy link
Member Author

@CodeBlanch CodeBlanch Oct 11, 2022

Choose a reason for hiding this comment

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

I don't have an issue with that. I'm not going to do it on this PR but we could bring it up on SIG?

<MicrosoftNETFrameworkReferenceAssembliesPkgVer>[1.0.0,2.0)</MicrosoftNETFrameworkReferenceAssembliesPkgVer>
<MicrosoftSourceLinkGitHubPkgVer>[1.0.0,2.0)</MicrosoftSourceLinkGitHubPkgVer>
<OpenTracingPkgVer>[0.12.1,0.13)</OpenTracingPkgVer>
Expand Down
3 changes: 2 additions & 1 deletion src/OpenTelemetry.Exporter.Jaeger/JaegerExporterHelperExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
using System.Net.Http;
using System.Reflection;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using Microsoft.Extensions.Options;
using OpenTelemetry.Exporter;
using OpenTelemetry.Internal;
Expand Down Expand Up @@ -69,7 +70,7 @@ public static TracerProviderBuilder AddJaegerExporter(
services.Configure(name, configure);
}

services.AddSingleton<IOptionsFactory<JaegerExporterOptions>, JaegerExporterOptions.JaegerExporterOptionsFactory>();
services.TryAddSingleton<IOptionsFactory<JaegerExporterOptions>, JaegerExporterOptions.JaegerExporterOptionsFactory>();
});

return builder.ConfigureBuilder((sp, builder) =>
Expand Down
12 changes: 9 additions & 3 deletions src/OpenTelemetry.Exporter.Jaeger/JaegerExporterOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
// </copyright>

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Microsoft.Extensions.Configuration;
Expand Down Expand Up @@ -158,18 +159,23 @@ internal JaegerExporterOptions(IConfiguration configuration)
/// </remarks>
public Func<HttpClient> HttpClientFactory { get; set; } = DefaultHttpClientFactory;

internal sealed class JaegerExporterOptionsFactory : IOptionsFactory<JaegerExporterOptions>
internal sealed class JaegerExporterOptionsFactory : OptionsFactory<JaegerExporterOptions>
{
private readonly IConfiguration configuration;

public JaegerExporterOptionsFactory(IConfiguration configuration)
public JaegerExporterOptionsFactory(
IConfiguration configuration,
IEnumerable<IConfigureOptions<JaegerExporterOptions>> setups,
IEnumerable<IPostConfigureOptions<JaegerExporterOptions>> postConfigures,
IEnumerable<IValidateOptions<JaegerExporterOptions>> validations)
: base(setups, postConfigures, validations)
{
Debug.Assert(configuration != null, "configuration was null");

this.configuration = configuration;
}

public JaegerExporterOptions Create(string name)
protected override JaegerExporterOptions CreateInstance(string name)
=> new(this.configuration);
}
}
Expand Down
3 changes: 2 additions & 1 deletion src/OpenTelemetry/OpenTelemetry.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@

<ItemGroup>
<PackageReference Include="System.Reflection.Emit.Lightweight" Version="$(SystemReflectionEmitLightweightPkgVer)" Condition="'$(TargetFramework)' != 'net6.0'" />
<PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="$(MicrosoftExtensionsConfigurationEnvironmentVariablesPkgVer)" />
Copy link
Member Author

@CodeBlanch CodeBlanch Oct 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

This is needed to initialize IConfiguration from environment variables when no IConfiguration is found. No one wants the dependency but OTel spec calls for a lot of environment variable behavior so I don't think it is unreasonable for SDK to have this. Anyone using the AspNetCore "meta" reference already has this.

Copy link
Member

@alanwest alanwest Oct 11, 2022

Choose a reason for hiding this comment

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

I'm anticipating a future desire for an OpenTelemetry .NET Lite package... let's hope not 😆

Copy link
Member Author

@CodeBlanch CodeBlanch Oct 11, 2022

Choose a reason for hiding this comment

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

Less filling, tastes great.

Copy link
Member

@pellared pellared Oct 12, 2022

Choose a reason for hiding this comment

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

I just want to call out that bringing more and more dependencies increases the chances of an assembly version conflict which is especially annoying for .NET Auto-Instrumentation 😭

Reference: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docs/troubleshooting.md#assembly-version-conflicts

Copy link
Member Author

@CodeBlanch CodeBlanch Oct 12, 2022

Choose a reason for hiding this comment

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

@alanwest and I kicked around some ideas/options, but we haven't been able to come up with anything really great for avoiding this. When Auto-Instrumentation copies in references, does it do so blindly? Or do you somehow try to reason out what is there prior to doing the copy?

<PackageReference Include="Microsoft.Extensions.Logging" Version="$(MicrosoftExtensionsLoggingPkgVer)" />
<PackageReference Include="Microsoft.Extensions.Logging.Configuration" Version="$(MicrosoftExtensionsLoggingConfigurationPkgVer)" />
<PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="$(MicrosoftExtensionsConfigurationEnvironmentVariablesPkgVer)" />
<PackageReference Include="Microsoft.Extensions.Options" Version="$(MicrosoftExtensionsOptionsPkgVer)" />
Copy link
Member Author

@CodeBlanch CodeBlanch Oct 3, 2022

Choose a reason for hiding this comment

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

We already had Microsoft.Extensions.Options through Microsoft.Extensions.Logging.Configuration but now we ask for >= 5.0.0. The reason for that is to gain access to OptionsFactory.CreateInstance which allows us to initialize the instance created for options using IConfiguration + the custom environment variables defined in OTel spec.

</ItemGroup>

<ItemGroup>
Expand Down