ContextQMD
Back to Telegraf

GrayLog Input Plugin

plugins/inputs/graylog/README.md

1.38.32.4 KB
Original Source

GrayLog Input Plugin

This plugin collects data from Graylog servers, currently supporting two type of end points multiple (e.g. http://<host>:9000/api/system/metrics/multiple) and namespace (e.g. http://<host>:9000/api/system/metrics/namespace/{namespace}).

Multiple endpoint can be queried and mixing multiple and serveral namespace end points is possible. Check http://<host>:9000/api/api-browser for the full list of available endpoints.

[!NOTE] When specifying a namespace endpoint without an actual namespace, the metrics array will be ignored.

⭐ Telegraf v1.0.0 🏷️ logging 💻 all

Global configuration options <!-- @/docs/includes/plugin_config.md -->

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See CONFIGURATION.md for more details.

Configuration

toml
# Read flattened metrics from one or more GrayLog HTTP endpoints
[[inputs.graylog]]
  ## API endpoint, currently supported API:
  ##
  ##   - multiple  (e.g. http://<host>:9000/api/system/metrics/multiple)
  ##   - namespace (e.g. http://<host>:9000/api/system/metrics/namespace/{namespace})
  ##
  ## For namespace endpoint, the metrics array will be ignored for that call.
  ## Endpoint can contain namespace and multiple type calls.
  ##
  ## Please check http://[graylog-server-ip]:9000/api/api-browser for full list
  ## of endpoints
  servers = [
    "http://[graylog-server-ip]:9000/api/system/metrics/multiple",
  ]

  ## Set timeout (default 5 seconds)
  # timeout = "5s"

  ## Metrics list
  ## List of metrics can be found on Graylog webservice documentation.
  ## Or by hitting the web service api at:
  ##   http://[graylog-host]:9000/api/system/metrics
  metrics = [
    "jvm.cl.loaded",
    "jvm.memory.pools.Metaspace.committed"
  ]

  ## Username and password
  username = ""
  password = ""

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

Please refer to GrayLog metrics API browser for full metric end points: http://host:9000/api/api-browser

Metrics

Example Output