groundwork

README

GroundWork Output Plugin

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

Configuration

[[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 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"

List of tags used by the plugin

• service - to define the name of the service you want to monitor.
• status - to define the status of the service.
• message - to provide any message you want.
• unitType - to use in monitoring contexts(subset of The Unified Code for Units of Measure standard). Supported types: "1", "%cpu", "KB", "GB", "MB".
• warning - to define warning threshold value.
• critical - to define critical threshold value.

Documentation

Index

• type Groundwork
  • func (g *Groundwork) Close() error
  • func (g *Groundwork) Connect() error
  • func (g *Groundwork) Description() string
  • func (g *Groundwork) Init() error
  • func (g *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            string          `toml:"username"`
	Password            string          `toml:"password"`
	DefaultHost         string          `toml:"default_host"`
	DefaultServiceState string          `toml:"default_service_state"`
	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) Description

func (g *Groundwork) Description() string

func (*Groundwork) Init

func (g *Groundwork) Init() error

func (*Groundwork) SampleConfig

func (g *Groundwork) SampleConfig() string

func (*Groundwork) Write

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