[FEATURE REQ] Document ActivitySource names or naming conventions #31921
Labels
Client
This issue points to a problem in the data-plane of the library.
Docs
OpenTelemetry
OpenTelemetry instrumentation (not Monitor-specific)
Library name
All
Please describe the feature.
Users sometimes what to enable specific ActivitySources and exclude others. We only document
Azure.*
and don't give any guidance on source names beyond that.E.g. storage one isAzure.Storage
, appconfig one isAzure.Data.AppConfiguration
and eventhubs isAzure.Messaging.EventHubs
.In some cases, they are defined explicitly (EventHubs), but in most cases, the name corresponds to the namespace in which derivedClientOptions
are defined.The convention:
<packageName>.<className>
.E.g. ServiceBus should have the following sources
Azure.Messaging.ServiceBus.ServiceBusReceiver
Azure.Messaging.ServiceBus.Message
Azure.Messaging.ServiceBus.ServiceBusSender
Azure.Messaging.ServiceBus.ServiceBusProcessor
It's recommended to enable Azure SDK tracing in one of the following ways:
AddSource("Azure.*)
- all activitiesAddSource("<packageName>.*)
Azure.Messaging.ServiceBus
Azure.Core.Http
and need to be enabled additionally)AddSource("<packageName>.<clientName>")
- activities from individual clients (e.g. whenAzure.Messaging.ServiceBus.ServiceBusProcessor
is used, receiver activities won't be reported)The text was updated successfully, but these errors were encountered: