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
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
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 docker is a Metricbeat module that contains MetricSets.
|
Package docker is a Metricbeat module that contains MetricSets. |
|
Package haproxy is a Metricbeat module that contains MetricSets.
|
Package haproxy is a Metricbeat module that contains MetricSets. |
|
Package kafka is a Metricbeat module that contains MetricSets.
|
Package kafka is a Metricbeat module that contains MetricSets. |
|
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. |
|
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 postgresql is a Metricbeat module that contains MetricSets.
|
Package postgresql is a Metricbeat module that contains MetricSets. |
|
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. |
|
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. |
|
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 load metrics from the host OS.
|
Package load collects system 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. |
|
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. |