Skip to main content

Coroot-cluster-agent

Coroot-cluster-agent connects to Coroot to receive configuration and collects cluster-level telemetry data, including metrics from databases, Kubernetes state metrics, and Kubernetes events.

Cluster Agent Configuration

You can configure coroot-cluster-agent using command-line flags or environment variables.

FlagEnv VariableDefaultDescription
--listenLISTEN127.0.0.1:10301Listen address - ip:port or :port
--coroot-urlCOROOT_URLCoroot URL (required)
--api-keyAPI_KEYCoroot API key
--config-update-intervalCONFIG_UPDATE_INTERVAL60sInterval between configuration updates from Coroot
--config-update-timeoutCONFIG_UPDATE_TIMEOUT10sTimeout for configuration update requests
--metrics-scrape-intervalMETRICS_SCRAPE_INTERVALInterval between metrics scrapes
--metrics-scrape-timeoutMETRICS_SCRAPE_TIMEOUT10sTimeout for metrics scrape requests
--metrics-wal-dirMETRICS_WAL_DIR/tmpDirectory for the metrics write-ahead log
--profiles-scrape-intervalPROFILES_SCRAPE_INTERVAL60sInterval between profiling scrapes
--profiles-scrape-timeoutPROFILES_SCRAPE_TIMEOUT10sTimeout for profiling scrape requests
--kube-state-metrics-listen-addressKUBE_STATE_METRICS_LISTEN_ADDRESS127.0.0.1:10303Listen address for the kube-state-metrics endpoint
--insecure-skip-verifyINSECURE_SKIP_VERIFYfalseSkip TLS certificate verification
--collect-kubernetes-eventsCOLLECT_KUBERNETES_EVENTStrueCollect and forward Kubernetes events
--track-database-changesTRACK_DATABASE_CHANGEStrueTrack schema and settings changes in databases
--track-database-sizesTRACK_DATABASE_SIZEStrueCollect per-database and per-table size metrics
--max-tables-per-databaseMAX_TABLES_PER_DATABASE1000Skip databases with more tables than this limit
--exclude-databasesEXCLUDE_DATABASESpostgres,mysql,information_schema,performance_schema,sysDatabases to exclude from schema and size tracking (applies to both PostgreSQL and MySQL). MongoDB system databases (admin, config, local) are always excluded regardless of this setting.
Looking for 24/7 support from the Coroot team? Subscribe to Coroot Enterprise:Start free trial