telegraf/plugins/outputs/prometheus_client
Sven Rebhan ac26d786fe
fix(outputs): Linter issues (#11595)
2022-08-03 07:20:51 -05:00
..
v1 fix(outputs): Linter issues (#11595) 2022-08-03 07:20:51 -05:00
v2 Linter fixes - gosimple (#9046) 2021-03-25 13:57:01 -04:00
README.md docs: remove recommendation for prometheus metric_version=2 (#11158) 2022-05-26 10:07:44 -06:00
prometheus_client.go chore: correctly spell embed (#11200) 2022-05-27 07:13:47 -06:00
prometheus_client_v1_test.go feat: migrate output plugins to new sample config format (#10910) 2022-04-07 15:55:03 -06:00
prometheus_client_v2_test.go feat: migrate output plugins to new sample config format (#10910) 2022-04-07 15:55:03 -06:00
sample.conf fix: Update sample.conf for prometheus (#11217) 2022-06-01 09:22:25 -06:00

README.md

Prometheus Output Plugin

This plugin starts a Prometheus Client, it exposes all metrics on /metrics (default) to be polled by a Prometheus server.

Configuration

# Configuration for the Prometheus client to spawn
[[outputs.prometheus_client]]
  ## Address to listen on.
  listen = ":9273"

  ## Metric version controls the mapping from Prometheus metrics into Telegraf metrics.
  ## See "Metric Format Configuration" in plugins/inputs/prometheus/README.md for details.
  ## Valid options: 1, 2
  # metric_version = 1

  ## Use HTTP Basic Authentication.
  # basic_username = "Foo"
  # basic_password = "Bar"

  ## If set, the IP Ranges which are allowed to access metrics.
  ##   ex: ip_range = ["192.168.0.0/24", "192.168.1.0/30"]
  # ip_range = []

  ## Path to publish the metrics on.
  # path = "/metrics"

  ## Expiration interval for each metric. 0 == no expiration
  # expiration_interval = "60s"

  ## Collectors to enable, valid entries are "gocollector" and "process".
  ## If unset, both are enabled.
  # collectors_exclude = ["gocollector", "process"]

  ## Send string metrics as Prometheus labels.
  ## Unless set to false all string metrics will be sent as labels.
  # string_as_label = true

  ## If set, enable TLS with the given certificate.
  # tls_cert = "/etc/ssl/telegraf.crt"
  # tls_key = "/etc/ssl/telegraf.key"

  ## Set one or more allowed client CA certificate file names to
  ## enable mutually authenticated TLS connections
  # tls_allowed_cacerts = ["/etc/telegraf/clientca.pem"]

  ## Export metric collection time.
  # export_timestamp = false

Metrics

Prometheus metrics are produced in the same manner as the prometheus serializer.