2554 Enhance REST OTEL instrumentation with custom metrics and traces #2617
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tommasodotNET
requested review from
Aniruddh25,
aaronburtle,
RubenCerna2079,
ravishetye,
rohkhann,
neeraj-sharma2592,
sourabh1007 and
sezal98
as code owners
|
@Aniruddh25 is March realistic? |
aaronpowell
reviewed
Mar 17, 2025
Co-authored-by: Aaron Powell <[email protected]>
Co-authored-by: Aaron Powell <[email protected]>
|
/azp run |
|
Commenter does not have sufficient privileges for PR 2617 in repo Azure/data-api-builder |
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
sezal98
reviewed
Mar 31, 2025
…a-api-builder into features/2554-enh-otel
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
Co-authored-by: RubenCerna2079 <[email protected]>
…a-api-builder into features/2554-enh-otel
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
There was a problem hiding this comment.
Copilot reviewed 7 out of 8 changed files in this pull request and generated no comments.
Files not reviewed (1)
- src/Service/Azure.DataApiBuilder.Service.csproj: Language not supported
Comments suppressed due to low confidence (2)
src/Service/Telemetry/TelemetryTracesHelper.cs:94
- The method name 'TrackRestControllerActivityFinishedWithWithException' contains a duplicate 'With'. Consider renaming it to 'TrackRestControllerActivityFinishedWithException' for clarity.
public static void TrackRestControllerActivityFinishedWithWithException(
src/Service/Controllers/RestController.cs:249
- Manual disposal of 'queryActivity' is redundant since it is declared within a 'using' block, which will automatically dispose it. Removing the explicit call can prevent potential unexpected behavior from double disposal.
if (queryActivity is not null && queryActivity.IsAllDataRequested)
{
queryActivity.Dispose();
}
RubenCerna2079
previously approved these changes
Apr 7, 2025
Aniruddh25
reviewed
Apr 7, 2025
Aniruddh25
reviewed
Apr 7, 2025
Aniruddh25
reviewed
Apr 7, 2025
Aniruddh25
reviewed
Apr 7, 2025
Aniruddh25
previously approved these changes
Apr 7, 2025
@tommasodotNET Seems like queryActivity.Dispose() could be removed? Can it? |
tommasodotNET
dismissed stale reviews from Aniruddh25 and RubenCerna2079
via
30c61ca
|
Hey @Aniruddh25, I've addressed copilot review |
Co-authored-by: RubenCerna2079 <[email protected]>
…a-api-builder into features/2554-enh-otel
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
Aniruddh25
reviewed
Apr 12, 2025
| }); | ||
|
|
||
| }) | ||
| //.WithLogging(logging => |
There was a problem hiding this comment.
if we dont need this to enable logging, please remove the commented out code from Startup.cs
|
@tommasodotNET, waiting on all tests to pass.. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why make this change?
What is this change?
This PR enhances the OTEL instrumentation for the REST APIs by adding custom traces and metrics.
I have removed ASP NET Core standard instrumentation since it does not provide great value given the custom nature of the webservice. I have written two main Helper classes:
TelemetryMetricsHelperandTelemetryTracesHelperto provide a single point of management for custom traces and metrics.Metrics can be filtered for
status_code,api_type,endpointandmethod.I have also fixed the loggings which are now sent to the configured OTEL endpoint.
Logs
Metrics
Traces
How was this tested?
Sample Request(s)
To test everything locally I recommend using this repo that allows to run the local build of the dab cli and send metrics to the .NET Aspire OTEL endoint.