logstash

Documentation

Overview

Package logstash is a Metricbeat module that contains MetricSets.

Index

• Constants
• Variables
• func ArePipelineGraphAPIsAvailable(currentLogstashVersion *common.Version) bool
• func AssetLogstash() string
• func GetConfig(metricset string, host string) map[string]interface{}
• func GetVersion(m *MetricSet) (*common.Version, error)
• func NewModule(base mb.BaseModule) (mb.Module, error)
• type MetricSet
  • func NewMetricSet(base mb.BaseMetricSet) (*MetricSet, error)
• type PipelineState
  • func GetPipelines(m *MetricSet) ([]PipelineState, error)

Constants

const ModuleName = "logstash"

ModuleName is the name of this module.

Variables

var PipelineGraphAPIsAvailableVersion = common.MustNewVersion("7.3.0")

PipelineGraphAPIsAvailableVersion is the version of Logstash since when its APIs can return pipeline graphs

Functions

func ArePipelineGraphAPIsAvailable

func ArePipelineGraphAPIsAvailable(currentLogstashVersion *common.Version) bool

ArePipelineGraphAPIsAvailable returns whether Logstash APIs that returns pipeline graphs are available in the given version of Logstash

func AssetLogstash

func AssetLogstash() string

AssetLogstash returns asset data. This is the base64 encoded gzipped contents of ../metricbeat/module/logstash.

func GetConfig

func GetConfig(metricset string, host string) map[string]interface{}

GetConfig for Logstash

func GetVersion

func GetVersion(m *MetricSet) (*common.Version, error)

GetVersion returns the version of the Logstash node

func NewModule

func NewModule(base mb.BaseModule) (mb.Module, error)

NewModule creates a new module after performing validation.

Types

type MetricSet

type MetricSet struct {
	mb.BaseMetricSet
	*helper.HTTP
	XPack bool
}

MetricSet can be used to build other metricsets within the Logstash module.

func NewMetricSet

func NewMetricSet(base mb.BaseMetricSet) (*MetricSet, error)

NewMetricSet creates a metricset that can be used to build other metricsets within the Logstash module.

type PipelineState

type PipelineState struct {
	ID             string          `json:"id"`
	Hash           string          `json:"hash"`
	EphemeralID    string          `json:"ephemeral_id"`
	Graph          *graphContainer `json:"graph,omitempty"`
	Representation *graphContainer `json:"representation"`
	BatchSize      int             `json:"batch_size"`
	Workers        int             `json:"workers"`
}

PipelineState represents the state (shape) of a Logstash pipeline

func GetPipelines

func GetPipelines(m *MetricSet) ([]PipelineState, error)

GetPipelines returns the list of pipelines running on a Logstash node