 Documentation
      ¶
      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
      ¶
      Source Files
      ¶
    
- main.go
       Directories
      ¶
      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. | 
| 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. | 
| 
          
            aerospike
            
            
          
           Package aerospike is a Metricbeat module that contains MetricSets. | Package aerospike is a Metricbeat module that contains MetricSets. | 
| 
          
            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. | 
| 
          
            ceph
            
            
          
           Package ceph is a Metricbeat module that contains MetricSets. | Package ceph is a Metricbeat module that contains MetricSets. | 
| 
          
            couchbase
            
            
          
           Package couchbase is a Metricbeat module that contains MetricSets. | Package couchbase is a Metricbeat module that contains MetricSets. | 
| 
          
            docker
            
            
          
           Package docker is a Metricbeat module that contains MetricSets. | Package docker is a Metricbeat module that contains MetricSets. | 
| 
          
            dropwizard
            
            
          
           Package dropwizard is a Metricbeat module that contains MetricSets. | Package dropwizard is a Metricbeat module that contains MetricSets. | 
| 
          
            elasticsearch
            
            
          
           Package elasticsearch is a Metricbeat module that contains MetricSets. | Package elasticsearch is a Metricbeat module that contains MetricSets. | 
| 
          
            golang
            
            
          
           Package golang is a Metricbeat module that contains MetricSets. | Package golang is a Metricbeat module that contains MetricSets. | 
| 
          
            haproxy
            
            
          
           Package haproxy is a Metricbeat module that contains MetricSets. | Package haproxy is a Metricbeat module that contains MetricSets. | 
| 
          
            http
            
            
          
           Package http is a Metricbeat module that contains MetricSets. | Package http is a Metricbeat module that contains MetricSets. | 
| 
          
            http/_meta/test
            
            command
          
          
         | |
| 
          
            jolokia
            
            
          
           Package jolokia is a Metricbeat module that contains MetricSets. | Package jolokia is a Metricbeat module that contains MetricSets. | 
| 
          
            kafka
            
            
          
           Package kafka is a Metricbeat module that contains MetricSets. | Package kafka is a Metricbeat module that contains MetricSets. | 
| 
          
            kibana
            
            
          
           Package kibana is a Metricbeat module that contains MetricSets. | Package kibana is a Metricbeat module that contains MetricSets. | 
| 
          
            kubernetes
            
            
          
           Package kubernetes is a Metricbeat module that contains MetricSets. | Package kubernetes is a Metricbeat module that contains MetricSets. | 
| 
          
            memcached
            
            
          
           Package memcached is a Metricbeat module that contains MetricSets. | Package memcached is a Metricbeat module that contains MetricSets. | 
| 
          
            mongodb
            
            
          
           Package mongodb is a Metricbeat module that contains MetricSets. | Package mongodb is a Metricbeat module that contains MetricSets. | 
| 
          
            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. | 
| 
          
            php_fpm
            
            
          
           Package php_fpm is a Metricbeat module that contains MetricSets. | Package php_fpm is a Metricbeat module that contains MetricSets. | 
| 
          
            postgresql
            
            
          
           Package postgresql is a Metricbeat module that contains MetricSets. | Package postgresql is a Metricbeat module that contains MetricSets. | 
| 
          
            prometheus
            
            
          
           Package prometheus is a Metricbeat module that contains MetricSets. | Package prometheus is a Metricbeat module that contains MetricSets. | 
| 
          
            rabbitmq
            
            
          
           Package rabbitmq is a Metricbeat module that contains MetricSets. | Package rabbitmq is a Metricbeat module that contains MetricSets. | 
| 
          
            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/_meta/testing
            
            command
          
          
         | |
| 
          
            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 diskio fetches disk IO metrics from the OS. | Package diskio 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/load
            
            
          
           Package load collects system CPU load metrics from the host OS. | Package load collects system CPU load metrics from the host OS. | 
| 
          
            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. | 
| 
          
            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. | 
| 
          
            system/socket
            
            
          
           Package socket captures active sockets and the processes that own them. | Package socket captures active sockets and the processes that own them. | 
| 
          
            vsphere
            
            
          
           Package vsphere is a Metricbeat module that contains MetricSets. | Package vsphere is a Metricbeat module that contains MetricSets. | 
| 
          
            windows
            
            
          
           Package windows is a Metricbeat module that contains MetricSets. | Package windows is a Metricbeat module that contains MetricSets. | 
| 
          
            windows/perfmon
            
            
          
           Package perfmon implements a Metricbeat metricset for reading Windows performance counters. | Package perfmon implements a Metricbeat metricset for reading Windows performance counters. | 
| 
          
            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. | 
| processor
       | |
 Click to show internal directories. 
   Click to hide internal directories.