Skip to content

Open Telemetry: Fixes attribute name as per OTel Guidance #4995

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 6, 2025
Merged

Open Telemetry: Fixes attribute name as per OTel Guidance #4995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
889dadc
Changed attribute name as per otel guidance
sourabh1007 Feb 4, 2025
f24dd01
fix test
sourabh1007 Feb 4, 2025
b47240f
Merge branch 'master' into users/sourabhjain/otelattr
sourabh1007 Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions Microsoft.Azure.Cosmos/src/Telemetry/OpenTelemetry/CosmosDbClientMetrics.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public static class Name
/// <summary>
/// Total request units per operation (sum of RUs for all requested needed when processing an operation)
/// </summary>
public const string RequestCharge = "db.client.cosmosdb.operation.request_charge";
public const string RequestCharge = "azure.cosmosdb.client.operation.request_charge";

/// <summary>
/// Total end-to-end duration of the operation
Expand All @@ -49,7 +49,7 @@ public static class Name
/// <summary>
/// Number of active SDK client instances.
/// </summary>
public const string ActiveInstances = "db.client.cosmosdb.active_instance.count";
public const string ActiveInstances = "azure.cosmosdb.client.active_instance.count";
}

/// <summary>
Expand Down Expand Up @@ -124,37 +124,37 @@ public static class Name
/// <summary>
/// Network Call Latency
/// </summary>
public const string Latency = "db.client.cosmosdb.request.duration";
public const string Latency = "azure.cosmosdb.client.request.duration";

/// <summary>
/// Request Payload Size
/// </summary>
public const string RequestBodySize = "db.client.cosmosdb.request.body.size";
public const string RequestBodySize = "azure.cosmosdb.client.request.body.size";

/// <summary>
/// Request Payload Size
/// </summary>
public const string ResponseBodySize = "db.client.cosmosdb.response.body.size";
public const string ResponseBodySize = "azure.cosmosdb.client.response.body.size";

/// <summary>
/// Channel Aquisition Latency
/// </summary>
public const string ChannelAquisitionLatency = "db.client.cosmosdb.request.channel_aquisition.duration";
public const string ChannelAquisitionLatency = "azure.cosmosdb.client.request.channel_aquisition.duration";

/// <summary>
/// Backend Server Latency
/// </summary>
public const string BackendLatency = "db.client.cosmosdb.request.service_duration";
public const string BackendLatency = "azure.cosmosdb.client.request.service_duration";

/// <summary>
/// Transit Time Latency
/// </summary>
public const string TransitTimeLatency = "db.client.cosmosdb.request.transit.duration";
public const string TransitTimeLatency = "azure.cosmosdb.client.request.transit.duration";

/// <summary>
/// Received Time Latency
/// </summary>
public const string ReceivedTimeLatency = "db.client.cosmosdb.request.received.duration";
public const string ReceivedTimeLatency = "azure.cosmosdb.client.request.received.duration";
}

/// <summary>
Expand Down
30 changes: 15 additions & 15 deletions Microsoft.Azure.Cosmos/src/Telemetry/OpenTelemetry/OpenTelemetryAttributeKeys.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public OpenTelemetryAttributeKeys(OperationMetricsOptions operationMetricsOption
/// <summary>
/// Represents the name of the database system.
/// </summary>
public const string DbSystemName = "db.system";
public const string DbSystemName = "db.system.name";

/// <summary>
/// Represents the namespace of the database.
Expand All @@ -85,7 +85,7 @@ public OpenTelemetryAttributeKeys(OperationMetricsOptions operationMetricsOption
/// <summary>
/// Represents the client ID for Cosmos DB.
/// </summary>
public const string ClientId = "db.cosmosdb.client_id";
public const string ClientId = "azure.cosmosdb.client.id";

/// <summary>
/// Represents the user agent, compliant with OpenTelemetry conventions.
Expand All @@ -95,7 +95,7 @@ public OpenTelemetryAttributeKeys(OperationMetricsOptions operationMetricsOption
/// <summary>
/// Represents the connection mode for Cosmos DB.
/// </summary>
public const string ConnectionMode = "db.cosmosdb.connection_mode";
public const string ConnectionMode = "azure.cosmosdb.connection.mode";

// Request/Response specifics

Expand All @@ -107,12 +107,12 @@ public OpenTelemetryAttributeKeys(OperationMetricsOptions operationMetricsOption
/// <summary>
/// Represents the content length of the request.
/// </summary>
public const string RequestContentLength = "db.cosmosdb.request_content_length";
public const string RequestContentLength = "azure.cosmosdb.request.body.size";

/// <summary>
/// Represents the content length of the response.
/// </summary>
public const string ResponseContentLength = "db.cosmosdb.response_content_length";
public const string ResponseContentLength = "azure.cosmosdb.response.body.size";

/// <summary>
/// Represents the status code of the response.
Expand All @@ -122,32 +122,32 @@ public OpenTelemetryAttributeKeys(OperationMetricsOptions operationMetricsOption
/// <summary>
/// Represents the sub-status code of the response.
/// </summary>
public const string SubStatusCode = "db.cosmosdb.sub_status_code";
public const string SubStatusCode = "azure.cosmosdb.response.sub_status_code";

/// <summary>
/// Represents the request charge for the operation.
/// </summary>
public const string RequestCharge = "db.cosmosdb.request_charge";
public const string RequestCharge = "azure.cosmosdb.request.request_charge";

/// <summary>
/// Represents the regions contacted for the operation.
/// </summary>
public const string Region = "db.cosmosdb.regions_contacted";
public const string Region = "azure.cosmosdb.contacted_regions";

/// <summary>
/// Represents the item count in the operation.
/// </summary>
public const string ItemCount = "db.cosmosdb.row_count";
public const string ItemCount = "azure.cosmosdb.row.count";

/// <summary>
/// Represents the activity ID for the operation.
/// </summary>
public const string ActivityId = "db.cosmosdb.activity_id";
public const string ActivityId = "azure.cosmosdb.activity_id";

/// <summary>
/// Represents the correlated activity ID for the operation.
/// </summary>
public const string CorrelatedActivityId = "db.cosmosdb.correlated_activity_id";
public const string CorrelatedActivityId = "azure.cosmosdb.correlated_activity_id";

/// <summary>
/// Represents the Azure Cosmos DB SQL Query.
Expand All @@ -162,7 +162,7 @@ public OpenTelemetryAttributeKeys(OperationMetricsOptions operationMetricsOption
/// <summary>
/// Consistency Level
/// </summary>
public const string ConsistencyLevel = "db.cosmosdb.consistency_level";
public const string ConsistencyLevel = "azure.cosmosdb.consistency.level";

// Exceptions

Expand All @@ -187,13 +187,13 @@ public OpenTelemetryAttributeKeys(OperationMetricsOptions operationMetricsOption

public const string ServiceEndPointPort = "network.protocol.port";

public const string ServiceEndpointStatusCode = "db.cosmosdb.network.response.status_code";
public const string ServiceEndpointStatusCode = "azure.cosmosdb.network.response.status_code";

public const string ServiceEndpointSubStatusCode = "db.cosmosdb.network.response.sub_status_code";
public const string ServiceEndpointSubStatusCode = "azure.cosmosdb.network.response.sub_status_code";

public const string ServiceEndpointRegion = "cloud.region";

public const string ServiceEndpointRoutingId = "db.cosmosdb.network.routing_id ";
public const string ServiceEndpointRoutingId = "azure.cosmosdb.network.routing_id ";

/// <summary>
/// Represents the type of error.
Expand Down
28 changes: 20 additions & 8 deletions ...Tests/BaselineTest/TestBaseline/EndToEndTraceWriterBaselineTests.BatchOperationsAsync.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,31 +142,37 @@
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.execute_batch" displayName="execute_batch containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
<ATTRIBUTE key="db.system.name">cosmosdb</ATTRIBUTE>
<ATTRIBUTE key="db.operation">execute_batch</ATTRIBUTE>
<ATTRIBUTE key="db.name">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.container">containerName</ATTRIBUTE>
<ATTRIBUTE key="net.peer.name">127.0.0.1</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.user_agent">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.machine_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.client_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.connection_mode">direct</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.connection_mode">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">execute_batch</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="server.address">127.0.0.1</ATTRIBUTE>
<ATTRIBUTE key="server.port">Some Value</ATTRIBUTE>
<ATTRIBUTE key="user_agent.original">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.client.id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.connection.mode">direct</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.operation_type">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.status_code">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.sub_status_code">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.request_charge">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.item_count">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">South Central US</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.operation.batch.size">90</ATTRIBUTE>
<ATTRIBUTE key="db.response.status_code">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.row_count">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.response.sub_status_code">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.request.request_charge">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.row.count">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.contacted_regions">South Central US</ATTRIBUTE>
<ATTRIBUTE key="error.type">400/1001</ATTRIBUTE>
</ACTIVITY>
<EVENT name="FailedRequest" />
Expand Down Expand Up @@ -303,31 +309,37 @@
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.execute_batch" displayName="execute_batch containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
<ATTRIBUTE key="db.system.name">cosmosdb</ATTRIBUTE>
<ATTRIBUTE key="db.operation">execute_batch</ATTRIBUTE>
<ATTRIBUTE key="db.name">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.container">containerName</ATTRIBUTE>
<ATTRIBUTE key="net.peer.name">127.0.0.1</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.user_agent">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.machine_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.client_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.connection_mode">direct</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.connection_mode">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">execute_batch</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="server.address">127.0.0.1</ATTRIBUTE>
<ATTRIBUTE key="server.port">Some Value</ATTRIBUTE>
<ATTRIBUTE key="user_agent.original">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.client.id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.connection.mode">direct</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.operation_type">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.status_code">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.sub_status_code">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.request_charge">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.item_count">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">South Central US</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.operation.batch.size">50</ATTRIBUTE>
<ATTRIBUTE key="db.response.status_code">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.row_count">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.response.sub_status_code">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.request.request_charge">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.row.count">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="azure.cosmosdb.contacted_regions">South Central US</ATTRIBUTE>
<ATTRIBUTE key="error.type">400/1001</ATTRIBUTE>
</ACTIVITY>
<EVENT name="FailedRequest" />
Expand Down
Loading
Loading