---
title: Telegraf Documentation
description: Telegraf plugin for sending metrics to GroundWork
url: https://docs.influxdata.com/telegraf/v1/output-plugins/groundwork/
estimated_tokens: 1533
product: Telegraf
version: v1
---

-   Telegraf v1.21.0+

# GroundWork Output Plugin

This plugin writes metrics to a [GroundWork Monitor](https://www.gwos.com/product/groundwork-monitor/) instance.

Plugin only supports GroundWork v8 or later.

**Introduced in:** Telegraf v1.21.0 **Tags:** applications, messaging **OS support:** all

## Global configuration options

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](/telegraf/v1/configuration/#plugins) for more details.

## Secret-store support

This plugin supports secrets from secret-stores for the `username` and `password` option. See the [secret-store documentation](/telegraf/v1/configuration/#secret-store-secrets) for more details on how to use them.

## Configuration

```toml
# Send telegraf metrics to GroundWork Monitor
[[outputs.groundwork]]
  ## URL of your groundwork instance.
  url = "https://groundwork.example.com"

  ## Agent uuid for GroundWork API Server.
  agent_id = ""

  ## Username and password to access GroundWork API.
  username = ""
  password = ""

  ## Default application type to use in GroundWork client
  # default_app_type = "TELEGRAF"

  ## Default display name for the host with services(metrics).
  # default_host = "telegraf"

  ## Default service state.
  # default_service_state = "SERVICE_OK"

  ## The name of the tag that contains the hostname.
  # resource_tag = "host"

  ## The name of the tag that contains the host group name.
  # group_tag = "group"
```

## List of tags used by the plugin

-   **group** - to define the name of the group you want to monitor, can be changed with config.
-   **host** - to define the name of the host you want to monitor, can be changed with config.
-   **service** - to define the name of the service you want to monitor.
-   **status** - to define the status of the service. Supported statuses: “SERVICE\_OK”, “SERVICE\_WARNING”, “SERVICE\_UNSCHEDULED\_CRITICAL”, “SERVICE\_PENDING”, “SERVICE\_SCHEDULED\_CRITICAL”, “SERVICE\_UNKNOWN”.
-   **message** - to provide any message you want, it overrides **message** field value.
-   **unitType** - to use in monitoring contexts (subset of The Unified Code for Units of Measure standard). Supported types: “1”, “%cpu”, “KB”, “GB”, “MB”.
-   **critical** - to define the default critical threshold value, it overrides value\_cr field value.
-   **warning** - to define the default warning threshold value, it overrides value\_wn field value.
-   **value\_cr** - to define critical threshold value, it overrides **critical** tag value and **value\_cr** field value.
-   **value\_wn** - to define warning threshold value, it overrides **warning** tag value and **value\_wn** field value.

## NOTE

The current version of GroundWork Monitor does not support metrics whose values are strings. Such metrics will be skipped and will not be added to the final payload. You can find more context in this pull request: [#10255](https://github.com/influxdata/telegraf/pull/10255).

#### Related

-   [Configure plugins](/telegraf/v1/configure_plugins/)
-   [GroundWork Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/outputs/groundwork/README.md)