Create chain-monitoring.mdx

[cpengilly]

[netlify[bot]]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	0099edda38be1a7544904417fe8ea860623910c3
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/670408d565f4be00082e26b1
😎 Deploy Preview	https://deploy-preview-764--docs-optimism.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[sbvegan]

Here's some helpful context on dispute-mon

• Other Useful Notes

  • op-dispute-mon is set up to be built and run the same way as the op-challenger. Just make op-dispute-mon in its directory.

  • Since op-dispute-mon inherits the same metrics + logging configuration, the config from above can be used with an OP_DISPUTE_MON prefix.

  • A potential configuration for this chain could look like the following

    OP_DISPUTE_MON_LOG_FORMAT=logfmt
    OP_DISPUTE_MON_METRICS_ENABLED=true
    OP_DISPUTE_MON_METRICS_ADDR=0.0.0.0
    OP_DISPUTE_MON_METRICS_PORT=7300
    
    OP_DISPUTE_MON_L1_ETH_RPC=..
    OP_DISPUTE_MON_ROLLUP_RPC=..
    OP_DISPUTE_MON_GAME_FACTORY_ADDRESS=..
    
    OP_DISPUTE_MON_HONEST_ACTORS=..
    

    Where OP_DISPUTE_MON_HONEST_ACTORS is a CSV (no spacing) list of addresses that are used for the honest op-challenger instance(s).

    Note, you may also ignore specific game instances with OP_DISPUTE_MON_IGNORED_GAMES, though you shouldn’t have to do this.

  • Additional Flags

    • OP_DISPUTE_MON_GAME_WINDOW: This is the window of time to report on games. It should leave a buffer beyond the max game duration for bond claiming. If Fault Proof game parameters are not changes (e.g. MAX_CLOCK_DURATION), it is recommended to leave this as the default.
    • OP_DISPUTE_MON_MONITOR_INTERVAL: The interval at which to check for new games. Defaults to 30 seconds currently.
    • OP_DISPUTE_MON_MAX_CONCURRENCY: The max thread count. Defaults to 5 currently.

[sbvegan]

This PR addresses: https://github.com/ethereum-optimism/docs/issues/345

[coderabbitai[bot]]

[!WARNING]

Rate limit exceeded

@bradleycamacho has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 48 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 for further information.

📥 Commits

Files that changed from the base of the PR and between 4f393f0b701baf00b9004608bd3f6c47904b4d45 and 0099edda38be1a7544904417fe8ea860623910c3.

Walkthrough

The pull request introduces a new key-value pair in the _meta.json file, adding "chain-monitoring": "Chain Monitoring". Additionally, a new documentation file, chain-monitoring.mdx, is created, providing an extensive guide on monitoring options for OP Stack chains, covering both onchain and offchain services and tools.

Changes

File Path	Change Summary
pages/builders/chain-operators/tools/_meta.json	Added key "chain-monitoring": "Chain Monitoring" to the JSON object.
pages/builders/chain-operators/tools/chain-monitoring.mdx	New file created with a guide on monitoring options for OP Stack chains, including onchain and offchain services.

Possibly related PRs

• #759: The changes in this PR involve updates to the documentation for op-challenger, which is related to monitoring and operational aspects similar to the new chain-monitoring documentation introduced in the main PR.
• #818: This PR adds a new key-value pair for op-conductor in the _meta.json file, which is relevant as it relates to the overall structure and configuration of tools, similar to the changes made in the main PR's _meta.json file.

Suggested reviewers

• sbvegan
• ajsutton

---

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
• Mastodon
• Reddit
• LinkedIn

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

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.

[bradleycamacho]

@krofax mind giving this a review?

[krofax]

LGTM