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

feat: update grafana dashboard json, make dynamic datasource #332

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

onekill0503
Copy link

The dashboard was defined with static datasource , so it's you need to modify it manually if ur grafana was installed in different server. I've add new panel "Datasource" for user select their datasource, also make the other panel integrated with the datasource panel.

Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

📝 Walkthrough

Walkthrough

The Grafana dashboard configuration in monitoring/grafana/dashboards/default.json has been updated to replace hardcoded Prometheus datasource entries with a variable reference (${datasource}). A new templating section has been added that defines the datasource variable with a default value of "prometheus", allowing dynamic configuration for different environments.

Changes

File Change Summary
monitoring/grafana/dashboards/default.json Replaced hardcoded Prometheus datasource with a ${datasource} variable across multiple panels; added templating section for datasource configuration

Possibly related PRs

Suggested reviewers

  • karlprieb
  • djwhitt

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.

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.

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)
monitoring/grafana/dashboards/default.json (1)

1032-1045: Addition of Datasource Templating Variable

A new templating section now defines the ${datasource} variable with a default value of "prometheus". This is a clean and effective way to allow users to change the datasource dynamically without editing multiple panels.

Consider adding inline documentation or a comment in the dashboard JSON (or associated documentation) to explain how to adjust the datasource templating settings for less technical users.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bcaede7 and 171b3b6.

📒 Files selected for processing (1)
  • monitoring/grafana/dashboards/default.json (13 hunks)
🔇 Additional comments (10)
monitoring/grafana/dashboards/default.json (10)

25-25: Dynamic Datasource Update for Panel 1

The datasource field in this panel has been updated to reference the variable ${datasource} instead of a static value. This change complies with the PR objective of making the dashboard dynamic, and the implementation is clear and concise.


90-90: Dynamic Datasource Update for Panel 2

The datasource for this panel now uses ${datasource}. Verify that the new variable is correctly defined in the dashboard's templating section, and that any queries depending on this setting have been tested.


181-181: Dynamic Datasource Update for Panel 3

The datasource field here is now updated to ${datasource}. This change is consistent with the dynamic configuration goal. Please confirm that the associated queries function normally with the variable reference.


292-292: Dynamic Datasource Update for Panel 4

Updating the datasource to ${datasource} in this panel ensures consistency across your dashboard. It is recommended to verify that data retrieval remains unaffected when switching datasources dynamically.


401-401: Dynamic Datasource Update for Panel 5

The datasource has been parameterized with ${datasource}. Ensure that any panel-specific query configurations properly accommodate this dynamic reference and that no dependency on a static datasource remains.


545-545: Dynamic Datasource Update for Panel 6

The dynamic datasource reference ${datasource} is correctly applied here. Double-check that the default value defined later in the templating section (i.e. "prometheus") aligns with intended usage in production.


649-649: Dynamic Datasource Update for Panel 7

This panel now uses ${datasource} for its datasource setting. Although the change is straightforward, validation that all queries continue to function as expected with the variable is recommended.


742-742: Dynamic Datasource Update for Panel 8

The datasource field has been updated to the ${datasource} variable. Ensure that there are no conflicts with any other datasource-related settings in the dashboard.


838-838: Dynamic Datasource Update for Panel 9

The datasource here is now dynamically referenced as ${datasource}. This meets the PR requirement; just verify that the previous integrations (such as in query evaluations) are all operating correctly.


928-928: Dynamic Datasource Update for Panel 10

The datasource has been successfully replaced with ${datasource} in this panel. It’s important to ensure consistency in data source usage across the entire dashboard after this change.

@hlolli
Copy link
Contributor

hlolli commented Feb 20, 2025

these dashboards we have internally made with jsonnet/graphonnet. There's a chance we'll rather take that approach to dynamicism rather than javascript string manipulation of json. Let's see what other say :)

thanks for your PR! 🙏

@onekill0503
Copy link
Author

these dashboards we have internally made with jsonnet/graphonnet. There's a chance we'll rather take that approach to dynamicism rather than javascript string manipulation of json. Let's see what other say :)

thanks for your PR! 🙏

your welcome :) , just want to share what I faced before. It was cool if there's efficient way.

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