- Metricbeat Reference: other versions:
- Metricbeat overview
- Quick start: installation and configuration
- Set up and run
- Upgrade Metricbeat
- How Metricbeat works
- Configure
- Modules
- General settings
- Project paths
- Config file loading
- Output
- Kerberos
- SSL
- Index lifecycle management (ILM)
- Elasticsearch index template
- Kibana endpoint
- Kibana dashboards
- Processors
- Define processors
- add_cloud_metadata
- add_cloudfoundry_metadata
- add_docker_metadata
- add_fields
- add_host_metadata
- add_id
- add_kubernetes_metadata
- add_labels
- add_locale
- add_network_direction
- add_nomad_metadata
- add_observer_metadata
- add_process_metadata
- add_tags
- append
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_duration
- decode_json_fields
- decode_xml
- decode_xml_wineventlog
- decompress_gzip_field
- detect_mime_type
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- move_fields
- rate_limit
- registered_domain
- rename
- replace
- script
- syslog
- translate_ldap_attribute
- translate_sid
- truncate_fields
- urldecode
- Autodiscover
- Internal queue
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- Feature flags
- metricbeat.reference.yml
- How to guides
- Modules
- ActiveMQ module
- Aerospike module
- Airflow module
- Apache module
- AWS module
- AWS awshealth metricset
- AWS billing metricset
- AWS cloudwatch metricset
- AWS dynamodb metricset
- AWS ebs metricset
- AWS ec2 metricset
- AWS elb metricset
- AWS kinesis metricset
- AWS lambda metricset
- AWS natgateway metricset
- AWS rds metricset
- AWS s3_daily_storage metricset
- AWS s3_request metricset
- AWS sns metricset
- AWS sqs metricset
- AWS transitgateway metricset
- AWS usage metricset
- AWS vpn metricset
- AWS Fargate module
- Azure module
- Azure app_insights metricset
- Azure app_state metricset
- Azure billing metricset
- Azure compute_vm metricset
- Azure compute_vm_scaleset metricset
- Azure container_instance metricset
- Azure container_registry metricset
- Azure container_service metricset
- Azure database_account metricset
- Azure monitor metricset
- Azure storage metricset
- Beat module
- Ceph module
- Ceph cluster_disk metricset
- Ceph cluster_health metricset
- Ceph cluster_status metricset
- Ceph mgr_cluster_disk metricset
- Ceph mgr_cluster_health metricset
- Ceph mgr_osd_perf metricset
- Ceph mgr_osd_pool_stats metricset
- Ceph mgr_osd_tree metricset
- Ceph mgr_pool_disk metricset
- Ceph monitor_health metricset
- Ceph osd_df metricset
- Ceph osd_tree metricset
- Ceph pool_disk metricset
- Cloudfoundry module
- CockroachDB module
- Consul module
- Containerd module
- Coredns module
- Couchbase module
- CouchDB module
- Docker module
- Dropwizard module
- Elasticsearch module
- Elasticsearch ccr metricset
- Elasticsearch cluster_stats metricset
- Elasticsearch enrich metricset
- Elasticsearch index metricset
- Elasticsearch index_recovery metricset
- Elasticsearch index_summary metricset
- Elasticsearch ingest_pipeline metricset
- Elasticsearch ml_job metricset
- Elasticsearch node metricset
- Elasticsearch node_stats metricset
- Elasticsearch pending_tasks metricset
- Elasticsearch shard metricset
- Enterprise Search module
- Envoyproxy module
- Etcd module
- Google Cloud Platform module
- Google Cloud Platform billing metricset
- Google Cloud Platform carbon metricset
- Google Cloud Platform compute metricset
- Google Cloud Platform dataproc metricset
- Google Cloud Platform firestore metricset
- Google Cloud Platform gke metricset
- Google Cloud Platform loadbalancing metricset
- Google Cloud Platform metrics metricset
- Google Cloud Platform pubsub metricset
- Google Cloud Platform storage metricset
- Golang module
- Graphite module
- HAProxy module
- HTTP module
- IBM MQ module
- IIS module
- Istio module
- Jolokia module
- Kafka module
- Kibana module
- Kubernetes module
- Kubernetes apiserver metricset
- Kubernetes container metricset
- Kubernetes controllermanager metricset
- Kubernetes event metricset
- Kubernetes node metricset
- Kubernetes pod metricset
- Kubernetes proxy metricset
- Kubernetes scheduler metricset
- Kubernetes state_container metricset
- Kubernetes state_cronjob metricset
- Kubernetes state_daemonset metricset
- Kubernetes state_deployment metricset
- Kubernetes state_job metricset
- Kubernetes state_node metricset
- Kubernetes state_persistentvolumeclaim metricset
- Kubernetes state_pod metricset
- Kubernetes state_replicaset metricset
- Kubernetes state_resourcequota metricset
- Kubernetes state_service metricset
- Kubernetes state_statefulset metricset
- Kubernetes state_storageclass metricset
- Kubernetes system metricset
- Kubernetes volume metricset
- KVM module
- Linux module
- Logstash module
- Memcached module
- Cisco Meraki module
- MongoDB module
- MSSQL module
- Munin module
- MySQL module
- NATS module
- Nginx module
- Openmetrics module
- Oracle module
- Panw module
- PHP_FPM module
- PostgreSQL module
- Prometheus module
- RabbitMQ module
- Redis module
- Redis Enterprise module
- SQL module
- Stan module
- Statsd module
- SyncGateway module
- System module
- System core metricset
- System cpu metricset
- System diskio metricset
- System entropy metricset
- System filesystem metricset
- System fsstat metricset
- System load metricset
- System memory metricset
- System network metricset
- System network_summary metricset
- System process metricset
- System process_summary metricset
- System raid metricset
- System service metricset
- System socket metricset
- System socket_summary metricset
- System uptime metricset
- System users metricset
- Tomcat module
- Traefik module
- uWSGI module
- vSphere module
- Windows module
- ZooKeeper module
- Exported fields
- ActiveMQ fields
- Aerospike fields
- Airflow fields
- Apache fields
- AWS fields
- AWS Fargate fields
- Azure fields
- Beat fields
- Beat fields
- Ceph fields
- Cloud provider metadata fields
- Cloudfoundry fields
- CockroachDB fields
- Common fields
- Consul fields
- Containerd fields
- Coredns fields
- Couchbase fields
- CouchDB fields
- Docker fields
- Docker fields
- Dropwizard fields
- ECS fields
- Elasticsearch fields
- Enterprise Search fields
- Envoyproxy fields
- Etcd fields
- Google Cloud Platform fields
- Golang fields
- Graphite fields
- HAProxy fields
- Host fields
- HTTP fields
- IBM MQ fields
- IIS fields
- Istio fields
- Jolokia fields
- Jolokia Discovery autodiscover provider fields
- Kafka fields
- Kibana fields
- Kubernetes fields
- Kubernetes fields
- KVM fields
- Linux fields
- Logstash fields
- Memcached fields
- MongoDB fields
- MSSQL fields
- Munin fields
- MySQL fields
- NATS fields
- Nginx fields
- Openmetrics fields
- Oracle fields
- Panw fields
- PHP_FPM fields
- PostgreSQL fields
- Process fields
- Prometheus fields
- Prometheus typed metrics fields
- RabbitMQ fields
- Redis fields
- Redis Enterprise fields
- SQL fields
- Stan fields
- Statsd fields
- SyncGateway fields
- System fields
- Tomcat fields
- Traefik fields
- uWSGI fields
- vSphere fields
- Windows fields
- ZooKeeper fields
- Monitor
- Secure
- Troubleshoot
- Get help
- Debug
- Understand logged metrics
- Common problems
- "open /compat/linux/proc: no such file or directory" error on FreeBSD
- Metricbeat collects system metrics for interfaces you didn’t configure
- Metricbeat uses too much bandwidth
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- Publishing to Logstash fails with "connection reset by peer" message
- @metadata is missing in Logstash
- Not sure whether to use Logstash or Beats
- SSL client fails to connect to Logstash
- Monitoring UI shows fewer Beats than expected
- Dashboard could not locate the index-pattern
- High RSS memory usage due to MADV settings
- Contribute to Beats
Google Cloud Platform metrics metricset
editGoogle Cloud Platform metrics metricset
editOperations monitoring provides visibility into the performance, uptime, and overall health
of cloud-powered applications. It collects metrics, events, and metadata from
different services from Google Cloud. This metricset is to collect monitoring
metrics from Google Cloud using ListTimeSeries
API. The full list of metric
types that Google Cloud monitoring supports can be found in
Google Cloud Metrics.
Each monitoring metric from Google Cloud has a sample period and/or ingest delay. Sample period is the time interval between consecutive data points for metrics that are written periodically. Ingest delay represents the time for data points older than this value are guaranteed to be available to read. Sample period and ingest delay are obtained from making ListMetricDescriptors API call.
Metricset config and parameters
edit-
aligner: A single string with which aggregation operation need to be applied
onto time series data for ListTimeSeries API. If it’s not given, default aligner
is
ALIGN_NONE
. Google Cloud also supportsALIGN_DELTA
,ALIGN_RATE
,ALIGN_MIN
,ALIGN_MAX
,ALIGN_MEAN
,ALIGN_COUNT
,ALIGN_SUM
etc. Please see Aggregation Aligner for the full list of aligners. -
metric_types: Required, a list of metric type strings, or a list of metric
type prefixes. For example,
instance/cpu
is the prefix for metric typeinstance/cpu/usage_time
,instance/cpu/utilization
etc Each call of theListTimeSeries
API can return any number of time series from a single metric type. Metric type is to used for identifying a specific time series. -
service: Required, the name of the service for related metrics. This should
be a valid Google Cloud service name. Service names may be viewed from the
corresponding page from GCP Metrics list documentation.
The
service
field is used to compute the GCP Metric prefix, unlessservice_metric_prefix
is set. -
service_metric_prefix: A string containing the full Metric prefix as
specified in the GCP documentation.
All metrics from GCP Monitoring API require a prefix. When
service_metric_prefix
is empty, the prefix default to a value computed using theservice
value:<service>.googleapis.com/
. This default works for any services under "Google Cloud metrics", but does not work for other services (kubernetes
aka GKE for example). This option allow to override the default and specify an arbitrary metric prefix. -
location_label: Use this option to specify the resource label that identifies the location (such as zone or region) for a Google Cloud service when filtering metrics. For example, labels like
resource.label.location
orresource.label.zone
are used by Google Cloud to represent the region or zone of a resource. This is an optional configuration for the user.
Example Configuration
edit-
metrics
metricset is enabled to collect metrics from all zones undereurope-west1-c
region inelastic-observability
project. Two sets of metrics are specified: first one is to collect CPU usage time and utilization with aggregation aligner ALIGN_MEAN; second one is to collect uptime with aggregation aligner ALIGN_SUM. These metric types all have 240 seconds ingest delay time and 60 seconds sample period. Withperiod
specified as300s
in the config below, Metricbeat will collect compute metrics from Google Cloud every 5-minute with given aggregation aligner applied for each metric type.- module: gcp metricsets: - metrics zone: "europe-west1-c" project_id: elastic-observability credentials_file_path: "your JSON credentials file path" exclude_labels: false period: 300s metrics: - aligner: ALIGN_MEAN service: compute metric_types: - "instance/cpu/usage_time" - "instance/cpu/utilization" - aligner: ALIGN_SUM service: compute metric_types: - "instance/uptime"
-
metrics
metricset is enabled to collect metrics from all zones undereurope-west1-c
region inelastic-observability
project. Two sets of metrics are specified: first one is to collect CPU usage time and utilization with aggregation aligner ALIGN_MEAN; second one is to collect uptime with aggregation aligner ALIGN_SUM. These metric types all have 240 seconds ingest delay time and 60 seconds sample period. Withperiod
specified as60s
in the config below, Metricbeat will collect compute metrics from Google Cloud every minute with no aggregation. This case, the aligners specified in the configuration will be ignored.- module: gcp metricsets: - metrics zone: "europe-west1-c" project_id: elastic-observability credentials_file_path: "your JSON credentials file path" exclude_labels: false period: 60s metrics: - aligner: ALIGN_MEAN service: compute metric_types: - "instance/cpu/usage_time" - "instance/cpu/utilization" - aligner: ALIGN_SUM service: compute metric_types: - "instance/uptime"
-
metrics
metricset is enabled to collect metrics from all zones undereurope-west1-c
region inelastic-observability
project. One set of metrics will be collected: core usage time for containers in GCP GKE. Note that the is required to useservice_metric_prefix
to override the default metric prefix, as for GKE metrics the required prefix iskubernetes.io/
- module: gcp metricsets: - metrics zone: "europe-west1-c" project_id: elastic-observability credentials_file_path: "your JSON credentials file path" exclude_labels: false period: 1m metrics: - service: gke service_metric_prefix: kubernetes.io/ metric_types: - "container/cpu/core_usage_time"
-
metrics
metricset is enabled to collect metrics from regionus-east4
inelastic-observability
project. The metric, number of replicas of the prediction model is collected from a new GCP serviceaiplatform
. Since its a new service which is not supported by default in this metricset, the user provides the servicelabel (resource.label.location), for which user wants to filter the incoming data- module: gcp metricsets: - metrics project_id: "elastic-observability" credentials_json: "your JSON credentials" exclude_labels: false period: 1m location_label: "resource.label.location" # This is an optional configuration regions: - us-east4 metrics: - service: aiplatform metric_types: - "prediction/online/replicas"
For a description of each field in the metricset, see the exported fields section.
Here is an example document generated by this metricset:
{ "@timestamp": "2017-10-12T08:05:34.853Z", "cloud": { "account": { "id": "elastic-observability", "name": "elastic-observability" }, "instance": { "id": "4049989596327614796", "name": "nchaulet-loadtest-horde-master" }, "machine": { "type": "n1-standard-8" }, "provider": "gcp" }, "cloud.availability_zone": "us-central1-a", "cloud.region": "us-central1", "event": { "dataset": "gcp.metrics", "duration": 115000, "module": "gcp" }, "gcp": { "labels": {}, "metrics": { "instance": { "uptime_total": { "value": 791820 } } } }, "host": { "id": "4049989596327614796", "name": "nchaulet-loadtest-horde-master" }, "metricset": { "name": "metrics", "period": 10000 }, "service": { "type": "gcp" } }
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now