ethereum-optimism/monitorism

- [Monitorism](#monitorism) - [Docker Images](#docker-images) - [Monitor Components](#monitors-components) - [Global Events Monitor](#global-events-monitor) - [Liveness Expiration Monitor](#liveness-expiration-monitor) - [Withdrawals Monitor](#withdrawals-monitor) - [Balances Monitor](#balances-monitor) - [Fault Monitor](#fault-monitor) - [Multisig Monitor](#multisig-monitor) - [Drippie Monitor](#drippie-monitor) - [Secrets Monitor](#secrets-monitor) - [Transaction Monitor](#transaction-monitor) - [ETH Conservation Monitor](#eth-conservation-monitor) - [Faultproof Withdrawals](#faultproof-withdrawal) - [Defender Components](#defender-components) - [HTTP API PSP Executor Service](#http-api-psp-executor-service) - [CLI & Docs](#cli--docs) - [Bootstrap](#bootstrap) - [Command line Options](#command-line-options) # 监控主义 _Monitorism_ is a tooling suite that supports monitoring and active remediation actions for the OP Stack chain. The suite is composed of two main components: `op-monitorism` and `op-defender`, that can be used together or separately and see below for more details. ## Docker 镜像 ### 操作监控主义 Op-Monitorism Docker images are published with each release and build, ensuring you have access to the latest features and fixes. The latest release version for linux/amd64 can be found in the [release notes](https://github.com/ethereum-optimism/monitorism/releases) To pull the latest Docker image, run: ``` docker pull --platform linux/amd64 us-docker.pkg.dev/oplabs-tools-artifacts/images/op-monitorism:latest ``` To pull a specific release version ``` docker pull --platform linux/amd64 us-docker.pkg.dev/oplabs-tools-artifacts/images/op-monitorism:v0.0.4 ``` Note: The --platform flag is necessary for Mac computers with ARM chips to ensure compatibility with the linux/amd64 architecture. To build the Docker image locally, execute the following command: ``` docker build -t op-monitorism ./op-monitorism ``` Use "-t op-monitorism" to tag the image with the name op-monitorism for easier reference. ## 监控组件 The `monitors` are passive security services that provide automated monitoring for the OP Stack. There are components that are designed to make monitoring of the OP stack and alerting on specific events, that could be a sign of a security incident. The list of all the monitors currently built into `op-monitorism` is below. ### 全局事件监控  The Global Events Monitor is made for to taking YAML rules as configuration and monitoring the events that are emitted on the chain. | `op-monitorism/global_events` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/global_events/README.md) | | ----------------------------- | --------------------------------------------------------------------------------------------------------- | ### 活跃性过期监控  The Liveness Expiration Monitor is made for monitoring the liveness expiration on Safes. | `op-monitorism/liveness_expiration` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/liveness_expiration/README.md) | | ----------------------------------- | --------------------------------------------------------------------------------------------------------------- | ### 提款监控  The withdrawals monitor checks for new withdrawals that have been proven to the `OptimismPortal` contract. Each withdrawal is checked against the `L2ToL1MessagePasser` contract. | `op-monitorism/withdrawals` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/withdrawals/README.md) | | --------------------------- | ------------------------------------------------------------------------------------------------------- | ### 余额监控  The balances monitor simply emits a metric reporting the balances for the configured accounts. | `op-monitorism/balances` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/balances/README.md) | | ------------------------ | ---------------------------------------------------------------------------------------------------- | ### 故障监控 The fault monitor checks for changes in output roots posted to the `L2OutputOracle` contract. On change, reconstructing the output root from a trusted L2 source and looking for a match. | `op-monitorism/fault` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/fault/README.md) | | --------------------- | ------------------------------------------------------------------------------------------------- | ### 多重签名监控  The multisig monitor reports the paused status of the `OptimismPortal` contract. If set, the latest nonce of the configured `Safe` address. And also if set, the latest presigned nonce stored in One Password. The latest presigned nonce is identified by looking for items in the configured vault that follow a `ready-.json` name. The highest nonce of this item name format is reported. | `op-monitorism/multisig` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/multisig/README.md) | | ------------------------ | ---------------------------------------------------------------------------------------------------- | ### Drippie 监控 The drippie monitor tracks the execution and executability of drips within a Drippie contract. | `op-monitorism/drippie` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/drippie/README.md) | | ----------------------- | --------------------------------------------------------------------------------------------------- | ### 密钥监控 The secrets monitor takes a Drippie contract as a parameter and monitors for any drips within that contract that use the CheckSecrets dripcheck contract. CheckSecrets is a dripcheck that allows a drip to begin once a specific secret has been revealed (after a delay period) and cancels the drip if a second secret is revealed. It's important to monitor for these secrets being revealed as this could be a sign that the secret storage platform has been compromised and someone is attempting to exfiltrate the ETH controlled by that drip. | `op-monitorism/secrets` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/secrets/README.md) | | ----------------------- | --------------------------------------------------------------------------------------------------- | ### 交易监控 The transaction monitor takes in a yaml config in order to run, and monitors transaction sent by a specific address, tracking both cumulative eth sent, as well as tunable thresholds for specific alerts. It is also configurable to support working against factory, right now just the `FaultDisputeGame` factory to ensure the addresses are only interacting with valid fault dispute games. | `op-monitorism/transaction_monitor` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/transaction_monitor/README.md) | | ----------------------------------- | --------------------------------------------------------------------------------------------------------------- | ### ETH 保护监控 The ETH conservation monitor traces L2 blocks and asserts that they adhere to the L2 ETH conservation invariant. | `op-monitorism/conservation_monitor` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/conservation_monitor/README.md) | | ----------------------------------- | --------------------------------------------------------------------------------------------------------------- | ### 故障证明提款 The Faultproof Withdrawal component monitors ProvenWithdrawals events on the [OptimismPortal](https://github.com/ethereum-optimism/superchain-registry/blob/d454618b6cf885417aa8cc8c760bd9ed0429c131/superchain/configs/mainnet/op.toml#L50) contract and performs checks to detect any violations of invariant conditions on the chain. If a violation is detected, it logs the issue and sets a Prometheus metric for the event. This component is designed to work exclusively with chains that are already utilizing the [Fault Proofs system](https://docs.optimism.io/stack/protocol/fault-proofs/explainer). This is a new version of the deprecated [chain-mon faultproof-wd-mon](https://github.com/ethereum-optimism/optimism/tree/chain-mon/v1.2.1/packages/chain-mon/src/faultproof-wd-mon). For detailed information on how the component works and the algorithms used, please refer to the component README. | `op-monitorism/faultproof_withdrawals` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/faultproof_withdrawals/README.md) | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ## 防御者组件 The _defenders_ are active security service allowing to provide automated defense for the OP Stack. There are components that are designed to make immediate actions onchain/offchain to protect the assets. The list of all the defender currently built into `op-defender` is below. ### HTTP API PSP 执行服务  The PSP Executor Service is made for executing PSP onchain faster to increase our readiness and speed in case of incident response. | `op-defender/psp_executor` | [README](https://github.com/ethereum-optimism/monitorism/blob/main/op-defender/psp_executor/README.md) | | -------------------------- | ------------------------------------------------------------------------------------------------------ | ## CLI 与文档 ### 引导 After cloning, please run `./bootstrap.sh` to set up the development environment correctly. ### 命令行选项 The cli has the ability to spin up a monitor for varying activities, each emitting metrics used to setup alerts. ``` COMMANDS: multisig Monitors OptimismPortal pause status, Safe nonce, and Pre-Signed nonce stored in 1Password fault Monitors output roots posted on L1 against L2 withdrawals Monitors proven withdrawals on L1 against L2 balances Monitors account balances drippie Monitors Drippie contract secrets Monitors secrets revealed in the CheckSecrets dripcheck global_events Monitors global events with YAML configuration liveness_expiration Monitor the liveness expiration on Gnosis Safe. faultproof_withdrawals Monitors withdrawals on the OptimismPortal in order to detect forgery. Note: Requires chains with Fault Proofs. version Show version help, h Shows a list of commands or help for one command ``` Each monitor has some common configuration, configurable both via cli or env with defaults. ``` OPTIONS: --log.level value [$MONITORISM_LOG_LEVEL] The lowest log level that will be output (default: INFO) --log.format value [$MONITORISM_LOG_FORMAT] Format the log output. Supported formats: 'text', 'terminal', 'logfmt', 'json', 'json-pretty', (default: text) --log.color [$MONITORISM_LOG_COLOR] Color the log output if in terminal mode (default: false) --metrics.enabled [$MONITORISM_METRICS_ENABLED] Enable the metrics server (default: false) --metrics.addr value [$MONITORISM_METRICS_ADDR] Metrics listening address (default: "0.0.0.0") --metrics.port value [$MONITORISM_METRICS_PORT] Metrics listening port (default: 7300) --loop.interval.msec value [$MONITORISM_LOOP_INTERVAL_MSEC] Loop interval of the monitor in milliseconds (default: 60000) ```

标签：Bootstrap, Docker, ETH 监控, EVTX分析, HTTP API, Liveness 监控, NIDS, OP Stack, Optimism, Withdrawals 监控, 主动响应, 交易监控, 代理支持, 以太坊, 余额监控, 区块链监控, 可视化界面, 告警, 多引擎聚合, 多重签名监控, 安全防御评估, 容器化, 开源监控, 故障监控, 文档, 文档结构分析, 日志审计, 活度监控, 监控, 监控系统, 请求拦截, 逆向工具, 链上监控