Skip to content
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.

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

fix(app): Add missing telemetry setup GraphQL and Service #1695

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

oskogstad
Copy link
Collaborator

Missing calls to OpenTelemetryExtensions

@oskogstad oskogstad requested a review from a team as a code owner January 15, 2025 10:12
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

📝 Walkthrough

Walkthrough

The pull request introduces telemetry configuration to two different project files: Digdir.Domain.Dialogporten.GraphQL/Program.cs and Digdir.Domain.Dialogporten.Service/Program.cs. In both files, a new method .AddDialogportenTelemetry() is added to the service configuration chain, which integrates telemetry capabilities into the application. This addition allows for enhanced monitoring and diagnostic data collection during application runtime.

Changes

File Change Summary
src/Digdir.Domain.Dialogporten.GraphQL/Program.cs Added .AddDialogportenTelemetry(builder.Configuration, builder.Environment) to service configuration
src/Digdir.Domain.Dialogporten.Service/Program.cs Added .AddDialogportenTelemetry(builder.Configuration, builder.Environment) to service configuration

Possibly related PRs

Suggested reviewers

  • arealmaas
  • MagnusSandgren

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/Digdir.Domain.Dialogporten.GraphQL/Program.cs (1)

89-91: Consider moving telemetry setup earlier in the service configuration chain.

The telemetry setup is positioned differently compared to Service/Program.cs where it's configured before infrastructure. Consider moving it earlier in the chain (before GraphQL setup) to ensure consistent telemetry coverage across all components.

     builder.Services
         // Options setup
         .ConfigureOptions<AuthorizationOptionsSetup>()
 
+        //Telemetry
+        .AddDialogportenTelemetry(builder.Configuration, builder.Environment)
+
         // Clean architecture projects
         .AddApplication(builder.Configuration, builder.Environment)
         .AddInfrastructure(builder.Configuration, builder.Environment)
             .WithPubCapabilities()
             .Build()
         .AddAutoMapper(Assembly.GetExecutingAssembly())
         .AddHttpContextAccessor()
         .AddScoped<IUser, ApplicationUser>()
         .AddValidatorsFromAssembly(thisAssembly, ServiceLifetime.Transient, includeInternalTypes: true)
         .AddAzureAppConfiguration()
 
         // Graph QL
         .AddDialogportenGraphQl()
 
         // Add controllers
         .AddControllers()
             .Services
-
-        //Telemetry
-        .AddDialogportenTelemetry(builder.Configuration, builder.Environment)
-
         // Add health checks with the well-known URLs
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 91850a8 and 916f6f1.

📒 Files selected for processing (2)
  • src/Digdir.Domain.Dialogporten.GraphQL/Program.cs (1 hunks)
  • src/Digdir.Domain.Dialogporten.Service/Program.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build / build-and-test
🔇 Additional comments (1)
src/Digdir.Domain.Dialogporten.Service/Program.cs (1)

54-54: LGTM! Verify telemetry configuration propagation.

The placement of telemetry setup is correct - after configuration but before infrastructure setup. This ensures telemetry is available throughout the application lifecycle.

Let's verify the telemetry configuration is properly propagated:

✅ Verification successful

Telemetry configuration is properly integrated and consistent

The telemetry setup is correctly implemented with:

  • Identical configuration across all entry points (Service, WebApi, GraphQL)
  • Proper validation of telemetry endpoints
  • Infrastructure consuming telemetry through DI without requiring explicit setup
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for telemetry configuration usage in infrastructure and other components
rg -l "IConfiguration|AddDialogportenTelemetry" src/Digdir.Domain.Dialogporten.Infrastructure/

# Verify consistent telemetry setup across components
ast-grep --pattern 'AddDialogportenTelemetry($config, $env)'

Length of output: 548


Script:

#!/bin/bash
# Check infrastructure telemetry setup
rg -A 5 "telemetry|Telemetry" src/Digdir.Domain.Dialogporten.Infrastructure/InfrastructureExtensions.cs

# Find AddDialogportenTelemetry implementation
fd -e cs -x rg -l "AddDialogportenTelemetry"

# Check configuration usage in infrastructure
rg -A 3 "AddTelemetry|ConfigureTelemetry" src/Digdir.Domain.Dialogporten.Infrastructure/

Length of output: 653


Script:

#!/bin/bash
# Check OpenTelemetryExtensions implementation in Service
rg -A 10 "AddDialogportenTelemetry" src/Digdir.Domain.Dialogporten.Service/Common/Extensions/OpenTelemetryExtensions.cs

# Compare with other implementations
rg -A 10 "AddDialogportenTelemetry" src/Digdir.Domain.Dialogporten.WebApi/Common/Extensions/OpenTelemetryExtensions.cs
rg -A 10 "AddDialogportenTelemetry" src/Digdir.Domain.Dialogporten.GraphQL/Common/Extensions/OpenTelemetryExtensions.cs

Length of output: 1759

@oskogstad oskogstad merged commit 601a826 into main Jan 15, 2025
18 of 22 checks passed
@oskogstad oskogstad deleted the fix/add-missing-otlp-graphql-service branch January 15, 2025 10:17
arealmaas pushed a commit that referenced this pull request Jan 15, 2025
🤖 I have created a release *beep* *boop*
---


##
[1.45.0](v1.44.2...v1.45.0)
(2025-01-15)


### Features

* added id to attachments, ApiActions and GuiActions in DialogCreate
([#1670](#1670))
([470e5a9](470e5a9))
* **apps:** export logs to open telemetry endpoint
([#1617](#1617))
([1a71763](1a71763))
* **janitor:** add otlp logger for janitor
([#1686](#1686))
([2e1656b](2e1656b))


### Bug Fixes

* **app:** Add missing telemetry setup GraphQL and Service
([#1695](#1695))
([601a826](601a826))
* Authentication level claim is 0 in dialog token
([#1654](#1654))
([37e545a](37e545a))
* **graphql:** Add missing activity types
([#1684](#1684))
([a0697ae](a0697ae))
* **graphql:** Set max execution depth to allow inspection query
([#1679](#1679))
([6265110](6265110)),
closes [#1680](#1680)
* **web-api:** re-enable health checks
([#1681](#1681))
([96c2c3e](96c2c3e))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants