Skip to content

chore: Add hostname as common attr on all spans#35388

Merged
dvj1988 merged 1 commit intoreleasefrom
chore/add-domain-telemetry
Aug 4, 2024
Merged

chore: Add hostname as common attr on all spans#35388
dvj1988 merged 1 commit intoreleasefrom
chore/add-domain-telemetry

Conversation

@dvj1988
Copy link

@dvj1988 dvj1988 commented Aug 4, 2024

Description

Some of the self hosted instances are sending data with the entitiy.name as Appsmith Production OTLP. Therefore we need another attribute to slice all the cloud data and hostname will be unique to each instance.

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="@tag.Sanity"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10234910845
Commit: b616a08
Cypress dashboard.
Tags: @tag.Sanity
Spec:


Sun, 04 Aug 2024 09:13:54 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Enhanced telemetry data by adding a new hostname property, improving tracking and analysis of telemetry events based on the specific web page host.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 4, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent changes enhance the telemetry capabilities of the application by adding a hostname property to the telemetry attributes. This new property, derived from window.location.hostname, allows for improved tracking and analysis of telemetry events according to their originating host. This update enriches the data collected without affecting existing functionalities, offering valuable insights into user interactions across different host environments.

Changes

Files Change Summary
app/client/src/UITelemetry/generateTraces.ts Introduced a new hostname property in getCommonTelemetryAttributes, capturing the current web page's hostname for enhanced telemetry data.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Telemetry

    Client->>Telemetry: Request telemetry attributes
    Telemetry->>Client: Return common telemetry attributes with hostname
Loading

🎉 In the world of code, changes unfold,
A hostname added, a story told.
Tracing the paths where users roam,
In data rich, we find our home.
Celebrate the tweaks, let metrics gleam,
In the land of telemetry, we dare to dream! 🌟


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@dvj1988 dvj1988 changed the title chore: Add domain as common attr on all spans chore: Add hostname as common attr on all spans Aug 4, 2024
@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Aug 4, 2024
@dvj1988 dvj1988 added the ok-to-test Required label for CI label Aug 4, 2024
@dvj1988 dvj1988 enabled auto-merge (squash) August 4, 2024 08:49
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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 964fb0e and b616a08.

Files selected for processing (1)
  • app/client/src/UITelemetry/generateTraces.ts (1 hunks)
Additional comments not posted (1)
app/client/src/UITelemetry/generateTraces.ts (1)

45-45: Good job adding the hostname attribute!

The addition of the hostname property to the telemetry attributes is a valuable enhancement for tracking and analysis. Ensure that this change is thoroughly tested to confirm that it correctly captures the hostname and does not introduce any issues.

@dvj1988 dvj1988 merged commit 7adb33d into release Aug 4, 2024
@dvj1988 dvj1988 deleted the chore/add-domain-telemetry branch August 4, 2024 09:22
@coderabbitai coderabbitai bot mentioned this pull request Mar 21, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Required label for CI 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