module

package
v6.0.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 7, 2017 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package module contains Metricbeat modules and their MetricSet implementations.

= Naming conventions

For the key names, metricbeat follows the naming conventions below:

* all field keys lower case * snake case for combining words * Group related fields in sub documents, which means using the . notation. Groups are mostly described by common prefixes. * Prevent namespace duplication. If connections appears in the namespace, it's not needed in the sub document * Do not use complex abbreviations. A list of standardised abbreviations can be found below. * Organise the documents from the general to the details, which allows namespacing. The type should always be last, like .pct. * If two fields are the same but with different units, remove the less granular one * In case the value correlates with the name of a nested document, use value inside the document * Do not use . in the names * Use singular and plural properly for the fields. Example: sec_per_request vs open_requests * Use singular names for metricsets. It easier to read the event created: system.process.load = 0.3

The goal is to have a similar experience across all metrics.

= Abbrevations

List of standardised words and units across all metricsets. On the left are the ones to be used, on the right the options seen in metricsets.

* avg: average * connection: conn * count: * day: days, d * der: derivative * max: maximumg * min: minimum * pct: percentage * request: req * sec: seconds, second, s * ms: millisecond, millis * mb: megabytes * msg: message * ns: nanoseconds * norm: normalized * us: microseconds

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func MetricSetsPlugin 

func MetricSetsPlugin(
	module string,
	metricsets map[string]mb.MetricSetFactory,
) map[string][]interface{}

func Plugin 

func Plugin(
	module string,
	factory mb.ModuleFactory,
	metricsets map[string]mb.MetricSetFactory,
) map[string][]interface{}

Types

This section is empty.

Source Files

View all Source files

Directories

Path Synopsis
Package aerospike is a Metricbeat module that contains MetricSets.
 Package aerospike is a Metricbeat module that contains MetricSets.
namespace
Package apache is Metricbeat module for the Apache HTTPD server.
 Package apache is Metricbeat module for the Apache HTTPD server.
status
Package status reads Apache HTTPD server status from the mod_status module.
 Package status reads Apache HTTPD server status from the mod_status module.
Package ceph is a Metricbeat module that contains MetricSets.
 Package ceph is a Metricbeat module that contains MetricSets.
cluster_disk
cluster_health
monitor_health
pool_disk
Package couchbase is a Metricbeat module that contains MetricSets.
 Package couchbase is a Metricbeat module that contains MetricSets.
bucket
cluster
node
Package docker is a Metricbeat module that contains MetricSets.
 Package docker is a Metricbeat module that contains MetricSets.
container
cpu
diskio
healthcheck
image
info
memory
network
Package dropwizard is a Metricbeat module that contains MetricSets.
 Package dropwizard is a Metricbeat module that contains MetricSets.
collector
Package elasticsearch is a Metricbeat module that contains MetricSets.
 Package elasticsearch is a Metricbeat module that contains MetricSets.
node
node_stats
Package golang is a Metricbeat module that contains MetricSets.
 Package golang is a Metricbeat module that contains MetricSets.
expvar
heap
Package haproxy is a Metricbeat module that contains MetricSets.
 Package haproxy is a Metricbeat module that contains MetricSets.
info
stat
Package http is a Metricbeat module that contains MetricSets.
 Package http is a Metricbeat module that contains MetricSets.
_meta/test
json
Package jolokia is a Metricbeat module that contains MetricSets.
 Package jolokia is a Metricbeat module that contains MetricSets.
jmx
Package kafka is a Metricbeat module that contains MetricSets.
 Package kafka is a Metricbeat module that contains MetricSets.
consumergroup
partition
Package kibana is a Metricbeat module that contains MetricSets.
 Package kibana is a Metricbeat module that contains MetricSets.
status
Package kubernetes is a Metricbeat module that contains MetricSets.
 Package kubernetes is a Metricbeat module that contains MetricSets.
container
event
node
pod
state_container
state_deployment
state_node
state_pod
state_replicaset
system
util
volume
Package memcached is a Metricbeat module that contains MetricSets.
 Package memcached is a Metricbeat module that contains MetricSets.
stats
Package mongodb is a Metricbeat module that contains MetricSets.
 Package mongodb is a Metricbeat module that contains MetricSets.
dbstats
status
Package mysql is Metricbeat module for MySQL server.
 Package mysql is Metricbeat module for MySQL server.
status
Package status fetches MySQL server status metrics.
 Package status fetches MySQL server status metrics.
Package nginx is Metricbeat module for the Nginx reverse proxy.
 Package nginx is Metricbeat module for the Nginx reverse proxy.
stubstatus
Package stubstatus reads server status from nginx host under /server-status, ngx_http_stub_status_module is required.
 Package stubstatus reads server status from nginx host under /server-status, ngx_http_stub_status_module is required.
Package php_fpm is a Metricbeat module that contains MetricSets.
 Package php_fpm is a Metricbeat module that contains MetricSets.
pool
Package postgresql is a Metricbeat module that contains MetricSets.
 Package postgresql is a Metricbeat module that contains MetricSets.
activity
bgwriter
database
Package prometheus is a Metricbeat module that contains MetricSets.
 Package prometheus is a Metricbeat module that contains MetricSets.
collector
stats
Package rabbitmq is a Metricbeat module that contains MetricSets.
 Package rabbitmq is a Metricbeat module that contains MetricSets.
node
Package redis contains shared Redis functionality for the metric sets
 Package redis contains shared Redis functionality for the metric sets
info
Package info fetches Redis server information and statistics using the Redis INFO command.
 Package info fetches Redis server information and statistics using the Redis INFO command.
keyspace
Package system is a Metricbeat module that contains MetricSets that collect system level information like CPU and memory stats.
 Package system is a Metricbeat module that contains MetricSets that collect system level information like CPU and memory stats.
_meta/testing
core
Package core collects cpu core metrics from the host OS.
 Package core collects cpu core metrics from the host OS.
cpu
Package cpu collects CPU metrics from the host OS.
 Package cpu collects CPU metrics from the host OS.
diskio
Package diskio fetches disk IO metrics from the OS.
 Package diskio fetches disk IO metrics from the OS.
filesystem
Package filesystem provides a MetricSet implementation that fetches metrics for each of the mounted file systems.
 Package filesystem provides a MetricSet implementation that fetches metrics for each of the mounted file systems.
fsstat
Package fsstat provides a MetricSet for fetching aggregated filesystem stats.
 Package fsstat provides a MetricSet for fetching aggregated filesystem stats.
load
Package load collects system CPU load metrics from the host OS.
 Package load collects system CPU load metrics from the host OS.
memory
Package memory collects memory metrics from the host OS.
 Package memory collects memory metrics from the host OS.
network
Package network provides network IO metrics from the OS.
 Package network provides network IO metrics from the OS.
process
Package process collects metrics about the running processes using information from the operating system.
 Package process collects metrics about the running processes using information from the operating system.
process_summary
Package process_summary collects high level summary metrics about the running processes.
 Package process_summary collects high level summary metrics about the running processes.
socket
Package socket captures active sockets and the processes that own them.
 Package socket captures active sockets and the processes that own them.
Package vsphere is a Metricbeat module that contains MetricSets.
 Package vsphere is a Metricbeat module that contains MetricSets.
datastore
host
virtualmachine
Package windows is a Metricbeat module that contains MetricSets.
 Package windows is a Metricbeat module that contains MetricSets.
perfmon
Package perfmon implements a Metricbeat metricset for reading Windows performance counters.
 Package perfmon implements a Metricbeat metricset for reading Windows performance counters.
Package zookeeper is a Metricbeat module for ZooKeeper servers.
 Package zookeeper is a Metricbeat module for ZooKeeper servers.
mntr
Package mntr fetches metrics from ZooKeeper by using the mntr command which was added to ZooKeeper in version 3.4.0.
 Package mntr fetches metrics from ZooKeeper by using the mntr command which was added to ZooKeeper in version 3.4.0.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.