groundwork

README

GroundWork Output Plugin

This plugin writes to a GroundWork Monitor instance. Plugin only supports GW8+

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.

Secret-store support

This plugin supports secrets from secret-stores for the username and password option. See the secret-store documentation for more details on how to use them.

Configuration

# 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.

Documentation

Index

• type Groundwork
  • func (g *Groundwork) Close() error
  • func (g *Groundwork) Connect() error
  • func (g *Groundwork) Init() error
  • func (*Groundwork) SampleConfig() string
  • func (g *Groundwork) Write(metrics []telegraf.Metric) error

Types

type Groundwork

type Groundwork struct {
	Server              string          `toml:"url"`
	AgentID             string          `toml:"agent_id"`
	Username            config.Secret   `toml:"username"`
	Password            config.Secret   `toml:"password"`
	DefaultAppType      string          `toml:"default_app_type"`
	DefaultHost         string          `toml:"default_host"`
	DefaultServiceState string          `toml:"default_service_state"`
	GroupTag            string          `toml:"group_tag"`
	ResourceTag         string          `toml:"resource_tag"`
	Log                 telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

func (*Groundwork) Close

func (g *Groundwork) Close() error

func (*Groundwork) Connect

func (g *Groundwork) Connect() error

func (*Groundwork) Init

func (g *Groundwork) Init() error

func (*Groundwork) SampleConfig

func (*Groundwork) SampleConfig() string

func (*Groundwork) Write

func (g *Groundwork) Write(metrics []telegraf.Metric) error