telegraf/plugins/inputs/graylog
Thomas Casteleyn 6a2f6f301f
chore: eliminate unnecessary use of quoted strings in printf (#12722)
2023-02-23 06:49:36 -07:00
..
README.md docs: Update all readme to pass linter (#12615) 2023-02-09 11:04:41 +01:00
graylog.go chore: eliminate unnecessary use of quoted strings in printf (#12722) 2023-02-23 06:49:36 -07:00
graylog_test.go chore: update to go1.19.1 (#11776) 2022-09-08 12:49:36 -06:00
sample.conf chore(inputs_a-l): migrate sample configs into separate files (#11132) 2022-05-18 11:31:52 -05:00

README.md

GrayLog Input Plugin

The Graylog plugin can collect data from remote Graylog service URLs.

Plugin currently support two type of end points:-

  • multiple (e.g. http://[graylog-server-ip]:9000/api/system/metrics/multiple)
  • namespace (e.g. http://[graylog-server-ip]:9000/api/system/metrics/namespace/{namespace})

End Point can be a mix of one multiple end point and several namespaces end points

Note: if namespace end point specified metrics array will be ignored for that call.

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# 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