Skip to content

Latest commit

 

History

History
49 lines (41 loc) · 2.79 KB

cli-arguments.md

File metadata and controls

49 lines (41 loc) · 2.79 KB
Raw

Command line arguments

openshift-state-metrics can be configured through command line arguments.

Those arguments can be passed during startup when running locally:

openshift-state-metrics --telemetry-port=8081 --kubeconfig=<KUBE-CONFIG> --apiserver=<APISERVER> ...

Or configured in the args section of your deployment configuration in a Openshift context:

spec:
  template:
    spec:
      containers:
        - args:
          - '--telemetry-port=8081'
          - '--kubeconfig=<KUBE-CONFIG>'
          - '--apiserver=<APISERVER>'

Available options:

./openshift-state-metrics -h                                                                                                                                       [13:57:29]
Usage of ./openshift-state-metrics:
      --alsologtostderr                  log to standard error as well as files
      --apiserver string                 The URL of the apiserver to use as a master
      --collectors string                Comma-separated list of collectors to be enabled. Defaults to "buildconfigs,builds,clusterresourcequotas,deploymentConfigs,routes"
      --enable-gzip-encoding             Gzip responses when requested by clients via 'Accept-Encoding: gzip' header.
  -h, --help                             Print Help text
      --host string                      Host to expose metrics on. (default "0.0.0.0")
      --kubeconfig string                Absolute path to the kubeconfig file
      --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
      --log_dir string                   If non-empty, write log files in this directory
      --logtostderr                      log to standard error instead of files (default true)
      --metric-blacklist string          Comma-separated list of metrics not to be enabled. The whitelist and blacklist are mutually exclusive.
      --metric-whitelist string          Comma-separated list of metrics to be exposed. The whitelist and blacklist are mutually exclusive.
      --namespace string                 Comma-separated list of namespaces to be enabled. Defaults to ""
      --port int                         Port to expose metrics on. (default 80)
      --stderrthreshold severity         logs at or above this threshold go to stderr (default 2)
      --telemetry-host string            Host to expose openshift-state-metrics self metrics on. (default "0.0.0.0")
      --telemetry-port int               Port to expose openshift-state-metrics self metrics on. (default 81)
  -v, --v Level                          log level for V logs
      --version                          openshift-state-metrics build version information
      --vmodule moduleSpec               comma-separated list of pattern=N settings for file-filtered logging