Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Configuration Overview

Argus is configured primarily through a set of YAML files. By default, the application looks for these files in a configs/ directory in the current working directory. You can specify a different directory using the --config-dir <path> command-line argument.

The configuration is split into three key files:

  1. app.yaml: Contains global application settings, such as RPC endpoints, database connections, and performance tuning parameters. This is the main configuration for the Argus service itself.

  2. monitors.yaml: This is where you define what you want to monitor on the blockchain. Each monitor specifies a network, an optional contract address, and a Rhai filter script that determines if a transaction or log is a match.

  3. actions.yaml: This file defines how you want to further submit data when a monitor finds a match. You can configure various notification channels (e.g., webhooks) and set policies like throttling or send data to a queue (Kafka, NATS, etc.).

Select a topic below for a detailed breakdown of each file and its parameters.