docs-v2/content/telegraf/v1/input-plugins/nomad/_index.md

65 lines
2.1 KiB
Markdown

---
description: "Telegraf plugin for collecting metrics from Hashicorp Nomad"
menu:
telegraf_v1_ref:
parent: input_plugins_reference
name: Hashicorp Nomad
identifier: input-nomad
tags: [Hashicorp Nomad, "input-plugins", "configuration", "server"]
introduced: "v1.22.0"
os_support: "freebsd, linux, macos, solaris, windows"
related:
- /telegraf/v1/configure_plugins/
- https://github.com/influxdata/telegraf/tree/v1.36.1/plugins/inputs/nomad/README.md, Hashicorp Nomad Plugin Source
---
# Hashicorp Nomad Input Plugin
This plugin collects metrics from every [Nomad agent](https://www.nomadproject.io/) of the specified
cluster. Telegraf may be present in every node and connect to the agent locally.
**Introduced in:** Telegraf v1.22.0
**Tags:** server
**OS support:** all
[nomad]: https://www.nomadproject.io/
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
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](/telegraf/v1/configuration/#plugins) for more details.
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
## Configuration
```toml @sample.conf
# Read metrics from the Nomad API
[[inputs.nomad]]
## URL for the Nomad agent
# url = "http://127.0.0.1:4646"
## Set response_timeout (default 5 seconds)
# response_timeout = "5s"
## Optional TLS Config
# tls_ca = /path/to/cafile
# tls_cert = /path/to/certfile
# tls_key = /path/to/keyfile
```
## Metrics
Both Nomad servers and agents collect various metrics. For every details, please
have a look at [Nomad metrics](https://www.nomadproject.io/docs/operations/metrics) and [Nomad telemetry](https://www.nomadproject.io/docs/operations/telemetry)
ocumentation.
[metrics]: https://www.nomadproject.io/docs/operations/metrics
[telemetry]: https://www.nomadproject.io/docs/operations/telemetry
## Example Output
There is no predefined metric format, so output depends on plugin input.