SigNoz / charts

Helm Charts for SigNoz
MIT License
77 stars 80 forks source link

feat: enable new logs schema by default #508

Closed prashant-shahi closed 1 month ago

prashant-shahi commented 1 month ago

Features

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces updates to the SigNoz Observability Platform Helm Chart, specifically modifying the Chart.yaml and values.yaml files. The version number of the chart is incremented from 0.53.0 to 0.53.1, while the queryService configuration is enhanced with a new command-line argument to utilize a new logging schema. Additionally, the otelCollector configuration is updated to reflect this new schema, ensuring consistency across the platform's logging capabilities.

Changes

File Change Summary
charts/signoz/Chart.yaml Version updated from 0.53.0 to 0.53.1.
charts/signoz/values.yaml queryService.additionalArgs updated to include --use-logs-new-schema=true; new option use_new_schema: true added under otelCollector.clickhouselogsexporter.

Possibly related PRs

Suggested reviewers

Poem

In the meadow where logs do flow,
A new schema helps us grow.
With a hop and a skip, we update the chart,
Versioning changes, a fresh start!
So let’s cheer for the code, let it gleam,
For the SigNoz team, we’re living the dream! 🐇✨


:scroll: Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
:inbox_tray: Commits Files that changed from the base of the PR and between fc4f0f401a070d79536f30ee3991e88503cc36d4 and 483fbf8fd65480bf84614512816a175be544c9dc.
:ledger: Files selected for processing (2) * charts/signoz/Chart.yaml (1 hunks) * charts/signoz/values.yaml (2 hunks)
:mute: Additional comments not posted (4)
charts/signoz/Chart.yaml (1)
`3-3`: **Version bump looks good.** The increment from 0.53.0 to 0.53.1 is appropriate for the described changes. It follows semantic versioning principles for a minor update. However, I noticed that the PR objectives mention enabling a new logs schema by default and removing a comment about delta preference in query-service. These changes are not reflected in this file. Could you please confirm if these changes are implemented in other files not provided for this review? To verify the implementation of the new logs schema and the removal of the delta preference comment, we can run the following script:
:white_check_mark: Verification successful **All changes have been verified and approved.** - Version updated to `0.53.1` in `charts/signoz/Chart.yaml`. - New logs schema enabled in `charts/signoz/values.yaml` with `--use-logs-new-schema=true`. - Delta preference comment successfully removed.
:checkered_flag: Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Search for new logs schema implementation and delta preference comment removal # Search for new logs schema implementation echo "Searching for new logs schema implementation:" rg --type yaml -i "logs.*schema" # Search for delta preference comment removal echo "Searching for delta preference comment removal:" rg --type yaml -i "delta.*preference" ``` Length of output: 339
charts/signoz/values.yaml (3)
Line range hint `1-1981`: **Summary: New logs schema enabled by default** The changes in this file consistently enable the new logs schema by default in both the query service and the OpenTelemetry Collector. This aligns well with the PR objectives and should improve the logging capabilities of SigNoz. Key points to consider: 1. Backward compatibility with existing log data and queries. 2. ClickHouse schema compatibility with the new log format. 3. Potential impact on log ingestion and querying performance. Overall, the changes look good, but thorough testing is recommended to ensure a smooth transition to the new schema. --- `1981-1981`: **LGTM. Verify ClickHouse schema compatibility.** The addition of `use_new_schema: true` to the ClickHouse logs exporter configuration is consistent with the PR objective and the previous change in the query service. This change looks good and should enable the new logs schema in the OpenTelemetry Collector. To ensure smooth operation with the new schema, please verify the ClickHouse schema compatibility: ```shell #!/bin/bash # Description: Check ClickHouse schema compatibility with the new logs schema # Test: Retrieve the current schema for the logs table in ClickHouse echo "Retrieving current ClickHouse schema for logs table:" clickhouse-client --host \${CLICKHOUSE_HOST} --port \${CLICKHOUSE_PORT} --user \${CLICKHOUSE_USER} --password \${CLICKHOUSE_PASSWORD} --query "DESCRIBE TABLE \${CLICKHOUSE_LOG_DATABASE}.logs" # Note: Manually review the output to ensure it matches the expected schema for the new logs format ``` --- `647-648`: **LGTM. Verify backward compatibility.** The addition of `--use-logs-new-schema=true` to the query service arguments aligns with the PR objective of enabling the new logs schema by default. This change looks good, but it's important to ensure that it doesn't break existing functionality or queries on older log data. To verify backward compatibility, you can run the following script:
--- 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?
:heart: 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)
:placard: Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.