Skip to content

[Internal] Open Telemetry: Fixes Metric Name and Unit changes #5098

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
kirankumarkolli merged 5 commits into from
Apr 2, 2025
Merged

[Internal] Open Telemetry: Fixes Metric Name and Unit changes #5098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
33ec61e
[Internal] Open Telemetry: Fixes Metric Name and Unit changes
sourabh1007 Mar 28, 2025
44b648c
Merge branch 'master' into users/sourabhjain/otelunitnamechanges
sourabh1007 Mar 30, 2025
fa9c267
update contract
sourabh1007 Mar 30, 2025
8d06222
Merge branch 'master' into users/sourabhjain/otelunitnamechanges
sourabh1007 Apr 1, 2025
5f3b651
Merge branch 'master' into users/sourabhjain/otelunitnamechanges
sourabh1007 Apr 2, 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
16 changes: 10 additions & 6 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 @@ -49,7 +49,7 @@ public static class Name
/// <summary>
/// For feed operations (query, readAll, readMany, change feed) batch operations this meter capture the actual item count in responses from the service.
/// </summary>
public const string RowCount = "db.client.response.row_count";
public const string RowCount = "db.client.response.returned_rows";

/// <summary>
/// Number of active SDK client instances.
Expand All @@ -63,20 +63,24 @@ public static class Name
public static class Unit
{
/// <summary>
/// Unit representing a simple count
/// Unit representing active client instances
/// </summary>
public const string Count = "#";
public const string Instance = "{instance}";

/// <summary>
/// Unit representing count of items in response
/// </summary>
public const string Item = "{item}";

/// <summary>
/// Unit representing time in seconds
/// </summary>
public const string Sec = "s";

/// <summary>
/// Unit representing request units
/// Unit representing request units (RU)
/// </summary>
public const string RequestUnit = "# RU";

public const string RequestUnit = "{request_unit}";
}

/// <summary>
Expand Down
4 changes: 2 additions & 2 deletions Microsoft.Azure.Cosmos/src/Telemetry/OpenTelemetry/CosmosDbOperationMeter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,11 @@ internal static void Initialize(CosmosClientTelemetryOptions metricsOptions = nu
description: CosmosDbClientMetrics.OperationMetrics.Description.RequestCharge);

CosmosDbOperationMeter.ActualItemHistogram ??= OperationMeter.CreateHistogram<int>(name: CosmosDbClientMetrics.OperationMetrics.Name.RowCount,
unit: CosmosDbClientMetrics.OperationMetrics.Unit.Count,
unit: CosmosDbClientMetrics.OperationMetrics.Unit.Item,
description: CosmosDbClientMetrics.OperationMetrics.Description.RowCount);

CosmosDbOperationMeter.ActiveInstanceCounter ??= OperationMeter.CreateUpDownCounter<int>(name: CosmosDbClientMetrics.OperationMetrics.Name.ActiveInstances,
unit: CosmosDbClientMetrics.OperationMetrics.Unit.Count,
unit: CosmosDbClientMetrics.OperationMetrics.Unit.Instance,
description: CosmosDbClientMetrics.OperationMetrics.Description.ActiveInstances);

IsEnabled = true;
Expand Down
2 changes: 1 addition & 1 deletion ...ure.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/Metrics/OpenTelemetryMetricsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public class OpenTelemetryMetricsTest : BaseCosmosClientHelper
private static readonly Dictionary<string, MetricType> expectedOperationMetrics = new()
{
{ "db.client.operation.duration", MetricType.Histogram },
{ "db.client.response.row_count", MetricType.Histogram},
{ "db.client.response.returned_rows", MetricType.Histogram},
{ "azure.cosmosdb.client.operation.request_charge", MetricType.Histogram },
{ "azure.cosmosdb.client.active_instance.count", MetricType.LongSumNonMonotonic }
};
Expand Down
27 changes: 21 additions & 6 deletions Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/Contracts/DotNetPreviewSDKAPI.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,10 +667,15 @@
"Microsoft.Azure.Cosmos.CosmosDbClientMetrics+OperationMetrics+Unit;System.Object;IsAbstract:True;IsSealed:True;IsInterface:False;IsEnum:False;IsClass:True;IsValueType:False;IsNested:True;IsGenericType:False;IsSerializable:False": {
"Subclasses": {},
"Members": {
"System.String Count": {
"System.String Instance": {
"Type": "Field",
"Attributes": [],
"MethodInfo": "System.String Count;IsInitOnly:False;IsStatic:True;"
"MethodInfo": "System.String Instance;IsInitOnly:False;IsStatic:True;"
},
"System.String Item": {
"Type": "Field",
"Attributes": [],
"MethodInfo": "System.String Item;IsInitOnly:False;IsStatic:True;"
},
"System.String RequestUnit": {
"Type": "Field",
Expand Down Expand Up @@ -1023,10 +1028,15 @@
"Microsoft.Azure.Cosmos.CosmosDbClientMetrics+OperationMetrics+Unit;System.Object;IsAbstract:True;IsSealed:True;IsInterface:False;IsEnum:False;IsClass:True;IsValueType:False;IsNested:True;IsGenericType:False;IsSerializable:False": {
"Subclasses": {},
"Members": {
"System.String Count": {
"System.String Instance": {
"Type": "Field",
"Attributes": [],
"MethodInfo": "System.String Count;IsInitOnly:False;IsStatic:True;"
"MethodInfo": "System.String Instance;IsInitOnly:False;IsStatic:True;"
},
"System.String Item": {
"Type": "Field",
"Attributes": [],
"MethodInfo": "System.String Item;IsInitOnly:False;IsStatic:True;"
},
"System.String RequestUnit": {
"Type": "Field",
Expand Down Expand Up @@ -1098,10 +1108,15 @@
"Microsoft.Azure.Cosmos.CosmosDbClientMetrics+OperationMetrics+Unit;System.Object;IsAbstract:True;IsSealed:True;IsInterface:False;IsEnum:False;IsClass:True;IsValueType:False;IsNested:True;IsGenericType:False;IsSerializable:False": {
"Subclasses": {},
"Members": {
"System.String Count": {
"System.String Instance": {
"Type": "Field",
"Attributes": [],
"MethodInfo": "System.String Instance;IsInitOnly:False;IsStatic:True;"
},
"System.String Item": {
"Type": "Field",
"Attributes": [],
"MethodInfo": "System.String Count;IsInitOnly:False;IsStatic:True;"
"MethodInfo": "System.String Item;IsInitOnly:False;IsStatic:True;"
},
"System.String RequestUnit": {
"Type": "Field",
Expand Down