Nuget Packages describe the telemetry which is emitted

[thompson-tomo]

NuGet Product(s) Involved

NuGet SDK

The Elevator Pitch

It would be great if when we are looking at a package we could see if the package natively produces telemetry (spans/metrics etc) that way we can make a more informed decision on which library to use. This information should be visible in the gallery.

Additional Context and Details

Within opentelemetry there is the concept of schema url to describe the version of telemetry, this field should be able to be replicated into the package definition.

I would suggest we have a telemetry object in the package definition with the following optional properties:

• SchemaUrl -> this would indicate if opentelemetry definitions are being followed including which version
• definition -> a link to a seperate file describing the signal which is important for indicating what opt-in attributes are supported and very important for when conventions are not being followed.
• Hooks -> link to another package which adds telemetry to the package. This could be by the same author or it could be someone else ie opentelemetry contrib.

[nkolev92]

How would you use this information as part of the package definition?
You can always ask the package authors to include this in the readme.

I think the readme is a great candidate for information that is package spec but not necessarily something that defines a package itself (ie, how you run it may change etc).

[thompson-tomo]

By having it in the package definition it can be used in search and it enables easy comparison of versions of telemetry used which is important for compatibility.

I see the telemetry definition as a non dll dependency of the package.