Add links to versioned conventions

open-telemetry · Dec 20, 2021 · 3ed4a27 · 3ed4a27
1 parent 9c78fe9
commit 3ed4a27
Showing 1 changed file with 14 additions and 12 deletions.
diff --git a/semantic_conventions/trace/instrumentation/azure-sdk.yml b/semantic_conventions/trace/instrumentation/azure-sdk.yml
@@ -26,9 +26,19 @@ groups:
     span_kind: client
     brief: 'Describes HTTP client spans created per HTTP request (try).'
     note: >
-      This conventions follows [OpenTelemetry HTTP](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md)
+      This conventions follows [OpenTelemetry HTTP conventions v1.6.](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.6.x/specification/trace/semantic_conventions/http.md)
       but omits all optional attributes, providing only `http.url` to describe destination. It adds request-id attributes supported by Azure services.
     attributes:
+      - id: request_id
+        type: string
+        required: always
+        brief: 'Value of the [x-ms-client-request-id] header (or other request-id header, depending on the service) sent by the client.'
+        examples: ['eb178587-c05a-418c-a695-ae9466c5303c']
+      - id: service_request_id
+        type: string
+        required: always
+        brief: 'Value of the [x-ms-request-id]  header (or other request-id header, depending on the service) sent by the server in response.'
+        examples: ['3f828ae5-ecb9-40ab-88d9-db0420af30c6']    
       - id: http.method
         type: string
         required: always
@@ -52,21 +62,12 @@ groups:
         required: always
         brief: 'Value of the [HTTP User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3) or X-MS-UserAgent header sent by the client.'
         examples: ['CERN-LineMode/2.15 libwww/2.17b3']
-      - id: request_id
-        type: string
-        required: always
-        brief: 'Value of the [x-ms-client-request-id] header (or other request-id header, depending on the service) sent by the client.'
-        examples: ['eb178587-c05a-418c-a695-ae9466c5303c']
-      - id: service_request_id
-        type: string
-        required: always
-        brief: 'Value of the [x-ms-request-id]  header (or other request-id header, depending on the service) sent by the server in response.'
-        examples: ['3f828ae5-ecb9-40ab-88d9-db0420af30c6']
 
   # messaging
   - id: azure-sdk.messaging
     brief: 'Describes Azure messaging SDKs spans.'
     extends: azure-sdk
+    note: Implements OpenTracing MessageBus conventions https://opentracing.io/specification/conventions/
     attributes:
       - id: message_bus.destination
         type: string
@@ -97,12 +98,13 @@ groups:
       Contains links to all messages contexts being consumed. Each link has attribute `enqueuedTime` (with `long` type)
       attribute with unix epoch time with milliseconds precision representing when message was enqueued.
 
-  # cosmosDB
+  # CosmosDB
   - id: azure-sdk.cosmos
     span_kind: client
     brief: 'Describes Azure CosmosDB spans.'
     note: >
       Events with additional debug info are added for long running operations.
+      Implements https://github.com/open-telemetry/opentelemetry-specification/blob/v0.5.0/specification/trace/semantic_conventions/database.md
     extends: azure-sdk
     attributes:
       - id: db.url