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

docs: add new otel links and grafana #1788

Merged
merged 3 commits into from
Nov 25, 2024
Merged

docs: add new otel links and grafana #1788

merged 3 commits into from
Nov 25, 2024

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Nov 8, 2024

Overview

Summary by CodeRabbit

  • Documentation
    • Updated metrics endpoint examples for Celestia node in the guide.
    • Enhanced clarity and context in the Mainnet Beta documentation, including network stability, blob size parameters, and updated Grafana dashboard link.
    • Provided structured guidance on connecting to Mainnet Beta with node types and RPC endpoints.

Copy link
Contributor

coderabbitai bot commented Nov 8, 2024

Walkthrough

The pull request includes updates to two documentation files related to the Celestia node metrics and Mainnet Beta. The changes primarily involve modifying endpoint URLs for the metrics configurations in the celestia-node-metrics.md file and enhancing the clarity and detail of the mainnet.md document. The updates aim to provide users with current information regarding network parameters, stability, and monitoring resources.

Changes

File Change Summary
how-to-guides/celestia-node-metrics.md Updated metrics endpoint URLs for Mocha testnet (otel.celestia-mocha.com to otel.mocha.celestia.observer) and added a new section for Arabica devnet with example command for metrics.
how-to-guides/mainnet.md Refined introduction, clarified network stability, expanded network parameters, updated Grafana dashboard link, and reiterated warnings about community endpoints.

Possibly related PRs

Suggested labels

documentation, enhancement

🐇 In the land of Celestia, bright and bold,
Metrics now shine with stories told.
From Mainnet to Mocha, the endpoints align,
With clearer paths for all to find.
So hop along, dear friends, don’t delay,
The guides are updated, come join the play! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 02f8cb8 and 216e494.

📒 Files selected for processing (1)
  • how-to-guides/mainnet.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • how-to-guides/mainnet.md

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 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

github-actions bot commented Nov 8, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1788/
on branch main at 2024-11-25 15:41 UTC

@jcstein
Copy link
Member Author

jcstein commented Nov 12, 2024

gm are these links ready yet @celestiaorg/devops ?

@jcstein jcstein requested a review from sysrex November 12, 2024 04:54
@jcstein
Copy link
Member Author

jcstein commented Nov 18, 2024

should this dashboard be populated yet? is this good to merge? cc: @sysrex

https://grafana.celestia.dev/d/caaeabfb-33c5-45fd-b5e9-867f5f34ad57/public-bootstrappers?orgId=1

@jcstein jcstein self-assigned this Nov 18, 2024
@jcstein jcstein marked this pull request as ready for review November 20, 2024 10:05
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

🧹 Outside diff range and nitpick comments (1)
how-to-guides/celestia-node-metrics.md (1)

Line range hint 41-51: Consider adding Grafana dashboard links

Since this PR includes Grafana-related changes (as mentioned in the PR objectives) and there's a reference to viewing metrics on a Grafana dashboard, consider adding a link to the Grafana dashboard (https://grafana.celestia.dev/d/caaeabfb-33c5-45fd-b5e9-867f5f34ad57/public-bootstrappers) in this documentation.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4cdf60a and 876a7e4.

📒 Files selected for processing (2)
  • how-to-guides/celestia-node-metrics.md (2 hunks)
  • how-to-guides/mainnet.md (1 hunks)
🔇 Additional comments (3)
how-to-guides/celestia-node-metrics.md (2)

41-41: Verify the new Mainnet Beta metrics endpoint

Please confirm that otel.lunar.celestia.dev is the correct and active endpoint for Mainnet Beta metrics collection.


51-51: Verify the new Mocha testnet metrics endpoint

Please confirm that otel.mocha.celestia.dev is the correct and active endpoint for Mocha testnet metrics collection.

how-to-guides/mainnet.md (1)

253-253: Verify Grafana dashboard functionality and enhance context

The Grafana dashboard link has been updated, but there are a few considerations:

  1. Based on the PR comments, please verify if this dashboard is ready for public access and properly populated with data.
  2. Consider adding a brief description of what metrics users can expect to see in this dashboard to set proper expectations.

Consider adding context like this:

-[Grafana dashboard](https://grafana.celestia.dev/d/caaeabfb-33c5-45fd-b5e9-867f5f34ad57/public-bootstrappers?orgId=1&refresh=5s)
+[Grafana dashboard](https://grafana.celestia.dev/d/caaeabfb-33c5-45fd-b5e9-867f5f34ad57/public-bootstrappers?orgId=1&refresh=5s) 
+which displays key metrics such as uptime, response times, and health status of the DA bootstrapper nodes

@aWN4Y25pa2EK
Copy link

The otel external endpoints for prometheus telemetry should be these:

  1. otel.celestia.observer - Celestia (Mainnet)
  2. otel.arabica.celestia.observer - Arabica
  3. otel.mocha.celestia.observer - Mocha

how-to-guides/mainnet.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sysrex sysrex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@jcstein jcstein merged commit 3718007 into main Nov 25, 2024
6 checks passed
@jcstein jcstein deleted the jcs/update-grafana branch November 25, 2024 16:23
@coderabbitai coderabbitai bot mentioned this pull request Nov 27, 2024
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.

3 participants