- 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
- community_id
- convert
- copy_fields
- decode_base64_field
- 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
- rate_limit
- registered_domain
- rename
- script
- translate_sid
- truncate_fields
- urldecode
- Autodiscover
- Internal queue
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- metricbeat.reference.yml
- How to guides
- Modules
- ActiveMQ module
- Aerospike module
- Airflow module
- Apache module
- App Search module
- AWS module
- 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
- 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 ml_job metricset
- Elasticsearch node metricset
- Elasticsearch node_stats metricset
- Elasticsearch pending_tasks metricset
- Elasticsearch shard metricset
- Envoyproxy module
- Etcd module
- Google Cloud Platform module
- 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
- MongoDB module
- MSSQL module
- Munin module
- MySQL module
- NATS module
- Nginx module
- Openmetrics module
- Oracle 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
- App Search 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
- Coredns fields
- Couchbase fields
- CouchDB fields
- Docker fields
- Docker fields
- Dropwizard fields
- ECS fields
- Elasticsearch 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
- 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
- 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
- Contribute to Beats
Google Cloud Platform pubsub metricset
editGoogle Cloud Platform pubsub metricset
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
PubSub metricsetf fetches metrics from Pub/Sub topics and subscriptions in Google Cloud Platform.
The pubsub
metricset contains all GA stage metrics exported from the Stackdriver API. The field names have been left untouched for people already familiar with them.
No special permissions are needed apart from the ones detailed in the module section of the docs.
Metrics
editHere is a list of metrics collected by pubsub
metricset:
Snapshot Metrics
edit-
pubsub.snapshot.backlog_bytes
: Total byte size of the messages retained in a snapshot. -
pubsub.snapshot.backlog_bytes_by_region
: Total byte size of the messages retained in a snapshot, broken down by Cloud region. -
pubsub.snapshot.config_updates_count
: Cumulative count of configuration changes, grouped by operation type and result. -
pubsub.snapshot.num_messages
: Number of messages retained in a snapshot. Sampled every 60 seconds. -
pubsub.snapshot.num_messages_by_region
: Number of messages retained in a snapshot, broken down by Cloud region. -
pubsub.snapshot.oldest_message_age
: Age (in seconds) of the oldest message retained in a snapshot. -
pubsub.snapshot.oldest_message_age_by_region
: Age (in seconds) of the oldest message retained in a snapshot, broken down by Cloud region.
Subscription Metrics
edit-
pubsub.subscription.ack_message_count
: Cumulative count of messages acknowledged by Acknowledge requests, grouped by delivery type. -
pubsub.subscription.backlog_bytes
: Total byte size of the unacknowledged messages (a.k.a. backlog messages) in a subscription. -
pubsub.subscription.byte_cost
: Cumulative cost of operations, measured in bytes. This is used to measure quota utilization. -
pubsub.subscription.config_updates_count
: Cumulative count of configuration changes for each subscription, grouped by operation type and result. -
pubsub.subscription.dead_letter_message_count
: Cumulative count of messages published to dead letter topic, grouped by result. -
pubsub.subscription.mod_ack_deadline_message_count
: Cumulative count of messages whose deadline was updated by ModifyAckDeadline requests, grouped by delivery type. -
pubsub.subscription.mod_ack_deadline_message_operation_count
: Cumulative count of ModifyAckDeadline message operations, grouped by result. -
pubsub.subscription.mod_ack_deadline_request_count
: Cumulative count of ModifyAckDeadline requests, grouped by result. -
pubsub.subscription.num_outstanding_messages
: Number of messages delivered to a subscription’s push endpoint, but not yet acknowledged. -
pubsub.subscription.num_undelivered_messages
: Number of unacknowledged messages (a.k.a. backlog messages) in a subscription. -
pubsub.subscription.oldest_retained_acked_message_age
: Age (in seconds) of the oldest acknowledged message retained in a subscription. -
pubsub.subscription.oldest_retained_acked_message_age_by_region
: Age (in seconds) of the oldest acknowledged message retained in a subscription, broken down by Cloud region. -
pubsub.subscription.oldest_unacked_message_age
: Age (in seconds) of the oldest unacknowledged message (a.k.a. backlog message) in a subscription. -
pubsub.subscription.oldest_unacked_message_age_by_region
: Age (in seconds) of the oldest unacknowledged message in a subscription, broken down by Cloud region. -
pubsub.subscription.pull_ack_message_operation_count
: Cumulative count of acknowledge message operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric subscription/mod_ack_deadline_message_operation_count. -
pubsub.subscription.pull_ack_request_count
: Cumulative count of acknowledge requests, grouped by result. -
pubsub.subscription.pull_message_operation_count
: Cumulative count of pull message operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric subscription/mod_ack_deadline_message_operation_count. -
pubsub.subscription.pull_request_count
: Cumulative count of pull requests, grouped by result. -
pubsub.subscription.push_request_count
: Cumulative count of push attempts, grouped by result. Unlike pulls, the push server implementation does not batch user messages. So each request only contains one user message. The push server retries on errors, so a given user message can appear multiple times. -
pubsub.subscription.retained_acked_bytes
: otal byte size of the acknowledged messages retained in a subscription. -
pubsub.subscription.retained_acked_bytes_by_region
: Total byte size of the acknowledged messages retained in a subscription, broken down by Cloud region. -
pubsub.subscription.seek_request_count
: Cumulative count of seek attempts, grouped by result. -
pubsub.subscription.sent_message_count
: Cumulative count of messages sent by Cloud Pub/Sub to subscriber clients, grouped by delivery type. -
pubsub.subscription.streaming_pull_ack_message_operation_count
: Cumulative count of StreamingPull acknowledge message operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric subscription/mod_ack_deadline_message_operation_count. -
pubsub.subscription.streaming_pull_ack_request_count
: Cumulative count of streaming pull requests with non-empty acknowledge ids, grouped by result. -
pubsub.subscription.streaming_pull_message_operation_count
: Cumulative count of streaming pull message operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric <code>subscription/mod_ack_deadline_message_operation_count -
pubsub.subscription.streaming_pull_mod_ack_deadline_message_operation_count
: Cumulative count of StreamingPull ModifyAckDeadline operations, grouped by result. -
pubsub.subscription.streaming_pull_mod_ack_deadline_request_count
: Cumulative count of streaming pull requests with non-empty ModifyAckDeadline fields, grouped by result. -
pubsub.subscription.streaming_pull_response_count
: Cumulative count of streaming pull responses, grouped by result. -
pubsub.subscription.unacked_bytes_by_region
: Total byte size of the unacknowledged messages in a subscription, broken down by Cloud region.
Topic Metrics
edit-
pubsub.topic.byte_cost
: Cost of operations, measured in bytes. This is used to measure utilization for quotas. -
pubsub.topic.config_updates_count
: Cumulative count of configuration changes, grouped by operation type and result. -
pubsub.topic.oldest_retained_acked_message_age_by_region
: Age (in seconds) of the oldest acknowledged message retained in a topic, broken down by Cloud region. -
pubsub.topic.oldest_unacked_message_age_by_region
: Age (in seconds) of the oldest unacknowledged message in a topic, broken down by Cloud region. -
pubsub.topic.retained_acked_bytes_by_region
: Total byte size of the acknowledged messages retained in a topic, broken down by Cloud region. -
pubsub.topic.send_message_operation_count
: Cumulative count of publish message operations, grouped by result. For a definition of message operations, see Cloud Pub/Sub metric subscription/mod_ack_deadline_message_operation_count. -
pubsub.topic.send_request_count
: Cumulative count of publish requests, grouped by result. -
pubsub.topic.unacked_bytes_by_region
: Total byte size of the unacknowledged messages in a topic, broken down by Cloud region.
This is a default metricset. If the host module is unconfigured, this metricset is enabled by default.
Fields
editFor 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" }, "provider": "gcp" }, "event": { "dataset": "gcp.pubsub", "duration": 115000, "module": "gcp" }, "gcp": { "labels": { "resource": { "subscription_id": "test-subscription-1" } }, "pubsub": { "subscription": { "backlog_bytes": { "value": 0 } } } }, "metricset": { "name": "pubsub", "period": 10000 }, "service": { "type": "gcp" } }