beater

Documentation

Overview

Metricbeat collects metric sets from different modules.

Each event created has the following format:

curl -XPUT http://localhost:9200/metricbeat/metricsets -d
{
	"metriset": metricsetName,
	"module": moduleName,
	"moduleName-metricSetName": {
		"metric1": "value",
		"metric2": "value",
		"metric3": "value",
		"nestedmetric": {
			"metric4": "value"
		}
	},
	"@timestamp": timestamp
}

All documents are currently stored in one index called metricbeat. It is important to use an independent namespace for each MetricSet to prevent type conflicts. Also all values are stored under the same type "metricsets".

Index

• type Config
• type Metricbeat
  • func New() *Metricbeat
  • func (mb *Metricbeat) Cleanup(b *beat.Beat) error
  • func (mb *Metricbeat) Config(b *beat.Beat) error
  • func (mb *Metricbeat) Run(b *beat.Beat) error
  • func (mb *Metricbeat) Setup(b *beat.Beat) error
  • func (mb *Metricbeat) Stop()
• type MetricbeatConfig

Types

type Config

type Config struct {
	Metricbeat MetricbeatConfig
}

type Metricbeat

type Metricbeat struct {
	// contains filtered or unexported fields
}

func New

func New() *Metricbeat

New creates and returns a new Metricbeat instance.

func (*Metricbeat) Cleanup

func (mb *Metricbeat) Cleanup(b *beat.Beat) error

func (*Metricbeat) Config

func (mb *Metricbeat) Config(b *beat.Beat) error

func (*Metricbeat) Run

func (mb *Metricbeat) Run(b *beat.Beat) error

func (*Metricbeat) Setup

func (mb *Metricbeat) Setup(b *beat.Beat) error

func (*Metricbeat) Stop

func (mb *Metricbeat) Stop()

type MetricbeatConfig

type MetricbeatConfig struct {
	Modules []*common.Config
}