Skip to content

Distinguish OpenTelemetry dependent functionality #4052

Closed

Description

We should be clear what functionality works only with OpenTelemetry and either document it clearly or physically separate it in unique namespaces and assemblies. Today I see references in these assemblies:

<PackageReference Include="OpenTelemetry.Instrumentation.Http" />

<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" />

I assume documentation will be less disruptive than refactoring, and I wouldn't object to it, but I do think it comes with some consequences:

  1. Some dependency sensitive developers may avoid all functionality in these assemblies, even if the specific type or scenario they are interested never runs any OTel code.
  2. Because of (1) there is now a tradeoff that needs to be considered when adding any new non-OTel specific functionality to the assembly. Implicitly in my head, these assemblies are currently 'OTel extension assemblies' and not 'general purpose telemetry assemblies'.
  3. There is always a little extra risk of misuse/confusion if naming doesn't make the dependency obvious.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions