module

package
v5.0.0-alpha4+incompat... Latest Latest
Warning

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

Go to latest
Published: Jun 30, 2016 License: Apache-2.0 Imports: 0 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 * max: maximumg * min: minimum * pct: precentage * request: req * sec: seconds, second, s * ms: millisecond, millis * mb: megabytes * msg: message

Directories

Path Synopsis
Package apache is Metricbeat module for the Apache HTTPD server.
Package apache is Metricbeat module for the Apache HTTPD server.
Package mongodb is a Metricbeat module that contains MetricSets.
Package mongodb is a Metricbeat module that contains MetricSets.
Package mysql is Metricbeat module for MySQL server.
Package mysql is Metricbeat module for MySQL server.
Package nginx is Metricbeat module for the Nginx reverse proxy.
Package nginx is Metricbeat module for the Nginx reverse proxy.
Package redis contains shared Redis functionality for the metric sets
Package redis contains shared Redis functionality for the metric sets
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.
Package zookeeper is a Metricbeat module for ZooKeeper servers.
Package zookeeper is a Metricbeat module for ZooKeeper servers.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL