OS Manuals

/usr/bin/buildkite-agent-metrics

Collects Buildkite agent and job queue metrics and publishes them to CloudWatch, StatsD, Prometheus, Stackdriver, New Relic or OpenTelemetry

From buildkite-agent-metrics 5.13.0-r1 (enterprise-packages), captured 2026-11-08 by running buildkite-agent-metrics --help (exit 0). permalink

Usage of /usr/bin/buildkite-agent-metrics:
  -backend string
    	Specify the backend to use: cloudwatch, newrelic, prometheus, stackdriver, statsd, opentelemetry (default "cloudwatch")
  -cloudwatch-dimensions string
    	Cloudwatch dimensions to index metrics under, in the form of Key=Value, Other=Value
  -cloudwatch-high-resolution
    	Send metrics at a high-resolution, which incurs extra costs
  -cloudwatch-region string
    	AWS Region to connect to, defaults to $AWS_REGION or us-east-1
  -debug
    	Show debug output
  -debug-http
    	Show full http traces
  -dry-run
    	Whether to only print metrics
  -endpoint string
    	A custom Buildkite Agent API endpoint (default "https://agent.buildkite.com/v3")
  -interval duration
    	Update metrics every interval, rather than once
  -max-idle-conns int
    	Maximum number of idle (keep-alive) HTTP connections for Buildkite Agent API. Zero means no limit, -1 disables connection reuse. (default 100)
  -newrelic-app-name string
    	New Relic application name for metric events
  -newrelic-license-key string
    	New Relic license key for publishing events
  -prometheus-addr string
    	Prometheus metrics transport bind address (default ":8080")
  -prometheus-include-default-metrics
    	Include Go runtime, process, and HTTP handler metrics in the Prometheus endpoint (default true)
  -prometheus-path string
    	Prometheus metrics transport path (default "/metrics")
  -queue value
    	Specific queues to process
  -quiet
    	Only print errors
  -stackdriver-projectid string
    	Specify Stackdriver Project ID
  -statsd-host string
    	Specify the StatsD server (default "127.0.0.1:8125")
  -statsd-tags
    	Whether your StatsD server supports tagging like Datadog
  -timeout int
    	Timeout, in seconds, TLS handshake and idle connections, for HTTP requests, to Buildkite API (default 15)
  -token value
    	Buildkite Agent registration tokens. At least one is required. Multiple cluster tokens can be used to gather metrics for multiple clusters.
  -version
    	Show the version
Options (23)
OptionDescriptionSource
-backend stringSpecify the backend to use: cloudwatch, newrelic, prometheus, stackdriver, statsd, opentelemetry (default "cloudwatch")help
-cloudwatch-dimensions stringCloudwatch dimensions to index metrics under, in the form of Key=Value, Other=Valuehelp
-cloudwatch-high-resolutionSend metrics at a high-resolution, which incurs extra costshelp
-cloudwatch-region stringAWS Region to connect to, defaults to $AWS_REGION or us-east-1help
-debugShow debug outputhelp
-debug-httpShow full http traceshelp
-dry-runWhether to only print metricshelp
-endpoint stringA custom Buildkite Agent API endpoint (default "https://agent.buildkite.com/v3")help
-interval durationUpdate metrics every interval, rather than oncehelp
-max-idle-conns intMaximum number of idle (keep-alive) HTTP connections for Buildkite Agent API.help
-newrelic-app-name stringNew Relic application name for metric eventshelp
-newrelic-license-key stringNew Relic license key for publishing eventshelp
-prometheus-addr stringPrometheus metrics transport bind address (default ":8080")help
-prometheus-include-default-metricsInclude Go runtime, process, and HTTP handler metrics in the Prometheus endpoint (default true)help
-prometheus-path stringPrometheus metrics transport path (default "/metrics")help
-queue valueSpecific queues to processhelp
-quietOnly print errorshelp
-stackdriver-projectid stringSpecify Stackdriver Project IDhelp
-statsd-host stringSpecify the StatsD server (default "127.0.0.1:8125")help
-statsd-tagsWhether your StatsD server supports tagging like Datadoghelp
-timeout intTimeout, in seconds, TLS handshake and idle connections, for HTTP requests, to Buildkite API (default 15)help
-token valueBuildkite Agent registration tokens.help
-versionShow the versionhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.