/usr/bin/pmm-agent

usage: pmm-agent [<flags>] <command> [<args> ...]

Version 3.10.0


Flags:
  -h, --[no-]help                Show context-sensitive help (also try --help-long and --help-man)
      --config-file=</path/to/pmm-agent.yaml>
                                 Configuration file path [PMM_AGENT_CONFIG_FILE]
                                 ($PMM_AGENT_CONFIG_FILE)
      --config-file-key-file=CONFIG-FILE-KEY-FILE
                                 Path to the key file used to encrypt/decrypt the configuration file
                                 ($PMM_AGENT_CONFIG_FILE_KEY_FILE)
      --config-file-key-password=CONFIG-FILE-KEY-PASSWORD
                                 Password for the key file (if required)
                                 ($PMM_AGENT_CONFIG_FILE_KEY_PASSWORD)
      --id=ID                    ID of this pmm-agent [PMM_AGENT_ID] ($PMM_AGENT_ID)
      --listen-address=LISTEN-ADDRESS
                                 Agent local API address [PMM_AGENT_LISTEN_ADDRESS]
                                 ($PMM_AGENT_LISTEN_ADDRESS)
      --listen-port=LISTEN-PORT  Agent local API port [PMM_AGENT_LISTEN_PORT]
                                 ($PMM_AGENT_LISTEN_PORT)
      --runner-capacity=RUNNER-CAPACITY
                                 Agent internal actions/jobs runner capacity
                                 [PMM_AGENT_RUNNER_CAPACITY] ($PMM_AGENT_RUNNER_CAPACITY)
      --runner-max-connections-per-service=RUNNER-MAX-CONNECTIONS-PER-SERVICE
                                 Agent internal action/job runner connection limit per DB instance
                                 ($PMM_AGENT_RUNNER_MAX_CONNECTIONS_PER_SERVICE)
      --server-address=<host:port>
                                 PMM Server address [PMM_AGENT_SERVER_ADDRESS]
                                 ($PMM_AGENT_SERVER_ADDRESS)
      --server-username=SERVER-USERNAME
                                 Username to connect to PMM Server [PMM_AGENT_SERVER_USERNAME]
                                 ($PMM_AGENT_SERVER_USERNAME)
      --server-password=SERVER-PASSWORD
                                 Password to connect to PMM Server [PMM_AGENT_SERVER_PASSWORD]
                                 ($PMM_AGENT_SERVER_PASSWORD)
      --[no-]server-insecure-tls
                                 Skip PMM Server TLS certificate validation
                                 [PMM_AGENT_SERVER_INSECURE_TLS] ($PMM_AGENT_SERVER_INSECURE_TLS)
      --paths-base=PATHS-BASE    Base path for exporters/collectors/tools to use
                                 [PMM_AGENT_PATHS_BASE] ($PMM_AGENT_PATHS_BASE)
      --paths-exporters_base=PATHS-EXPORTERS_BASE
                                 Base path for exporters to use [PMM_AGENT_PATHS_EXPORTERS_BASE]
                                 ($PMM_AGENT_PATHS_EXPORTERS_BASE)
      --paths-node_exporter=PATHS-NODE_EXPORTER
                                 Path to node_exporter to use [PMM_AGENT_PATHS_NODE_EXPORTER]
                                 ($PMM_AGENT_PATHS_NODE_EXPORTER)
      --paths-mysqld_exporter=PATHS-MYSQLD_EXPORTER
                                 Path to mysqld_exporter to use [PMM_AGENT_PATHS_MYSQLD_EXPORTER]
                                 ($PMM_AGENT_PATHS_MYSQLD_EXPORTER)
      --paths-mongodb_exporter=PATHS-MONGODB_EXPORTER
                                 Path to mongodb_exporter to use [PMM_AGENT_PATHS_MONGODB_EXPORTER]
                                 ($PMM_AGENT_PATHS_MONGODB_EXPORTER)
      --paths-postgres_exporter=PATHS-POSTGRES_EXPORTER
                                 Path to postgres_exporter to use
                                 [PMM_AGENT_PATHS_POSTGRES_EXPORTER]
                                 ($PMM_AGENT_PATHS_POSTGRES_EXPORTER)
      --paths-proxysql_exporter=PATHS-PROXYSQL_EXPORTER
                                 Path to proxysql_exporter to use
                                 [PMM_AGENT_PATHS_PROXYSQL_EXPORTER]
                                 ($PMM_AGENT_PATHS_PROXYSQL_EXPORTER)
      --paths-azure_exporter=PATHS-AZURE_EXPORTER
                                 Path to azure_exporter to use [PMM_AGENT_PATHS_AZURE_EXPORTER]
                                 ($PMM_AGENT_PATHS_AZURE_EXPORTER)
      --paths-valkey-exporter=PATHS-VALKEY-EXPORTER
                                 Path to valkey_exporter to use [PMM_AGENT_PATHS_VALKEY_EXPORTER]
                                 ($PMM_AGENT_PATHS_VALKEY_EXPORTER)
      --paths-pt-summary=PATHS-PT-SUMMARY
                                 Path to pt summary to use [PMM_AGENT_PATHS_PT_SUMMARY]
                                 ($PMM_AGENT_PATHS_PT_SUMMARY)
      --paths-pt-pg-summary=PATHS-PT-PG-SUMMARY
                                 Path to pt-pg-summary to use [PMM_AGENT_PATHS_PT_PG_SUMMARY]
                                 ($PMM_AGENT_PATHS_PT_PG_SUMMARY)
      --paths-pt-mongodb-summary=PATHS-PT-MONGODB-SUMMARY
                                 Path to pt mongodb summary to use
                                 [PMM_AGENT_PATHS_PT_MONGODB_SUMMARY]
                                 ($PMM_AGENT_PATHS_PT_MONGODB_SUMMARY)
      --paths-pt-mysql-summary=PATHS-PT-MYSQL-SUMMARY
                                 Path to pt my sql summary to use [PMM_AGENT_PATHS_PT_MYSQL_SUMMARY]
                                 ($PMM_AGENT_PATHS_PT_MYSQL_SUMMARY)
      --paths-nomad=PATHS-NOMAD  Path to nomad binary. Can be overridden using
                                 [PMM_AGENT_PATHS_NOMAD] ($PMM_AGENT_PATHS_NOMAD)
      --paths-nomad-data-dir=PATHS-NOMAD-DATA-DIR
                                 Nomad data directory [PMM_AGENT_PATHS_NOMAD_DATA_DIR]
                                 ($PMM_AGENT_PATHS_NOMAD_DATA_DIR)
      --paths-tempdir=PATHS-TEMPDIR
                                 Temporary directory for exporters [PMM_AGENT_PATHS_TEMPDIR]
                                 ($PMM_AGENT_PATHS_TEMPDIR)
      --ports-min=PORTS-MIN      Minimal allowed port number for listening sockets
                                 [PMM_AGENT_PORTS_MIN] ($PMM_AGENT_PORTS_MIN)
      --ports-max=PORTS-MAX      Maximal allowed port number for listening sockets
                                 [PMM_AGENT_PORTS_MAX] ($PMM_AGENT_PORTS_MAX)
      --window-connected-time=WINDOW-CONNECTED-TIME
                                 Window time for which we track the status of connection between
                                 agent and server ($PMM_AGENT_WINDOW_CONNECTED_TIME)
      --log-level=LOG-LEVEL      Set logging level [PMM_AGENT_LOG_LEVEL] ($PMM_AGENT_LOG_LEVEL)
      --[no-]debug               Enable debug output [PMM_AGENT_DEBUG] ($PMM_AGENT_DEBUG)
      --[no-]trace               Enable trace output (implies debug) [PMM_AGENT_TRACE]
                                 ($PMM_AGENT_TRACE)
      --log-lines-count=1024     Take and return N most recent log lines in logs.zip
                                 for each: server, every configured exporters and agents
                                 [PMM_AGENT_LOG_LINES_COUNT] ($PMM_AGENT_LOG_LINES_COUNT)
      --perfschema-refresh-rate=PERFSCHEMA-REFRESH-RATE
                                 Change how often PMM scrapes data from Performance
                                 Schema (in seconds) [PMM_AGENT_PERFSCHEMA_REFRESH_RATE]
                                 ($PMM_AGENT_PERFSCHEMA_REFRESH_RATE)
      --[no-]json                Enable JSON output
  -v, --[no-]version             Show application version

Commands:
help [<command>...]
    Show help

run*
    Run pmm-agent (default command)

setup [<flags>] <node-address> [<node-type>] [<node-name>]
    Configure local pmm-agent