The highest tagged major version is
README
¶
Metricbeat
Metricbeat takes metrics and statistics from your systems and ships them to elasticsearch or logstash.
WARNING: Metricbeat is currently still in an experimental phase and under heavy development.
Usage
Metricbeat should be installed as local as possible so it can fetch metrics directly from the intended systems. For example if there are multiple MySQL servers, Metricbeat should be installed on each machine if possible instead of a centralised installation.
Contributions
Contributions of new modules and metricsets to Metricbeat are highly welcome. To guarantee the quality of all metricsets we defined the following requirements for each Metricset:
- Unit tests
- Integration tests
- Kibana Dashboards
- Template
Best is to start your own module as its own beat first (see below use it as a library) so you can test it and then start a discussion with our team if it would fit into Metricbeat.
Use it as library
Metricbeat can also be used as a library so you can implement your own module on top of metricbeat and building your own beat based on it, withouth getting your module into the main repository. This allows to make use of the schedule and interfaces of Metricbeat. A developer guide and how to do this will follow soon.
Documentation
¶
Overview ¶
Package metricbeat contains the entrypoint to Metricbeat which is a lightweight data shipper for operating system and service metrics. It ships events directly to Elasticsearch or Logstash. The data can then be visualized in Kibana.
Downloads: https://www.elastic.co/downloads/beats/metricbeat
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package beater provides the implementation of the libbeat Beater interface for Metricbeat and functions for running Metricbeat Modules on their own.
|
Package beater provides the implementation of the libbeat Beater interface for Metricbeat and functions for running Metricbeat Modules on their own. |
|
The conversion functions take a key and a map[string]string.
|
The conversion functions take a key and a map[string]string. |
|
Package include imports all Module and MetricSet packages so that they register their factories with the global registry.
|
Package include imports all Module and MetricSet packages so that they register their factories with the global registry. |
|
Package mb (short for Metricbeat) contains the public interfaces that are used to implement Modules and their associated MetricSets.
|
Package mb (short for Metricbeat) contains the public interfaces that are used to implement Modules and their associated MetricSets. |
|
testing
Package testing provides utility functions for testing Module and MetricSet implementations.
|
Package testing provides utility functions for testing Module and MetricSet implementations. |
|
Package module contains Metricbeat modules and their MetricSet implementations.
|
Package module contains Metricbeat modules and their MetricSet implementations. |
|
apache
Package apache is Metricbeat module for the Apache HTTPD server.
|
Package apache is Metricbeat module for the Apache HTTPD server. |
|
apache/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. |
|
mysql
Package mysql is Metricbeat module for MySQL server.
|
Package mysql is Metricbeat module for MySQL server. |
|
mysql/status
Package status fetches MySQL server status metrics.
|
Package status fetches MySQL server status metrics. |
|
nginx
Package nginx is Metricbeat module for the Nginx reverse proxy.
|
Package nginx is Metricbeat module for the Nginx reverse proxy. |
|
nginx/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. |
|
redis
Package redis contains shared Redis functionality for the metric sets
|
Package redis contains shared Redis functionality for the metric sets |
|
redis/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. |
|
system
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. |
|
system/core
Package core collects cpu core metrics from the host OS.
|
Package core collects cpu core metrics from the host OS. |
|
system/cpu
Package cpu collects CPU metrics from the host OS.
|
Package cpu collects CPU metrics from the host OS. |
|
system/diskio
Package disk fetches disk IO metrics from the OS.
|
Package disk fetches disk IO metrics from the OS. |
|
system/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. |
|
system/fsstat
Package fsstat provides a MetricSet for fetching aggregated filesystem stats.
|
Package fsstat provides a MetricSet for fetching aggregated filesystem stats. |
|
system/memory
Package memory collects memory metrics from the host OS.
|
Package memory collects memory metrics from the host OS. |
|
system/network
Package network provides network IO metrics from the OS.
|
Package network provides network IO metrics from the OS. |
|
system/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. |
|
zookeeper
Package zookeeper is a Metricbeat module for ZooKeeper servers.
|
Package zookeeper is a Metricbeat module for ZooKeeper servers. |
|
zookeeper/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. |