Detect `service.version` from Assembly Version?

Aaronontheweb commented 5 months ago

Package

OpenTelemetry

Is your feature request related to a problem?

I implemented this already in some of my own projects, was mostly interested in knowing if the project would accept it as a contribution if I cleaned it up and made a PR.

I usually use the AssemblyVersion as my service.version value in OTEL since the former is always synced with our Docker image tags in our build process. Therefore, I wrote an IResourceDetector that will just grab this data and use it throughout all of our OTEL-enabled projects:

public sealed class AssemblyVersionDetector : IResourceDetector
{
    public Resource Detect()
    {
        // care about the foreground assembly used in `dotnet run` / equivalent
        var version = Assembly.GetExecutingAssembly().GetName().Version?.ToString();

        IEnumerable<KeyValuePair<string, object>> attributes = Array.Empty<KeyValuePair<string, object>>();

        if (version != null)
        {
            attributes = new[]
            {
                new KeyValuePair<string, object>("service.version", version)
            };
        }

        return new Resource(attributes);
    }
}

Totally fine renaming it / cleaning it up to use resource dictionaries et al. But would it make sense to have this available as a built-in IResourceDetector in the core library? Even though it technically uses System.Reflection I think it should still be pass AOT-compatibility checks since it's not doing any dynamic-linking.

What is the expected behavior?

Populates the service.version with the appropriate value derived from the executing assembly's information.

You can see an example of what this looks like using Seq's OTEL log aggregation w/ data from one of our applications (0.2.4.0 is the correct value).

Which alternative solutions or features have you considered?

Just using my own middleware to do this

Additional context

No response

CodeBlanch commented 4 months ago

@Aaronontheweb

Here are my thoughts...

You could definitely add this as-is over in https://github.com/open-telemetry/opentelemetry-dotnet-contrib. If you want to just do that and stop reading, fine by me.
I think this is useful enough it could be part of the main SDK. I don't speak for all approvers/maintainers, but I would be supportive of something like...
```
public static ResourceBuilder AddServiceVersionDetector(
   this ResourceBuilder resourceBuilder,
   Assembly targetAssembly,
   ServiceResourceVersionDetectionType detectionType)
{
   // ...
}

public enum ServiceResourceVersionDetectionType
{
  AssemblyVersion,
  AssemblyFileVersion,
  AssemblyInformationVersion
}
```
I added the ability to look at AssemblyFileVersionAttribute & AssemblyInformationalVersionAttribute as well via the enum. For a project like OTel, AssemblyVersion is always 1.0.0.0 and AssemblyFileVersion \ AssemblyInformationalVersion are the more useful things. This actually follows the guidance, but I know a lot of users don't. Basically I think we should be able to look different spots and perhaps add more in the future?

Kielek commented 4 months ago

@CodeBlanch, I would vote for your extended proposal, but in the contrib repository. I do not think that it is defined in spec/semantic convention to put it as a part of SDK.

If we speaking about detection, from particular assemblies, we are doing something similar for scope version. Keep in mind that part of the versioning system extends versions by suffixes (eg. GH commits). Ref: https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/9114d0b183def59bc0cd747bdee024aae7d35fbc/src/Shared/AssemblyVersionExtensions.cs

open-telemetry / opentelemetry-dotnet