docs: Adds more panels to grafana dashboards #4540

evenyag · 2024-08-09T12:40:59Z

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

This PR adds more panels to our grafana dashboards.

For the standalone dashboard

HTTP request rate
Cache size
Cache hit rate
WAL store sync duration

For the cluster dashboard

Cache size
Cache hit rate
Query stage elapsed time
Write stall

It fixes some issues with the standalone dashboard:

replaces all hard-coded rate intervals ([2s]) with $__rate_interval, otherwise many panels don't work well if the scrape is larger than 2s
fixes the write stall count panel
uses uppercase titles

For cluster dashboard:

renames greptime_pod to instance as we don't always have the greptime_pod label
export externally (The previous dashboard json is exported for internal use)

Checklist

I have written the necessary rustdoc comments.
I have added the necessary unit tests and integration tests.
This PR requires documentation updates.

Summary by CodeRabbit

New Features
- Enhanced Grafana dashboard with updated metric expressions for improved data accuracy.
- Modified panel titles for better clarity on displayed metrics.
- Introduced new metrics and restructured the dashboard layout for optimized monitoring.
Bug Fixes
- Corrected legend formats to show specific instance names instead of automatic labels.
Documentation
- Improved insights and actionable data presentation in the monitoring system.

coderabbitai · 2024-08-09T12:41:05Z

Important

Review skipped

Auto reviews are disabled on this repository.

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 modifications to the Grafana dashboard configuration significantly enhance monitoring capabilities. Key updates include changes in metric expressions to reflect revised time intervals, improvements to panel titles for clarity, and a refined layout that emphasizes relevant data. New metrics were added, and redundant panels removed, leading to a more structured and informative dashboard experience.

Changes

Files	Change Summary
`grafana/greptimedb.json`	Updated metric expressions, panel titles, and layout; added new metrics and refined legend formats for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Grafana
    participant DataSource

    User->>Grafana: Request Dashboard
    Grafana->>DataSource: Fetch Metrics
    DataSource-->>Grafana: Return Metrics
    Grafana->>User: Display Updated Dashboard

🐰 In the garden of graphs I hop,
With metrics dancing, never stop!
From CPU rates to HTTP calls,
My dashboard gleams, it never falls.
New panels bloom, old ones fade,
A clearer view, my joy displayed! 🌼📊

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.

waynexia · 2024-08-09T14:02:52Z

What are "more panels"? You basically write no description

fengjiachun · 2024-08-09T15:57:15Z

5741 / 1000 = 5 red envelops

killme2008

LGTM

evenyag · 2024-08-12T03:13:34Z

@coderabbitai summary

coderabbitai · 2024-08-12T03:13:38Z

Actions performed

Summary regeneration triggered.

evenyag · 2024-08-12T04:51:53Z

What are "more panels"? You basically write no description

Someone @waynexia urged me to have dinner with them on Friday, so I didn't have enough time to write the description.

I'm going to further adjust the cluster dashboard so I will convert this PR to draft again.

* docs: update standalone grafana * docs: add more panels to grafana dashboards * docs: replace source name * docs: bump dashboard version * docs: update hit rate expr * docs: greptime_pod to instance, add panels for cache

evenyag added 3 commits August 9, 2024 17:57

docs: update standalone grafana

039d187

docs: add more panels to grafana dashboards

3e5aaa1

docs: replace source name

f44df7f

github-actions bot added the docs-not-required This change does not impact docs. label Aug 9, 2024

Merge branch 'main' into docs/update-grafana

d2c40a3

evenyag marked this pull request as ready for review August 9, 2024 13:38

evenyag requested a review from a team as a code owner August 9, 2024 13:38

killme2008 approved these changes Aug 10, 2024

View reviewed changes

docs: bump dashboard version

99e982d

evenyag marked this pull request as draft August 12, 2024 04:52

evenyag added 2 commits August 13, 2024 13:45

docs: update hit rate expr

cda08ed

docs: greptime_pod to instance, add panels for cache

2203536

shuiyisong approved these changes Aug 13, 2024

View reviewed changes

Merge branch 'main' into docs/update-grafana

1a85e43

evenyag marked this pull request as ready for review August 13, 2024 06:25

evenyag added this pull request to the merge queue Aug 13, 2024

Merged via the queue into GreptimeTeam:main with commit 72a1732 Aug 13, 2024
17 checks passed

evenyag deleted the docs/update-grafana branch August 13, 2024 06:55

evenyag mentioned this pull request Aug 13, 2024

docs: update grafana readme #4550

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Adds more panels to grafana dashboards #4540

docs: Adds more panels to grafana dashboards #4540

evenyag commented Aug 9, 2024 •

edited

Loading

coderabbitai bot commented Aug 9, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

waynexia commented Aug 9, 2024

fengjiachun commented Aug 9, 2024

killme2008 left a comment

evenyag commented Aug 12, 2024

coderabbitai bot commented Aug 12, 2024

evenyag commented Aug 12, 2024 •

edited

Loading

docs: Adds more panels to grafana dashboards #4540

docs: Adds more panels to grafana dashboards #4540

Conversation

evenyag commented Aug 9, 2024 • edited Loading

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Checklist

Summary by CodeRabbit

coderabbitai bot commented Aug 9, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

waynexia commented Aug 9, 2024

fengjiachun commented Aug 9, 2024

killme2008 left a comment

Choose a reason for hiding this comment

evenyag commented Aug 12, 2024

coderabbitai bot commented Aug 12, 2024

evenyag commented Aug 12, 2024 • edited Loading

evenyag commented Aug 9, 2024 •

edited

Loading

coderabbitai bot commented Aug 9, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

evenyag commented Aug 12, 2024 •

edited

Loading