kibana

Documentation

Overview

Package kibana is a Metricbeat module that contains MetricSets.

Index

• Constants
• Variables
• func AssetKibana() string
• func GetVersion(http *helper.HTTP, currentPath string) (*common.Version, error)
• func IsSettingsAPIAvailable(currentKibanaVersion *common.Version) bool
• func IsStatsAPIAvailable(currentKibanaVersion *common.Version) bool
• func IsUsageExcludable(currentKibanaVersion *common.Version) bool
• func NewModule(base mb.BaseModule) (mb.Module, error)
• func ReportErrorForMissingField(field string, r mb.ReporterV2) error
• type Config
  • func DefaultConfig() Config
• type MetricSet
  • func NewMetricSet(base mb.BaseMetricSet) (*MetricSet, error)

Constants

const ModuleName = "kibana"

ModuleName is the name of this module

Variables

var (

	// StatsAPIAvailableVersion is the version of Kibana since when the stats API is available
	StatsAPIAvailableVersion = v6_4_0

	// SettingsAPIAvailableVersion is the version of Kibana since when the settings API is available
	SettingsAPIAvailableVersion = v6_5_0
)

Functions

func AssetKibana

func AssetKibana() string

AssetKibana returns asset data. This is the base64 encoded gzipped contents of ../metricbeat/module/kibana.

func GetVersion

func GetVersion(http *helper.HTTP, currentPath string) (*common.Version, error)

GetVersion returns the version of the Kibana instance

func IsSettingsAPIAvailable

func IsSettingsAPIAvailable(currentKibanaVersion *common.Version) bool

IsSettingsAPIAvailable returns whether the settings API is available in the given version of Kibana

func IsStatsAPIAvailable

func IsStatsAPIAvailable(currentKibanaVersion *common.Version) bool

IsStatsAPIAvailable returns whether the stats API is available in the given version of Kibana

func IsUsageExcludable

func IsUsageExcludable(currentKibanaVersion *common.Version) bool

IsUsageExcludable returns whether the stats API supports the exclude_usage parameter in the given version of Kibana

func NewModule

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

NewModule creates a new module after performing validation.

func ReportErrorForMissingField

func ReportErrorForMissingField(field string, r mb.ReporterV2) error

ReportErrorForMissingField reports and returns an error message for the given field being missing in API response received from Kibana

Types

type Config

type Config struct {
	XPackEnabled bool `config:"xpack.enabled"`
}

Config defines the structure for the Kibana module configuration options

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration for the Kibana module

type MetricSet

type MetricSet struct {
	mb.BaseMetricSet
	XPackEnabled bool
}

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

func NewMetricSet

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

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