[sdk-logs] Include instrumentation version in debug log

[SimonCropp]

Changes

Given Instrumentation version is being captured in AddInstrumentation

    public override LoggerProviderBuilder AddInstrumentation<TInstrumentation>(Func<TInstrumentation> instrumentationFactory)
    {
        Debug.Assert(instrumentationFactory != null, "instrumentationFactory was null");

        this.Instrumentation.Add(
            new InstrumentationRegistration(
                typeof(TInstrumentation).Name,
                typeof(TInstrumentation).Assembly.GetName().Version?.ToString() ?? DefaultInstrumentationVersion,
                instrumentationFactory!()));

        return this;
    }

I assume the intent is to use it in the logs? So i added it there and added a test to assert it.

If u think Instrumentation version has no value in the logs, do you want another PR that removes the redundant version detection?

Merge requirement checklist

• CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
• Unit tests added/updated
• Appropriate CHANGELOG.md files updated for non-trivial changes
• Changes in public API reviewed (if applicable)

[Kielek]

I am not against logging of the Version here. It is important to mention that it will be taking the version in this way typeof(TInstrumentation).Assembly.GetName().Version?.ToString() ?? "1.0.0.0". It means that it will be reporting only major version of the library in most cases (if the library follows this recomendation).

This version will be different than typical data reported by the contrib instrumentation packages https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/89f0af731441a364779693a1874c57f33b1e721c/src/Shared/AssemblyVersionExtensions.cs

[SimonCropp]

want me to change it to not record if no version is found?

[Kielek]

I am telling that it usually will record 1.0.0.0/2.0.0.0/3.0.0.0,etc. There will be no differences between e.g. 1.1.0 nuget package and 1.2.0.

[SimonCropp]

then shouldnt it default to use the AssemblyInformationalVersionAttribute it is exists?

[Kielek]

For sure, it is one of the options, you can consider, and it should working for all contrib packages.

[github-actions]

This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or pushing will instruct the bot to automatically remove the label. This bot runs once per day.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.40%. Comparing base (48e5a08) to head (038c90c).
Report is 20 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6074      +/-   ##
==========================================
- Coverage   86.40%   86.40%   -0.01%     
==========================================
  Files         257      257              
  Lines       11656    11655       -1     
==========================================
- Hits        10071    10070       -1     
  Misses       1585     1585              

Files with missing lines	Coverage Δ
src/OpenTelemetry/Logs/LoggerProviderSdk.cs	92.78% <ø> (-0.08%)	⬇️

[github-actions]

Closed as inactive. Feel free to reopen if this PR is still being worked on.