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

chore: Switch server tracing configs to use OTEL #37333

Merged
merged 3 commits into from
Nov 12, 2024

Conversation

nidhi-nair
Copy link
Contributor

@nidhi-nair nidhi-nair commented Nov 12, 2024

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags=""

🔍 Cypress test results

Warning

Tests have not run on the HEAD 20454b5 yet


Tue, 12 Nov 2024 07:55:00 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Introduced OpenTelemetry tracing support, enhancing observability capabilities.
    • Added new configuration properties for OpenTelemetry integration with New Relic.
  • Bug Fixes

    • Removed deprecated Zipkin tracing configuration to streamline observability.
  • Chores

    • Updated dependencies for improved performance and compatibility with OpenTelemetry.

@nidhi-nair nidhi-nair requested a review from sharat87 as a code owner November 12, 2024 07:49
Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Walkthrough

The pull request introduces significant updates to the Appsmith server's dependency management and configuration files. Key changes include the upgrade of OpenTelemetry dependencies, the removal of outdated components, and the addition of new properties for OpenTelemetry tracing in the application.properties file. Additionally, two configuration classes related to metrics and tracing have been removed, reflecting a shift towards a more streamlined observability strategy using OpenTelemetry.

Changes

File Path Change Summary
app/server/appsmith-server/pom.xml Updated opentelemetry-bom from 1.34.1 to 1.43.0; removed several OpenTelemetry dependencies; added micrometer-tracing-bridge-otel version 1.3.5.
app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/MetricsConfig.java Removed class and associated methods responsible for metrics configuration with New Relic.
app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/ZipkinMicrometerTraceConfiguration.java Removed class and method for customizing Zipkin web client.
app/server/appsmith-server/src/main/resources/application.properties Added new OpenTelemetry properties; removed old New Relic properties related to observability.

Possibly related PRs

Suggested labels

ok-to-test

Suggested reviewers

  • ApekshaBhosale
  • dvj1988

🎉 In the realm of code, where changes unfold,
OpenTelemetry's tale is now boldly told.
Dependencies updated, configurations refined,
A shift towards clarity, in metrics aligned.
With classes removed, the old makes way,
For a brighter tomorrow, in observability's play! 🌟


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 12ab7e6 and 20454b5.

📒 Files selected for processing (4)
  • app/server/appsmith-server/pom.xml (2 hunks)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/MetricsConfig.java (0 hunks)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/ZipkinMicrometerTraceConfiguration.java (0 hunks)
  • app/server/appsmith-server/src/main/resources/application.properties (1 hunks)
💤 Files with no reviewable changes (2)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/MetricsConfig.java
  • app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/ZipkinMicrometerTraceConfiguration.java
🔇 Additional comments (3)
app/server/appsmith-server/pom.xml (2)

203-212: Verify OTEL tracing dependencies completeness

The switch from Brave to OpenTelemetry tracing looks good, but we should ensure all required dependencies are included.

#!/bin/bash
# Check if we have all necessary OTEL dependencies
# Common missing dependencies: opentelemetry-api, opentelemetry-context

rg -g "pom.xml" "opentelemetry-api|opentelemetry-context"

# Check for any existing OTEL configuration that might need updates
rg -g "application*.properties|application*.yml" "opentelemetry|otel"

35-35: Verify compatibility with OpenTelemetry 1.43.0

The major version jump from 1.34.1 to 1.43.0 requires verification of compatibility with other dependencies.

✅ Verification successful

OpenTelemetry 1.43.0 upgrade is compatible with the current setup

The version upgrade is compatible with:

  • Spring Boot 3.3.3
  • Micrometer Tracing Bridge 1.3.5
  • Existing OpenTelemetry configuration in properties
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any compatibility issues between OpenTelemetry 1.43.0 and Spring Boot
rg -g "*.xml" -A 5 "opentelemetry|micrometer"

# Check for any migration guides or breaking changes
curl -s https://raw.githubusercontent.com/open-telemetry/opentelemetry-java/main/CHANGELOG.md | grep -A 10 "1.43.0"

Length of output: 278


Script:

#!/bin/bash
# Search for OpenTelemetry BOM and related dependencies in pom.xml files
rg -g "pom.xml" -B 2 -A 2 "<version>1\.43\.0</version>"

# Search for Spring Boot version and micrometer dependencies
rg -g "pom.xml" -B 2 -A 2 "spring-boot-starter-parent|micrometer-tracing"

# Look for any OpenTelemetry configuration in properties files
fd -e properties -e yml -x cat {} \; | rg "opentelemetry|otel"

Length of output: 2514

app/server/appsmith-server/src/main/resources/application.properties (1)

94-98: OpenTelemetry tracing properties added correctly

The new OpenTelemetry tracing configurations are properly added and should integrate with the tracing system as expected.


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 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.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Nov 12, 2024
@nidhi-nair nidhi-nair merged commit d4007e1 into release Nov 12, 2024
19 checks passed
@nidhi-nair nidhi-nair deleted the chore/otlp-traces-server branch November 12, 2024 08:19
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants