Skip to content

Open Telemetry: Fixes Operation name to follow Otel convention #4643

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
microsoft-github-policy-service merged 22 commits into from
Sep 18, 2024
Merged

Open Telemetry: Fixes Operation name to follow Otel convention #4643

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
8586467
Changed Operation name according to open telemetry convention
sourabh1007 Aug 16, 2024
1ab196c
fix tests
sourabh1007 Aug 23, 2024
bc85fb0
updated baseline
sourabh1007 Aug 23, 2024
f0f393b
fix tests
sourabh1007 Aug 26, 2024
578718f
renamed ops name
sourabh1007 Aug 29, 2024
a3ea499
fixed operatio name
sourabh1007 Aug 30, 2024
d58a8c5
reverted few files
sourabh1007 Aug 30, 2024
20fd605
append prefix
sourabh1007 Aug 31, 2024
83f14d4
fix tests
sourabh1007 Sep 1, 2024
235d6ea
remove commented code
sourabh1007 Sep 2, 2024
1556119
fix activity name
sourabh1007 Sep 5, 2024
37c5daa
code refatot for different operation name for diagnostics
sourabh1007 Sep 6, 2024
93f5c07
baseline files
sourabh1007 Sep 6, 2024
ca7e903
fix tests
sourabh1007 Sep 6, 2024
301ebe5
refcator code
sourabh1007 Sep 10, 2024
22773fe
fix test
sourabh1007 Sep 10, 2024
190de3a
remove stream
sourabh1007 Sep 17, 2024
07dbf1d
feediterator changes
sourabh1007 Sep 17, 2024
8bb0946
fix bugs
sourabh1007 Sep 17, 2024
79543d0
further fixes
sourabh1007 Sep 17, 2024
5e31de4
typo fix
sourabh1007 Sep 17, 2024
71b0d07
fix test
sourabh1007 Sep 17, 2024
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
Prev Previous commit
Next Next commit
further fixes
  • Loading branch information
@sourabh1007
sourabh1007 committed Sep 17, 2024
commit 79543d0240d2f5685d8ece884cde64274d999a2b
1 change: 1 addition & 0 deletions Microsoft.Azure.Cosmos/src/Query/v3Query/QueryIterator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ private QueryIterator(

this.container = container;
this.operationName = OpenTelemetryConstants.Operations.QueryItems;
this.operationType = Documents.OperationType.Query;
}

public static QueryIterator Create(
Expand Down
5 changes: 5 additions & 0 deletions Microsoft.Azure.Cosmos/src/Resource/FeedIterators/FeedIterator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,5 +140,10 @@ public void Dispose()
/// Operation Name used for open telemetry traces
/// </summary>
internal string operationName;

/// <summary>
/// Operation Type used for open telemetry traces, it will set optionally, otherwise default operation type will be used in traces
/// </summary>
internal Documents.OperationType? operationType;
}
}
4 changes: 3 additions & 1 deletion Microsoft.Azure.Cosmos/src/Resource/FeedIterators/FeedIteratorCore.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ public FeedIteratorCore(
this.container = container;

this.operationName = OpenTelemetryConstants.Operations.QueryItems;
this.operationType = OperationType.Query;
}

public override bool HasMoreResults => this.hasMoreResultsInternal;
Expand Down Expand Up @@ -216,7 +217,8 @@ internal FeedIteratorCore(
this.databaseName = feedIterator.databaseName;
this.container = feedIterator.container;

this.operationName = OpenTelemetryConstants.Operations.QueryItems;
this.operationName = feedIterator.operationName;
this.operationType = feedIterator.operationType;
}

public override bool HasMoreResults => this.feedIterator.HasMoreResults;
Expand Down
13 changes: 12 additions & 1 deletion Microsoft.Azure.Cosmos/src/Resource/FeedIterators/FeedIteratorInlineCore.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ internal FeedIteratorInlineCore(
this.databaseName = feedIteratorInternal.databaseName;

this.operationName = feedIteratorInternal.operationName;
this.operationType = feedIteratorInternal.operationType;
}

internal FeedIteratorInlineCore(
Expand All @@ -45,6 +46,7 @@ internal FeedIteratorInlineCore(
this.databaseName = feedIteratorInternal.databaseName;

this.operationName = feedIteratorInternal.operationName;
this.operationType = feedIteratorInternal.operationType;
}

public override bool HasMoreResults => this.feedIteratorInternal.HasMoreResults;
Expand All @@ -58,7 +60,16 @@ public override Task<ResponseMessage> ReadNextAsync(CancellationToken cancellati
operationType: Documents.OperationType.ReadFeed,
requestOptions: null,
task: (trace) => this.feedIteratorInternal.ReadNextAsync(trace, cancellationToken),
openTelemetry: new (this.operationName, (response) => new OpenTelemetryResponse(responseMessage: response)));
openTelemetry: new (this.operationName, (response) =>
{
OpenTelemetryResponse openTelemetryResponse = new OpenTelemetryResponse(responseMessage: response);

if (this.operationType.HasValue)
{
openTelemetryResponse.OperationType = this.operationType.Value;
}
return openTelemetryResponse;
}));
}

public override Task<ResponseMessage> ReadNextAsync(ITrace trace, CancellationToken cancellationToken = default)
Expand Down
13 changes: 12 additions & 1 deletion Microsoft.Azure.Cosmos/src/Resource/FeedIterators/FeedIteratorInlineCore{T}.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ internal FeedIteratorInlineCore(
this.databaseName = feedIteratorInternal.databaseName;

this.operationName = feedIteratorInternal.operationName;
this.operationType = feedIteratorInternal.operationType;
}

internal FeedIteratorInlineCore(
Expand All @@ -45,6 +46,7 @@ internal FeedIteratorInlineCore(
this.databaseName = feedIteratorInternal.databaseName;

this.operationName = feedIteratorInternal.operationName;
this.operationType = feedIteratorInternal.operationType;
}

public override bool HasMoreResults => this.feedIteratorInternal.HasMoreResults;
Expand All @@ -58,7 +60,16 @@ public override Task<FeedResponse<T>> ReadNextAsync(CancellationToken cancellati
operationType: Documents.OperationType.ReadFeed,
requestOptions: null,
task: trace => this.feedIteratorInternal.ReadNextAsync(trace, cancellationToken),
openTelemetry: new (this.feedIteratorInternal.operationName, (response) => new OpenTelemetryResponse<T>(responseMessage: response)));
openTelemetry: new (this.feedIteratorInternal.operationName, (response) =>
{
OpenTelemetryResponse<T> openTelemetryResponse = new OpenTelemetryResponse<T>(responseMessage: response);

if (this.operationType.HasValue)
{
openTelemetryResponse.OperationType = this.operationType.Value;
}
return openTelemetryResponse;
}));
}

public override Task<FeedResponse<T>> ReadNextAsync(ITrace trace, CancellationToken cancellationToken)
Expand Down
5 changes: 5 additions & 0 deletions Microsoft.Azure.Cosmos/src/Resource/FeedIterators/FeedIterator{T}.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,10 @@ public void Dispose()
/// Operation Name used for open telemetry traces
/// </summary>
internal string operationName;

/// <summary>
/// Operation Type used for open telemetry traces
/// </summary>
internal Documents.OperationType? operationType;
}
}
2 changes: 1 addition & 1 deletion 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 @@ -140,7 +140,7 @@ internal sealed class OpenTelemetryAttributeKeys
/// <summary>
/// Represents the size of the batch operation.
/// </summary>
public const string BatchSize = "db.operation.batch.size";
public const string BatchSize = "db.operation.batch_size";

// Exceptions

Expand Down
10 changes: 10 additions & 0 deletions ...rTests/BaselineTest/TestBaseline/EndToEndTraceWriterBaselineTests.BulkOperationsAsync.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,7 @@
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="FailedRequest" />
</OTelActivities></Output>
</Result>
<Result>
Expand Down Expand Up @@ -690,6 +691,7 @@
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="FailedRequest" />
</OTelActivities></Output>
</Result>
<Result>
Expand Down Expand Up @@ -1027,6 +1029,7 @@
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="FailedRequest" />
</OTelActivities></Output>
</Result>
<Result>
Expand Down Expand Up @@ -1364,6 +1367,7 @@
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="FailedRequest" />
</OTelActivities></Output>
</Result>
<Result>
Expand Down Expand Up @@ -1701,6 +1705,7 @@
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="FailedRequest" />
</OTelActivities></Output>
</Result>
<Result>
Expand Down Expand Up @@ -2038,6 +2043,7 @@
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="FailedRequest" />
</OTelActivities></Output>
</Result>
<Result>
Expand Down Expand Up @@ -2375,6 +2381,7 @@
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="FailedRequest" />
</OTelActivities></Output>
</Result>
<Result>
Expand Down Expand Up @@ -2712,6 +2719,7 @@
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="FailedRequest" />
</OTelActivities></Output>
</Result>
<Result>
Expand Down Expand Up @@ -3049,6 +3057,7 @@
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="FailedRequest" />
</OTelActivities></Output>
</Result>
<Result>
Expand Down Expand Up @@ -3386,6 +3395,7 @@
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="ThresholdViolation" />
<EVENT name="FailedRequest" />
</OTelActivities></Output>
</Result>
<Result>
Expand Down
40 changes: 20 additions & 20 deletions ...latorTests/BaselineTest/TestBaseline/EndToEndTraceWriterBaselineTests.ChangeFeedAsync.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1769,10 +1769,10 @@
}
]
}]]></Json><OTelActivities>
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_items" displayName="query_items containerName">
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_change_feed" displayName="query_change_feed containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_items</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_change_feed</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
Expand All @@ -1788,10 +1788,10 @@
<ATTRIBUTE key="db.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">South Central US</ATTRIBUTE>
</ACTIVITY>
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_items" displayName="query_items containerName">
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_change_feed" displayName="query_change_feed containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_items</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_change_feed</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
Expand All @@ -1807,10 +1807,10 @@
<ATTRIBUTE key="db.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">South Central US</ATTRIBUTE>
</ACTIVITY>
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_items" displayName="query_items containerName">
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_change_feed" displayName="query_change_feed containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_items</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_change_feed</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
Expand All @@ -1826,10 +1826,10 @@
<ATTRIBUTE key="db.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">South Central US</ATTRIBUTE>
</ACTIVITY>
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_items" displayName="query_items containerName">
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_change_feed" displayName="query_change_feed containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_items</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_change_feed</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
Expand All @@ -1845,10 +1845,10 @@
<ATTRIBUTE key="db.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">South Central US</ATTRIBUTE>
</ACTIVITY>
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_items" displayName="query_items containerName">
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_change_feed" displayName="query_change_feed containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_items</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_change_feed</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
Expand Down Expand Up @@ -3243,10 +3243,10 @@
}
]
}]]></Json><OTelActivities>
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_items" displayName="query_items containerName">
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_change_feed" displayName="query_change_feed containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_items</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_change_feed</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
Expand All @@ -3262,10 +3262,10 @@
<ATTRIBUTE key="db.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">South Central US</ATTRIBUTE>
</ACTIVITY>
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_items" displayName="query_items containerName">
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_change_feed" displayName="query_change_feed containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_items</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_change_feed</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
Expand All @@ -3281,10 +3281,10 @@
<ATTRIBUTE key="db.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">South Central US</ATTRIBUTE>
</ACTIVITY>
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_items" displayName="query_items containerName">
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_change_feed" displayName="query_change_feed containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_items</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_change_feed</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
Expand All @@ -3300,10 +3300,10 @@
<ATTRIBUTE key="db.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">South Central US</ATTRIBUTE>
</ACTIVITY>
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_items" displayName="query_items containerName">
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_change_feed" displayName="query_change_feed containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_items</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_change_feed</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
Expand All @@ -3319,10 +3319,10 @@
<ATTRIBUTE key="db.cosmosdb.activity_id">Some Value</ATTRIBUTE>
<ATTRIBUTE key="db.cosmosdb.regions_contacted">South Central US</ATTRIBUTE>
</ACTIVITY>
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_items" displayName="query_items containerName">
<ACTIVITY source="Azure.Cosmos.Operation" operationName="Operation.query_change_feed" displayName="query_change_feed containerName">
<ATTRIBUTE key="az.namespace">Microsoft.DocumentDB</ATTRIBUTE>
<ATTRIBUTE key="az.schema_url">https://opentelemetry.io/schemas/1.23.0</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_items</ATTRIBUTE>
<ATTRIBUTE key="db.operation.name">query_change_feed</ATTRIBUTE>
<ATTRIBUTE key="db.namespace">databaseName</ATTRIBUTE>
<ATTRIBUTE key="db.collection.name">containerName</ATTRIBUTE>
<ATTRIBUTE key="db.system">cosmosdb</ATTRIBUTE>
Expand Down
Loading