- Metricbeat Reference: other versions:
- Overview
- Getting started with Metricbeat
- Setting up and running Metricbeat
- Upgrading Metricbeat
- How Metricbeat works
- Configuring Metricbeat
- Specify which modules to run
- Specify general settings
- Load external configuration files
- Configure the internal queue
- Configure the output
- Configure index lifecycle management
- Specify SSL settings
- Filter and enhance the exported data
- Define processors
- Add cloud metadata
- Add fields
- Add labels
- Add the local time zone
- Add tags
- Decode JSON fields
- Decode Base64 fields
- Decompress gzip fields
- Community ID Network Flow Hash
- Convert
- Drop events
- Drop fields from events
- Extract array
- Keep fields from events
- Registered Domain
- Rename fields from events
- Add Kubernetes metadata
- Add Docker metadata
- Add Host metadata
- Add Observer metadata
- Dissect strings
- DNS Reverse Lookup
- Add process metadata
- Parse data by using ingest node
- Enrich events with geoIP information
- Configure project paths
- Configure the Kibana endpoint
- Load the Kibana dashboards
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- metricbeat.reference.yml
- Beats central management
- Modules
- Aerospike module
- Apache module
- aws module
- Beat module
- Ceph module
- CockroachDB module
- consul module
- coredns module
- Couchbase module
- couchdb module
- Docker module
- Dropwizard module
- Elasticsearch module
- Elasticsearch ccr metricset
- Elasticsearch cluster_stats metricset
- Elasticsearch index metricset
- Elasticsearch index_recovery metricset
- Elasticsearch index_summary metricset
- Elasticsearch ml_job metricset
- Elasticsearch node metricset
- Elasticsearch node_stats metricset
- Elasticsearch pending_tasks metricset
- Elasticsearch shard metricset
- envoyproxy module
- Etcd module
- Golang module
- Graphite module
- HAProxy module
- HTTP 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_deployment metricset
- Kubernetes state_node metricset
- Kubernetes state_pod metricset
- Kubernetes state_replicaset metricset
- Kubernetes state_statefulset metricset
- Kubernetes system metricset
- Kubernetes volume metricset
- kvm module
- Logstash module
- Memcached module
- MongoDB module
- MSSQL module
- Munin module
- MySQL module
- Nats module
- Nginx module
- Oracle module
- PHP_FPM module
- PostgreSQL module
- Prometheus module
- RabbitMQ module
- Redis module
- Statsd 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 process metricset
- System process_summary metricset
- System raid metricset
- System socket metricset
- System socket_summary metricset
- System uptime metricset
- traefik module
- uwsgi module
- vSphere module
- Windows module
- ZooKeeper module
- Exported fields
- Aerospike fields
- Apache fields
- aws fields
- Beat fields
- Beat fields
- Ceph fields
- Cloud provider metadata fields
- CockroachDB fields
- Common fields
- consul fields
- coredns fields
- Couchbase fields
- couchdb fields
- Docker fields
- Docker fields
- Dropwizard fields
- ECS fields
- Elasticsearch fields
- envoyproxy fields
- Etcd fields
- Golang fields
- Graphite fields
- HAProxy fields
- Host fields
- HTTP fields
- Jolokia fields
- Jolokia Discovery autodiscover provider fields
- Kafka fields
- Kibana fields
- Kubernetes fields
- Kubernetes fields
- kvm fields
- Logstash fields
- Memcached fields
- MongoDB fields
- MSSQL fields
- Munin fields
- MySQL fields
- Nats fields
- Nginx fields
- Oracle fields
- PHP_FPM fields
- PostgreSQL fields
- Process fields
- Prometheus fields
- RabbitMQ fields
- Redis fields
- Statsd fields
- System fields
- traefik fields
- uwsgi fields
- vSphere fields
- Windows fields
- ZooKeeper fields
- Monitoring Metricbeat
- Securing Metricbeat
- Troubleshooting
- Get help
- Debug
- 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
- @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
- Contributing to Beats
aws fields
editaws fields
editaws module collects AWS monitoring metrics from AWS Cloudwatch.
aws
edit-
aws.tags.* -
Tag key value pairs from aws resources.
type: object
cloudwatch
editcloudwatch contains the metrics that were scraped from AWS CloudWatch which contains monitoring metrics sent by different namespaces.
-
aws.cloudwatch.namespace -
The namespace specified when query cloudwatch api.
type: keyword
-
aws.cloudwatch.metrics.*.* -
Metrics that returned from Cloudwatch api query.
type: object
-
aws.cloudwatch.dimensions.* -
Cloudwatch metric dimensions.
type: object
ebs
editebs contains the metrics that were scraped from AWS CloudWatch which contains monitoring metrics sent by AWS EBS.
ec2
editec2 contains the metrics that were scraped from AWS CloudWatch which contains monitoring metrics sent by AWS EC2.
-
aws.ec2.cpu.total.pct -
The percentage of allocated EC2 compute units that are currently in use on the instance.
type: scaled_float
-
aws.ec2.cpu.credit_usage -
The number of CPU credits spent by the instance for CPU utilization.
type: long
-
aws.ec2.cpu.credit_balance -
The number of earned CPU credits that an instance has accrued since it was launched or started.
type: long
-
aws.ec2.cpu.surplus_credit_balance -
The number of surplus credits that have been spent by an unlimited instance when its CPUCreditBalance value is zero.
type: long
-
aws.ec2.cpu.surplus_credits_charged -
The number of spent surplus credits that are not paid down by earned CPU credits, and which thus incur an additional charge.
type: long
-
aws.ec2.network.in.packets -
The number of packets received on all network interfaces by the instance.
type: long
-
aws.ec2.network.in.packets_per_sec -
The number of packets per second sent out on all network interfaces by the instance.
type: long
-
aws.ec2.network.out.packets -
The number of packets sent out on all network interfaces by the instance.
type: long
-
aws.ec2.network.out.packets_per_sec -
The number of packets per second sent out on all network interfaces by the instance.
type: long
-
aws.ec2.network.in.bytes -
The number of bytes received on all network interfaces by the instance.
type: long
format: bytes
-
aws.ec2.network.in.bytes_per_sec -
The number of bytes per second received on all network interfaces by the instance.
type: long
-
aws.ec2.network.out.bytes -
The number of bytes sent out on all network interfaces by the instance.
type: long
format: bytes
-
aws.ec2.network.out.bytes_per_sec -
The number of bytes per second sent out on all network interfaces by the instance.
type: long
-
aws.ec2.diskio.read.bytes -
Bytes read from all instance store volumes available to the instance.
type: long
format: bytes
-
aws.ec2.diskio.read.bytes_per_sec -
Bytes read per second from all instance store volumes available to the instance.
type: long
-
aws.ec2.diskio.write.bytes -
Bytes written to all instance store volumes available to the instance.
type: long
format: bytes
-
aws.ec2.diskio.write.bytes_per_sec -
Bytes written per second to all instance store volumes available to the instance.
type: long
-
aws.ec2.diskio.read.ops -
Completed read operations from all instance store volumes available to the instance in a specified period of time.
type: long
-
aws.ec2.diskio.read.ops_per_sec -
Completed read operations per second from all instance store volumes available to the instance in a specified period of time.
type: long
-
aws.ec2.diskio.write.ops -
Completed write operations to all instance store volumes available to the instance in a specified period of time.
type: long
-
aws.ec2.diskio.write.ops_per_sec -
Completed write operations per second to all instance store volumes available to the instance in a specified period of time.
type: long
-
aws.ec2.status.check_failed -
Reports whether the instance has passed both the instance status check and the system status check in the last minute.
type: long
-
aws.ec2.status.check_failed_system -
Reports whether the instance has passed the system status check in the last minute.
type: long
-
aws.ec2.status.check_failed_instance -
Reports whether the instance has passed the instance status check in the last minute.
type: long
-
aws.ec2.instance.core.count -
The number of CPU cores for the instance.
type: integer
-
aws.ec2.instance.image.id -
The ID of the image used to launch the instance.
type: keyword
-
aws.ec2.instance.monitoring.state -
Indicates whether detailed monitoring is enabled.
type: keyword
-
aws.ec2.instance.private.dns_name -
The private DNS name of the network interface.
type: keyword
-
aws.ec2.instance.private.ip -
The private IPv4 address associated with the network interface.
type: ip
-
aws.ec2.instance.public.dns_name -
The public DNS name of the instance.
type: keyword
-
aws.ec2.instance.public.ip -
The address of the Elastic IP address (IPv4) bound to the network interface.
type: ip
-
aws.ec2.instance.state.code -
The state of the instance, as a 16-bit unsigned integer.
type: integer
-
aws.ec2.instance.state.name -
The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
type: keyword
-
aws.ec2.instance.threads_per_core -
The number of threads per CPU core.
type: integer
elb
editelb contains the metrics that were scraped from AWS CloudWatch which contains monitoring metrics sent by AWS ELB.
rds
editrds contains the metrics that were scraped from AWS CloudWatch which contains monitoring metrics sent by AWS RDS.
-
aws.rds.cpu.total.pct -
The percentage of CPU utilization.
type: scaled_float
format: percent
-
aws.rds.cpu.credit_usage -
The number of CPU credits spent by the instance for CPU utilization.
type: long
-
aws.rds.cpu.credit_balance -
The number of earned CPU credits that an instance has accrued since it was launched or started.
type: long
-
aws.rds.database_connections -
The number of database connections in use.
type: long
-
aws.rds.db_instance.arn -
Amazon Resource Name(ARN) for each rds.
type: keyword
-
aws.rds.db_instance.class -
Contains the name of the compute and memory capacity class of the DB instance.
type: keyword
-
aws.rds.db_instance.identifier -
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
type: keyword
-
aws.rds.db_instance.status -
Specifies the current state of this database.
type: keyword
-
aws.rds.disk_queue_depth -
The number of outstanding IOs (read/write requests) waiting to access the disk.
type: float
-
aws.rds.failed_sql_server_agent_jobs -
The number of failed SQL Server Agent jobs during the last minute.
type: long
-
aws.rds.freeable_memory.bytes -
The amount of available random access memory.
type: long
format: bytes
-
aws.rds.free_storage.bytes -
The amount of available storage space.
type: long
format: bytes
-
aws.rds.maximum_used_transaction_ids -
The maximum transaction ID that has been used. Applies to PostgreSQL.
type: long
-
aws.rds.oldest_replication_slot_lag.mb -
The lagging size of the replica lagging the most in terms of WAL data received. Applies to PostgreSQL.
type: long
-
aws.rds.read_io.ops_per_sec -
The average number of disk read I/O operations per second.
type: float
-
aws.rds.replica_lag.sec -
The amount of time a Read Replica DB instance lags behind the source DB instance. Applies to MySQL, MariaDB, and PostgreSQL Read Replicas.
type: long
format: duration
-
aws.rds.swap_usage.bytes -
The amount of swap space used on the DB instance. This metric is not available for SQL Server.
type: long
format: bytes
-
aws.rds.transaction_logs_generation -
The disk space used by transaction logs. Applies to PostgreSQL.
type: long
-
aws.rds.write_io.ops_per_sec -
The average number of disk write I/O operations per second.
type: float
-
aws.rds.queries -
The average number of queries executed per second.
type: long
-
aws.rds.deadlocks -
The average number of deadlocks in the database per second.
type: long
-
aws.rds.volume_used.bytes -
The amount of storage used by your Aurora DB instance, in bytes.
type: long
format: bytes
-
aws.rds.free_local_storage.bytes -
The amount of storage available for temporary tables and logs, in bytes.
type: long
format: bytes
-
aws.rds.login_failures -
The average number of failed login attempts per second.
type: long
-
aws.rds.throughput.commit -
The average number of commit operations per second.
type: float
-
aws.rds.throughput.delete -
The average number of delete queries per second.
type: float
-
aws.rds.throughput.ddl -
The average number of DDL requests per second.
type: float
-
aws.rds.throughput.dml -
The average number of inserts, updates, and deletes per second.
type: float
-
aws.rds.throughput.insert -
The average number of insert queries per second.
type: float
-
aws.rds.throughput.network -
The amount of network throughput both received from and transmitted to clients by each instance in the Aurora MySQL DB cluster, in bytes per second.
type: float
-
aws.rds.throughput.network_receive -
The incoming (Receive) network traffic on the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication.
type: float
-
aws.rds.throughput.network_transmit -
The outgoing (Transmit) network traffic on the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication.
type: float
-
aws.rds.throughput.read -
The average amount of time taken per disk I/O operation.
type: float
-
aws.rds.throughput.select -
The average number of select queries per second.
type: float
-
aws.rds.throughput.update -
The average number of update queries per second.
type: float
-
aws.rds.throughput.write -
The average number of bytes written to disk per second.
type: float
-
aws.rds.latency.commit -
The amount of latency for commit operations, in milliseconds.
type: float
format: duration
-
aws.rds.latency.ddl -
The amount of latency for data definition language (DDL) requests, in milliseconds.
type: float
format: duration
-
aws.rds.latency.dml -
The amount of latency for inserts, updates, and deletes, in milliseconds.
type: float
format: duration
-
aws.rds.latency.insert -
The amount of latency for insert queries, in milliseconds.
type: float
format: duration
-
aws.rds.latency.read -
The average amount of time taken per disk I/O operation.
type: float
format: duration
-
aws.rds.latency.select -
The amount of latency for select queries, in milliseconds.
type: float
format: duration
-
aws.rds.latency.update -
The amount of latency for update queries, in milliseconds.
type: float
format: duration
-
aws.rds.latency.write -
The average amount of time taken per disk I/O operation.
type: float
format: duration
-
aws.rds.disk_usage.bin_log.bytes -
The amount of disk space occupied by binary logs on the master. Applies to MySQL read replicas.
type: long
format: bytes
-
aws.rds.disk_usage.replication_slot.mb -
The disk space used by replication slot files. Applies to PostgreSQL.
type: long
-
aws.rds.disk_usage.transaction_logs.mb -
The disk space used by transaction logs. Applies to PostgreSQL.
type: long
-
aws.rds.transactions.active -
The average number of current transactions executing on an Aurora database instance per second.
type: long
-
aws.rds.transactions.blocked -
The average number of transactions in the database that are blocked per second.
type: long
s3_daily_storage
edits3_daily_storage contains the daily storage metrics that were scraped from AWS CloudWatch which contains monitoring metrics sent by AWS S3.
-
aws.s3_daily_storage.bucket.name -
Name of a S3 bucket.
type: keyword
-
aws.s3_daily_storage.bucket.size.bytes -
The amount of data in bytes stored in a bucket.
type: long
format: bytes
-
aws.s3_daily_storage.number_of_objects -
The total number of objects stored in a bucket for all storage classes.
type: long
s3_request
edits3_request contains request metrics that were scraped from AWS CloudWatch which contains monitoring metrics sent by AWS S3.
-
aws.s3_request.bucket.name -
Name of a S3 bucket.
type: keyword
-
aws.s3_request.requests.total -
The total number of HTTP requests made to an Amazon S3 bucket, regardless of type.
type: long
-
aws.s3_request.requests.get -
The number of HTTP GET requests made for objects in an Amazon S3 bucket.
type: long
-
aws.s3_request.requests.put -
The number of HTTP PUT requests made for objects in an Amazon S3 bucket.
type: long
-
aws.s3_request.requests.delete -
The number of HTTP DELETE requests made for objects in an Amazon S3 bucket.
type: long
-
aws.s3_request.requests.head -
The number of HTTP HEAD requests made to an Amazon S3 bucket.
type: long
-
aws.s3_request.requests.post -
The number of HTTP POST requests made to an Amazon S3 bucket.
type: long
-
aws.s3_request.requests.select -
The number of Amazon S3 SELECT Object Content requests made for objects in an Amazon S3 bucket.
type: long
-
aws.s3_request.requests.select_scanned.bytes -
The number of bytes of data scanned with Amazon S3 SELECT Object Content requests in an Amazon S3 bucket.
type: long
format: bytes
-
aws.s3_request.requests.select_returned.bytes -
The number of bytes of data returned with Amazon S3 SELECT Object Content requests in an Amazon S3 bucket.
type: long
format: bytes
-
aws.s3_request.requests.list -
The number of HTTP requests that list the contents of a bucket.
type: long
-
aws.s3_request.downloaded.bytes -
The number bytes downloaded for requests made to an Amazon S3 bucket, where the response includes a body.
type: long
format: bytes
-
aws.s3_request.uploaded.bytes -
The number bytes uploaded that contain a request body, made to an Amazon S3 bucket.
type: long
format: bytes
-
aws.s3_request.errors.4xx -
The number of HTTP 4xx client error status code requests made to an Amazon S3 bucket with a value of either 0 or 1.
type: long
-
aws.s3_request.errors.5xx -
The number of HTTP 5xx server error status code requests made to an Amazon S3 bucket with a value of either 0 or 1.
type: long
-
aws.s3_request.latency.first_byte.ms -
The per-request time from the complete request being received by an Amazon S3 bucket to when the response starts to be returned.
type: long
format: duration
-
aws.s3_request.latency.total_request.ms -
The elapsed per-request time from the first byte received to the last byte sent to an Amazon S3 bucket.
type: long
format: duration
sqs
editsqs contains the metrics that were scraped from AWS CloudWatch which contains monitoring metrics sent by AWS SQS.
-
aws.sqs.oldest_message_age.sec -
The approximate age of the oldest non-deleted message in the queue.
type: long
format: duration
-
aws.sqs.messages.delayed -
TThe number of messages in the queue that are delayed and not available for reading immediately.
type: long
-
aws.sqs.messages.not_visible -
The number of messages that are in flight.
type: long
-
aws.sqs.messages.visible -
The number of messages available for retrieval from the queue.
type: long
-
aws.sqs.messages.deleted -
The number of messages deleted from the queue.
type: long
-
aws.sqs.messages.received -
The number of messages returned by calls to the ReceiveMessage action.
type: long
-
aws.sqs.messages.sent -
The number of messages added to a queue.
type: long
-
aws.sqs.empty_receives -
The number of ReceiveMessage API calls that did not return a message.
type: long
-
aws.sqs.sent_message_size.bytes -
The size of messages added to a queue.
type: long
format: bytes
-
aws.sqs.queue.name -
SQS queue name
type: keyword