SigNoz / signoz-otel-collector

SigNoz distro for OpenTelemetry Collector
43 stars 39 forks source link

Do not replace service.instance.id from SDK #289

Closed srikanthccv closed 7 months ago

srikanthccv commented 7 months ago

Fixes https://github.com/SigNoz/signoz-otel-collector/issues/283 Fixes https://github.com/SigNoz/signoz/issues/4338

In the past, we created our own ID signoz.collector.id for the uniqueness guarantees and then moved to use the service.instance.id from the collector TelemetrySettings. This conflicts with the service.instance.id coming from the Client SDK with the signoz-otel-collector. Users want to see their instance instead of the SigNoz deployment under the service.instance.id attribute. This is a reasonable ask. We will honour their settings and maintain our own attribute signoz.collector.id as we did earlier.

Summary by CodeRabbit

coderabbitai[bot] commented 7 months ago

[!WARNING]

Rate Limit Exceeded

@srikanthccv has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 3 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between b531173042168c448b59dc6ddc4a1226549c9472 and 02509073c8e017402575bdf8ee6816681ca555d1.

Walkthrough

This change focuses on modifying how instance IDs are handled within the aggregateMetrics function. Specifically, it replaces the usage of semconv.AttributeServiceInstanceID with a custom signozID, aiming to address issues related to the display of service instance IDs in the Signoz backend. This adjustment is intended to ensure that the specified name for service.instance.id is accurately reflected, rather than appearing as a hex encoded string.

Changes

File Change Summary
.../signozspanmetricsprocessor/processor.go Replaced semconv.AttributeServiceInstanceID with signozID in aggregateMetrics function

Assessment against linked issues

Objective Addressed Explanation
Correct display of service.instance.id as specified name instead of hex string (#283, #4338)
Ensure service.instance.id value is accurately reflected in Signoz backend (#283, #4338)

Poem

In the realm of code, where bugs like to hide, A rabbit hopped in, with a mission wide. With a leap and a bound, it tackled the task, Replacing a string, no questions to ask.

🐰 "Fear not," it said, "for I bring a fix, To make instance IDs as solid as bricks." Now in Signoz, the names do appear, Thanks to the rabbit, we cheer and revere!

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

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 .` - `Generate unit-tests for this file.` - 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 tests 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 from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.