- 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
- Specify SSL settings
- Filter and enhance the exported data
- Parse data by using ingest node
- Set up project paths
- Set up 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
- metricbeat.reference.yml
- Modules
- Aerospike module
- Apache module
- Ceph module
- Couchbase module
- Docker module
- Dropwizard module
- Elasticsearch module
- Etcd module
- Golang module
- Graphite module
- HAProxy module
- HTTP module
- Jolokia module
- Kafka module
- Kibana module
- Kubernetes module
- Kubernetes container metricset
- Kubernetes event metricset
- Kubernetes node metricset
- Kubernetes pod metricset
- Kubernetes state_container 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
- Munin module
- MySQL module
- Nginx module
- PHP_FPM module
- PostgreSQL module
- Prometheus module
- RabbitMQ module
- Redis module
- System module
- System core metricset
- System cpu metricset
- System diskio 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 raid MetricSet
- System socket metricset
- System uptime metricset
- uwsgi module
- vSphere module
- Windows module
- ZooKeeper module
- Exported fields
- Aerospike fields
- Apache fields
- Beat fields
- Ceph fields
- Cloud provider metadata fields
- Common fields
- Couchbase fields
- Docker fields
- Docker fields
- Dropwizard fields
- Elasticsearch fields
- Etcd fields
- Golang fields
- Graphite fields
- HAProxy fields
- Host fields
- HTTP fields
- Jolokia fields
- Kafka fields
- Kibana fields
- Kubernetes fields
- Kubernetes fields
- kvm fields
- Logstash fields
- Memcached fields
- MongoDB fields
- Munin fields
- MySQL fields
- Nginx fields
- PHP_FPM fields
- PostgreSQL fields
- Prometheus fields
- RabbitMQ fields
- Redis fields
- System fields
- uwsgi fields
- vSphere fields
- Windows fields
- ZooKeeper fields
- Monitoring Metricbeat
- Securing Metricbeat
- Troubleshooting
- Contributing to Beats
Windows perfmon metricset
editWindows perfmon 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.
The perfmon
metricset of the Windows module reads Windows performance
counters.
Configuration
editYou must configure queries for the Windows performance counters that you wish to collect. The example below collects processor time and disk writes every 10 seconds. If either of the counters do not exist it will ignore the error.
- module: windows metricsets: [perfmon] period: 10s perfmon.ignore_non_existent_counters: true perfmon.counters: - instance_label: processor.name instance_name: total measurement_label: processor.time.total.pct query: '\Processor Information(_Total)\% Processor Time' - instance_label: physical_disk.name measurement_label: physical_disk.write.per_sec query: '\PhysicalDisk(*)\Disk Writes/sec' - instance_label: physical_disk.name measurement_label: physical_disk.write.time.pct query: '\PhysicalDisk(*)\% Disk Write Time'
-
ignore_non_existent_counters
- A boolean option that causes the metricset to ignore errors caused by counters that do not exist when set to true. Instead of an error, a message will be logged at the info level stating that the counter does not exist.
-
counters
-
Counters specifies a list of queries to perform. Each individual
counter requires three config options -
instance_label
,measurement_label
, andquery
.
Counter Configuration
editEach item in the counters
list specifies a perfmon query to perform. In the
events generated by the metricset these configuration options map to the field
values as shown below.
"%[instance_label]": "%[instance_name] or <perfmon_counter_name>", "%[measurement_label]": <perfmon_counter_value>,
-
instance_label
- The label used to identify the counter instance. This field is required.
-
instance_name
-
The instance name to use in the event when the counter’s path (
query
) does not include an instance or when you want to override the instance name. For example with\Processor Information(_Total)
the instance name would be_Total
and by settinginstance_name: total
you can override the value.The setting has no effect with wildcard queries (e.g.
\PhysicalDisk(*)\Disk Writes/sec
). -
measurement_label
- The label used for the value returned by the query. This field is required.
-
query
-
The perfmon query. This is the counter path specified in
Performance Data Helper (PDH) syntax. This field is required. For example
\Processor Information(_Total)\% Processor Time
. An asterisk can be used in place of an instance name to perform a wildcard query that generates an event for each counter instance (e.g.\PhysicalDisk(*)\Disk Writes/sec
). -
format
-
Format of the measurement value. The value can be either
float
orlong
. The default isfloat
.
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", "beat": { "hostname": "host.example.com", "name": "host.example.com" }, "metricset": { "module": "windows", "name": "perfmon", "rtt": 115 }, "windows": { "perfmon": { "processor": { "name": "_Total", "time": { "total": { "pct": 1.4663385364361736 } } } } } }
On this page