Feature/monitoring guide #1796
Draft
Feature/monitoring guide #1796
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add complete step-by-step monitoring tutorial - Include Docker and build-from-source options for op-dispute-mon - Add 8 main steps with Steps component for better UX - Include Prometheus and Grafana setup with examples - Add alert rules and Alertmanager configuration - Include metrics reference for all components - Add troubleshooting section and production considerations - Update navigation in docs.json - Total: 1,238 lines with 40+ code examples
- Revise tutorial to focus on monitoring dispute games using op-dispute-mon - Update prerequisites and setup instructions for Docker and source builds - Enhance metrics collection and visualization sections with detailed examples - Include new metrics and monitoring architecture for better clarity - Streamline steps for deploying and verifying op-dispute-mon - Add comprehensive explanations for key metrics and their significance - Improve troubleshooting and production considerations for monitoring setup
- Fixed JSON formatting issues in docs.json to ensure proper structure. - Updated tutorial sections for better clarity and organization. - Enhanced navigation by ensuring all pages are correctly listed under their respective groups. - Streamlined the documentation layout for improved user experience.
❌ Deploy Preview for docs-optimism failed. Why did it fail? →
|
- Introduced a new service for the dispute monitor in the Docker Compose configuration. - Added setup instructions for the dispute monitor in the setup-rollup.sh script, including environment variable configuration. - Updated docs.json to include the monitoring chain tutorial for improved navigation. - Removed the obsolete optimism subproject to streamline the directory structure.
- Added new environment variables for the dispute monitor in the .env file. - Updated Docker Compose configuration to include the new environment variables and ensure proper service setup. - Modified setup-rollup.sh to retrieve addresses from the updated JSON structure and create a more comprehensive environment file for the dispute monitor. - Improved logging messages for better user guidance during setup.
- Replaced the monitoring chain tutorial with a new tutorial focused on op-dispute-setup. - Deleted the outdated monitoring-chain.mdx and monitoring-chain.mdx files to streamline documentation. - Updated docs.json to reflect the changes and improve navigation for users.
…eval and logging - Modified address retrieval commands to use the updated JSON structure for DisputeGameFactory, Proposer, and Challenger. - Enhanced Docker Compose configuration with new network and logging settings. - Improved logging output for better monitoring visibility during dispute game operations. - Removed outdated monitoring health checklist to streamline the tutorial.
- Introduced a new step titled "Monitor dispute game health" to enhance the tutorial. - This addition aims to provide users with guidance on monitoring the health of dispute games effectively.
- Corrected capitalization in the titles for "Dispute monitor tool reference" and "fault proof system" for consistency. - Removed an optional monitoring step to streamline the tutorial. - Enhanced clarity and readability of the tutorial content.
- Updated the tutorial to include a clear choice of deployment methods for the dispute monitor: Docker and building from source. - Improved step organization and clarity, ensuring users can easily follow the setup process. - Added detailed instructions for configuring and starting the dispute monitor, including environment variable setup and logging. - Enhanced the monitoring section with specific metrics to track and their significance for dispute game health. - Streamlined the content to remove redundancy and improve overall readability.
…nd usability - Consolidated deployment instructions for the op-dispute-mon, emphasizing Docker as the preferred method. - Enhanced step organization and clarity, particularly in the setup and verification sections. - Added detailed commands for starting the monitor and verifying its operation, including metrics checks. - Improved explanations of key metrics and their significance for monitoring dispute game health. - Removed redundant content to enhance overall readability and user experience.
- Streamlined the setup process for the op-dispute-mon, emphasizing Docker as the preferred deployment method. - Improved organization of steps, particularly in creating environment files and Docker Compose configurations. - Added detailed instructions for starting the monitor and verifying its operation, including metrics checks. - Clarified explanations of key metrics to aid users in monitoring dispute game health. - Removed redundant content to enhance overall readability and user experience.
- Eliminated unnecessary closing tags and steps to streamline the tutorial. - Improved overall clarity and flow of the content for better user experience.
…etric details - Changed title capitalization for consistency. - Enhanced the metrics section with clearer labels and descriptions for tracking dispute games. - Streamlined the monitoring instructions, emphasizing key metrics and their meanings. - Removed redundant content to improve overall readability and user experience.
…clarity - Capitalized the title for consistency. - Expanded the metrics section with additional commands for monitoring dispute games. - Improved the organization of the metrics information to enhance user understanding. - Streamlined content for better readability and user experience.
…nd clarity - Added explanations for tracking validity of claims and bond collateral. - Improved health check instructions with clearer commands and expected outputs. - Included a note for new testnet users regarding initial metric values. - Streamlined content for better readability and user experience.
…rics commands - Removed unnecessary commands related to metrics endpoint checks and bond collateral tracking. - Streamlined the content to focus on essential monitoring instructions for users. - Enhanced clarity by eliminating redundant information, improving overall readability.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Tests
Additional context
Metadata