openstack-ansible-ops/elk_metrics_6x/templates/metricbeat.yml.j2
Kevin Carter 83a64509c5
Update README, beat deployment, and configs
Beat set is using a loop to ship both templates and dashboards using
different commands. This is being done to ensure no data is lost or
mis-setup during index creation.

Packetbeat only needs to be installed on hosts

All of the beats are now using standard field templates.

Change-Id: Ie6220eb94a12780ad122ba367bf7654d97c212e8
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>
2018-04-12 02:59:55 -05:00

1408 lines
49 KiB
Django/Jinja

########################## Metricbeat Configuration ###########################
# This file is a full configuration example documenting all non-deprecated
# options in comments. For a shorter configuration example, that contains only
# the most common options, please see metricbeat.yml in the same directory.
#
# You can find the full configuration reference here:
# https://www.elastic.co/guide/en/beats/metricbeat/index.html
#============================ Config Reloading ===============================
# Config reloading allows to dynamically load modules. Each file which is
# monitored must contain one or multiple modules as a list.
metricbeat.config.modules:
# Glob pattern for configuration reloading
path: ${path.config}/conf.d/*.yml
# Period on which files under path should be checked for changes
reload.period: 10s
# Set to true to enable config reloading
reload.enabled: false
# Maximum amount of time to randomly delay the start of a metricset. Use 0 to
# disable startup delay.
metricbeat.max_start_delay: 10s
#============================== Autodiscover ===================================
# Autodiscover allows you to detect changes in the system and spawn new modules
# as they happen.
#metricbeat.autodiscover:
# List of enabled autodiscover providers
# providers:
# - type: docker
# templates:
# - condition:
# equals.docker.container.image: etcd
# config:
# - module: etcd
# metricsets: ["leader", "self", "store"]
# period: 10s
# hosts: ["${host}:2379"]
#========================== Modules configuration ============================
metricbeat.modules:
#------------------------------- System Module -------------------------------
- module: system
metricsets:
- cpu # CPU usage
- filesystem # File system usage for each mountpoint
- fsstat # File system summary metrics
- load # CPU load averages
- memory # Memory usage
- network # Network IO
- process # Per process metrics
- process_summary # Process summary
- uptime # System Uptime
- core # Per CPU core usage
- diskio # Disk IO
- socket # Sockets and connection info (linux only)
enabled: true
period: 10s
processes: ['.*']
# Configure the metric types that are included by these metricsets.
cpu.metrics: ["percentages"] # The other available options are normalized_percentages and ticks.
core.metrics: ["percentages"] # The other available option is ticks.
# A list of filesystem types to ignore. The filesystem metricset will not
# collect data from filesystems matching any of the specified types, and
# fsstats will not include data from these filesystems in its summary stats.
#filesystem.ignore_types: []
# These options allow you to filter out all processes that are not
# in the top N by CPU or memory, in order to reduce the number of documents created.
# If both the `by_cpu` and `by_memory` options are used, the union of the two sets
# is included.
process.include_top_n:
#
# Set to false to disable this feature and include all processes
enabled: true
# How many processes to include from the top by CPU. The processes are sorted
# by the `system.process.cpu.total.pct` field.
by_cpu: 20
# How many processes to include from the top by memory. The processes are sorted
# by the `system.process.memory.rss.bytes` field.
by_memory: 20
# If false, cmdline of a process is not cached.
process.cmdline.cache.enabled: true
# Enable collection of cgroup metrics from processes on Linux.
process.cgroups.enabled: true
# A list of regular expressions used to whitelist environment variables
# reported with the process metricset's events. Defaults to empty.
#process.env.whitelist: []
# Include the cumulative CPU tick values with the process metrics. Defaults
# to false.
process.include_cpu_ticks: {{ inventory_hostname == physical_host }}
# Configure reverse DNS lookup on remote IP addresses in the socket metricset.
socket.reverse_lookup.enabled: true
socket.reverse_lookup.success_ttl: 60s
socket.reverse_lookup.failure_ttl: 60s
##------------------------------ Aerospike Module -----------------------------
#- module: aerospike
# metricsets: ["namespace"]
# enabled: false
# period: 10s
# hosts: ["localhost:3000"]
#
##------------------------------- Apache Module -------------------------------
{% if apache_enabled | default(false) | bool %}
- module: apache
metricsets: ["status"]
period: 10s
#
# # Apache hosts
hosts: ["http://127.0.0.1"]
#
# # Path to server status. Default server-status
# #server_status_path: "server-status"
#
# # Username of hosts. Empty by default
# #username: username
#
# # Password of hosts. Empty by default
# #password: password
{% endif %}
#
#-------------------------------- Ceph Module --------------------------------
{% if inventory_hostname in groups['ceph-mon'] | default([]) %}
- module: ceph
metricsets: ["cluster_disk", "cluster_health", "monitor_health", "pool_disk", "osd_tree"]
period: 10s
hosts: ["localhost:5000"]
#
{% endif %}
##------------------------------ Couchbase Module -----------------------------
#- module: couchbase
# metricsets: ["bucket", "cluster", "node"]
# period: 10s
# hosts: ["localhost:8091"]
#
##------------------------------- Docker Module -------------------------------
#- module: docker
# metricsets: ["container", "cpu", "diskio", "healthcheck", "info", "memory", "network"]
# hosts: ["unix:///var/run/docker.sock"]
# period: 10s
#
# # To connect to Docker over TLS you must specify a client and CA certificate.
# #ssl:
# #certificate_authority: "/etc/pki/root/ca.pem"
# #certificate: "/etc/pki/client/cert.pem"
# #key: "/etc/pki/client/cert.key"
#
##----------------------------- Dropwizard Module -----------------------------
#- module: dropwizard
# metricsets: ["collector"]
# period: 10s
# hosts: ["localhost:8080"]
# metrics_path: /metrics/metrics
# namespace: example
#
##---------------------------- Elasticsearch Module ---------------------------
{% if inventory_hostname in groups['elastic-logstash'] | default([]) %}
- module: elasticsearch
metricsets: ["node", "node_stats"]
period: 10s
hosts: ["localhost:9200"]
#
{% endif %}
##-------------------------------- Etcd Module --------------------------------
#- module: etcd
# metricsets: ["leader", "self", "store"]
# period: 10s
# hosts: ["localhost:2379"]
#
#
##------------------------------- Golang Module -------------------------------
#- module: golang
# metricsets: ["expvar","heap"]
# period: 10s
# hosts: ["localhost:6060"]
# heap.path: "/debug/vars"
# expvar:
# namespace: "example"
# path: "/debug/vars"
#
##------------------------------ Graphite Module ------------------------------
#- module: graphite
# metricsets: ["server"]
# enabled: true
## protocol: "udp"
## templates:
## - filter: "test.*.bash.*" # This would match metrics like test.localhost.bash.stats
## namespace: "test"
## template: ".host.shell.metric*" # test.localhost.bash.stats would become metric=stats and tags host=localhost,shell=bash
## delimiter: "_"
#
#
##------------------------------- HAProxy Module ------------------------------
{% if inventory_hostname in groups['haproxy_all'] | default([]) %}
- module: haproxy
metricsets: ["info", "stat"]
period: 10s
hosts: ["tcp://127.0.0.1:14567"]
#
{% endif %}
##-------------------------------- HTTP Module --------------------------------
#- module: http
# metricsets: ["json"]
# period: 10s
# hosts: ["localhost:80"]
# namespace: "json_namespace"
# path: "/"
# #body: ""
# #method: "GET"
# #request.enabled: false
# #response.enabled: false
# #dedot.enabled: false
#
{% if inventory_hostname in groups['utility_all'] | default([]) %}
{% set haproxy_host = hostvars[groups['haproxy_all'][0]] %}
{% for item in haproxy_host['haproxy_default_services'] + haproxy_extra_services | default([]) %}
{% set item_service = item['service'] %}
{% for backend in item_service['haproxy_backend_nodes'] + item_service['haproxy_backup_nodes'] | default([]) %}
{% set port = item_service['haproxy_check_port'] | default(item_service['haproxy_port']) %}
- module: http
metricsets: ["server"]
host: "{{ backend }}"
port: "{{ port }}"
enabled: true
method: "{{ (item_service['haproxy_backend_options'] | default(['check', 'HEAD', '/']))[0].split()[1] | default('GET') }}"
path: "{{ (item_service['haproxy_backend_options'] | default(['check', 'HEAD', '/']))[0].split()[2] | default('/') }}"
{% endfor %}
{% endfor %}
{% endif %}
#
##------------------------------- Jolokia Module ------------------------------
#- module: jolokia
# metricsets: ["jmx"]
# period: 10s
# hosts: ["localhost"]
# namespace: "metrics"
# path: "/jolokia/?ignoreErrors=true&canonicalNaming=false"
# jmx.mapping:
# jmx.application:
# jmx.instance:
#
##-------------------------------- Kafka Module -------------------------------
#- module: kafka
# metricsets: ["partition"]
# period: 10s
# hosts: ["localhost:9092"]
#
# #client_id: metricbeat
# #retries: 3
# #backoff: 250ms
#
# # List of Topics to query metadata for. If empty, all topics will be queried.
# #topics: []
#
# # Optional SSL. By default is off.
# # List of root certificates for HTTPS server verifications
# #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
#
# # Certificate for SSL client authentication
# #ssl.certificate: "/etc/pki/client/cert.pem"
#
# # Client Certificate Key
# #ssl.key: "/etc/pki/client/cert.key"
#
# # SASL authentication
# #username: ""
# #password: ""
#
##------------------------------- Kibana Module -------------------------------
{% if inventory_hostname in groups['kibana'] | default([]) %}
- module: kibana
metricsets: ["status"]
period: 10s
hosts: ["localhost:{{ kibana_port }}"]
#
{% endif %}
##----------------------------- Kubernetes Module -----------------------------
## Node metrics, from kubelet:
#- module: kubernetes
# metricsets:
# - node
# - system
# - pod
# - container
# - volume
# period: 10s
# hosts: ["localhost:10255"]
#
## State metrics from kube-state-metrics service:
#- module: kubernetes
# enabled: false
# metricsets:
# - state_node
# - state_deployment
# - state_replicaset
# - state_pod
# - state_container
# period: 10s
# hosts: ["kube-state-metrics:8080"]
#
## Kubernetes events
#- module: kubernetes
# enabled: false
# metricsets:
# - event
#
##------------------------------ Logstash Module ------------------------------
{% if inventory_hostname in groups['elastic-logstash'] | default([]) %}
- module: logstash
metricsets: ["node", "node_stats"]
enabled: false
period: 10s
hosts: ["localhost:9600"]
#
#
{% endif %}
##------------------------------ Memcached Module -----------------------------
{% if inventory_hostname in groups['memcached_all'] | default([]) %}
- module: memcached
metricsets: ["stats"]
period: 10s
hosts: ["localhost:11211"]
{% endif %}
##------------------------------- MongoDB Module ------------------------------
#- module: mongodb
# metricsets: ["dbstats", "status"]
# period: 10s
#
# # The hosts must be passed as MongoDB URLs in the format:
# # [mongodb://][user:pass@]host[:port].
# # The username and password can also be set using the respective configuration
# # options. The credentials in the URL take precedence over the username and
# # password configuration options.
# hosts: ["localhost:27017"]
#
# # Username to use when connecting to MongoDB. Empty by default.
# #username: user
#
# # Password to use when connecting to MongoDB. Empty by default.
# #password: pass
#
##-------------------------------- MySQL Module -------------------------------
{% if (inventory_hostname in groups['galera_all'] | default([])) and galera_root_user is defined and galera_root_password is defined %}
- module: mysql
metricsets: ["status"]
period: 10s
#
# # Host DSN should be defined as "user:pass@tcp(127.0.0.1:3306)/"
# # The username and password can either be set in the DSN or using the username
# # and password config options. Those specified in the DSN take precedence.
hosts: ["{{ galera_root_user }}:{{ galera_root_password }}@tcp(127.0.0.1:3306)/"]
#
# # Username of hosts. Empty by default.
username: {{ galera_root_user }}
#
# # Password of hosts. Empty by default.
password: {{ galera_root_password }}
#
# # By setting raw to true, all raw fields from the status metricset will be added to the event.
# #raw: false
#
{% endif %}
##-------------------------------- Nginx Module -------------------------------
{% if nginx_enabled | default(false) | bool %}
- module: nginx
metricsets: ["stubstatus"]
enabled: true
period: 10s
# Nginx hosts
hosts: ["http://127.0.0.1"]
# Path to server status. Default server-status
server_status_path: "server-status"
{% endif %}
##------------------------------- PHP_FPM Module ------------------------------
#- module: php_fpm
# metricsets: ["pool"]
# period: 10s
# status_path: "/status"
# hosts: ["localhost:8080"]
#
##----------------------------- PostgreSQL Module -----------------------------
#- module: postgresql
# metricsets:
# # Stats about every PostgreSQL database
# - database
#
# # Stats about the background writer process's activity
# - bgwriter
#
# # Stats about every PostgreSQL process
# - activity
#
# period: 10s
#
# # The host must be passed as PostgreSQL URL. Example:
# # postgres://localhost:5432?sslmode=disable
# # The available parameters are documented here:
# # https://godoc.org/github.com/lib/pq#hdr-Connection_String_Parameters
# hosts: ["postgres://localhost:5432"]
#
# # Username to use when connecting to PostgreSQL. Empty by default.
# #username: user
#
# # Password to use when connecting to PostgreSQL. Empty by default.
# #password: pass
#
##----------------------------- Prometheus Module -----------------------------
#- module: prometheus
# metricsets: ["stats"]
# period: 10s
# hosts: ["localhost:9090"]
# metrics_path: /metrics
# #namespace: example
#
##------------------------------ RabbitMQ Module ------------------------------
{% if inventory_hostname in groups['rabbitmq_all'] | default([]) and rabbitmq_monitoring_password is defined %}
- module: rabbitmq
metricsets: ["node", "queue"]
period: 10s
hosts: ["localhost:15672"]
#
username: {{ rabbitmq_monitoring_userid | default('monitoring') }}
password: {{ rabbitmq_monitoring_password }}
#
{% endif %}
##-------------------------------- Redis Module -------------------------------
#- module: redis
# metricsets: ["info", "keyspace"]
# period: 10s
#
# # Redis hosts
# hosts: ["127.0.0.1:6379"]
#
# # Timeout after which time a metricset should return an error
# # Timeout is by default defined as period, as a fetch of a metricset
# # should never take longer then period, as otherwise calls can pile up.
# #timeout: 1s
#
# # Optional fields to be added to each event
# #fields:
# # datacenter: west
#
# # Network type to be used for redis connection. Default: tcp
# #network: tcp
#
# # Max number of concurrent connections. Default: 10
# #maxconn: 10
#
# # Filters can be used to reduce the number of fields sent.
# #processors:
# # - include_fields:
# # fields: ["beat", "metricset", "redis.info.stats"]
#
# # Redis AUTH password. Empty by default.
# #password: foobared
#
##-------------------------------- uwsgi Module -------------------------------
{% if uwsgi_enabled | default(false) | bool %}
- module: uwsgi
metricsets: ["status"]
period: 10s
hosts: ["tcp://127.0.0.1:9191"]
#
{% endif %}
##------------------------------- vSphere Module ------------------------------
#- module: vsphere
# metricsets: ["datastore", "host", "virtualmachine"]
# period: 10s
# hosts: ["https://localhost/sdk"]
#
# username: "user"
# password: "password"
# # If insecure is true, don't verify the server's certificate chain
# insecure: false
# # Get custom fields when using virtualmachine metric set. Default false.
# # get_custom_fields: false
#
#
##------------------------------- Windows Module ------------------------------
#- module: windows
# metricsets: ["perfmon"]
# period: 10s
# perfmon.counters:
#
#- module: windows
# metricsets: ["service"]
# period: 60s
#
##------------------------------ ZooKeeper Module -----------------------------
#- module: zookeeper
# metricsets: ["mntr"]
# period: 10s
# hosts: ["localhost:2181"]
#
#
#
##================================ General ======================================
#
## The name of the shipper that publishes the network data. It can be used to group
## all the transactions sent by a single shipper in the web interface.
## If this options is not defined, the hostname is used.
##name:
#
## The tags of the shipper are included in their own field with each
## transaction published. Tags make it easy to group servers by different
## logical properties.
##tags: ["service-X", "web-tier"]
#
## Optional fields that you can specify to add additional information to the
## output. Fields can be scalar values, arrays, dictionaries, or any nested
## combination of these.
##fields:
## env: staging
#
## If this option is set to true, the custom fields are stored as top-level
## fields in the output document instead of being grouped under a fields
## sub-dictionary. Default is false.
##fields_under_root: false
#
## Internal queue configuration for buffering events to be published.
##queue:
# # Queue type by name (default 'mem')
# # The memory queue will present all available events (up to the outputs
# # bulk_max_size) to the output, the moment the output is ready to server
# # another batch of events.
# #mem:
# # Max number of events the queue can buffer.
# #events: 4096
#
# # Hints the minimum number of events stored in the queue,
# # before providing a batch of events to the outputs.
# # A value of 0 (the default) ensures events are immediately available
# # to be sent to the outputs.
# #flush.min_events: 2048
#
# # Maximum duration after which events are available to the outputs,
# # if the number of events stored in the queue is < min_flush_events.
# #flush.timeout: 1s
#
## Sets the maximum number of CPUs that can be executing simultaneously. The
## default is the number of logical CPUs available in the system.
##max_procs:
#
##================================ Processors ===================================
#
## Processors are used to reduce the number of fields in the exported event or to
## enhance the event with external metadata. This section defines a list of
## processors that are applied one by one and the first one receives the initial
## event:
##
## event -> filter1 -> event1 -> filter2 ->event2 ...
##
## The supported processors are drop_fields, drop_event, include_fields, and
## add_cloud_metadata.
##
## For example, you can use the following processors to keep the fields that
## contain CPU load percentages, but remove the fields that contain CPU ticks
## values:
##
##processors:
##- include_fields:
## fields: ["cpu"]
##- drop_fields:
## fields: ["cpu.user", "cpu.system"]
##
## The following example drops the events that have the HTTP response code 200:
##
##processors:
##- drop_event:
## when:
## equals:
## http.code: 200
##
## The following example enriches each event with metadata from the cloud
## provider about the host machine. It works on EC2, GCE, DigitalOcean,
## Tencent Cloud, and Alibaba Cloud.
##
##processors:
##- add_cloud_metadata: ~
##
## The following example enriches each event with the machine's local time zone
## offset from UTC.
##
##processors:
##- add_locale:
## format: offset
##
## The following example enriches each event with docker metadata, it matches
## given fields to an existing container id and adds info from that container:
##
##processors:
##- add_docker_metadata:
## host: "unix:///var/run/docker.sock"
## match_fields: ["system.process.cgroup.id"]
## match_pids: ["process.pid", "process.ppid"]
## match_source: true
## match_source_index: 4
## cleanup_timeout: 60
## # To connect to Docker over TLS you must specify a client and CA certificate.
## #ssl:
## # certificate_authority: "/etc/pki/root/ca.pem"
## # certificate: "/etc/pki/client/cert.pem"
## # key: "/etc/pki/client/cert.key"
##
## The following example enriches each event with docker metadata, it matches
## container id from log path available in `source` field (by default it expects
## it to be /var/lib/docker/containers/*/*.log).
##
##processors:
##- add_docker_metadata: ~
#
##============================= Elastic Cloud ==================================
#
## These settings simplify using metricbeat with the Elastic Cloud (https://cloud.elastic.co/).
#
## The cloud.id setting overwrites the `output.elasticsearch.hosts` and
## `setup.kibana.host` options.
## You can find the `cloud.id` in the Elastic Cloud web UI.
##cloud.id:
#
## The cloud.auth setting overwrites the `output.elasticsearch.username` and
## `output.elasticsearch.password` settings. The format is `<user>:<pass>`.
##cloud.auth:
#
#================================ Outputs ======================================
# Configure what output to use when sending the data collected by the beat.
#-------------------------- Elasticsearch output -------------------------------
#output.elasticsearch:
# # Boolean flag to enable or disable the output module.
# #enabled: true
#
# # Array of hosts to connect to.
# # Scheme and port can be left out and will be set to the default (http and 9200)
# # In case you specify and additional path, the scheme is required: http://localhost:9200/path
# # IPv6 addresses should always be defined as: https://[2001:db8::1]:9200
# hosts: ["localhost:9200"]
#
# # Set gzip compression level.
# #compression_level: 0
#
# # Optional protocol and basic auth credentials.
# #protocol: "https"
# #username: "elastic"
# #password: "changeme"
#
# # Dictionary of HTTP parameters to pass within the url with index operations.
# #parameters:
# #param1: value1
# #param2: value2
#
# # Number of workers per Elasticsearch host.
# #worker: 1
#
# # Optional index name. The default is "metricbeat" plus date
# # and generates [metricbeat-]YYYY.MM.DD keys.
# # In case you modify this pattern you must update setup.template.name and setup.template.pattern accordingly.
# #index: "metricbeat-%{[beat.version]}-%{+yyyy.MM.dd}"
#
# # Optional ingest node pipeline. By default no pipeline will be used.
# #pipeline: ""
#
# # Optional HTTP Path
# #path: "/elasticsearch"
#
# # Custom HTTP headers to add to each request
# #headers:
# # X-My-Header: Contents of the header
#
# # Proxy server url
# #proxy_url: http://proxy:3128
#
# # The number of times a particular Elasticsearch index operation is attempted. If
# # the indexing operation doesn't succeed after this many retries, the events are
# # dropped. The default is 3.
# #max_retries: 3
#
# # The maximum number of events to bulk in a single Elasticsearch bulk API index request.
# # The default is 50.
# #bulk_max_size: 50
#
# # Configure http request timeout before failing an request to Elasticsearch.
# #timeout: 90
#
# # Use SSL settings for HTTPS.
# #ssl.enabled: true
#
# # Configure SSL verification mode. If `none` is configured, all server hosts
# # and certificates will be accepted. In this mode, SSL based connections are
# # susceptible to man-in-the-middle attacks. Use only for testing. Default is
# # `full`.
# #ssl.verification_mode: full
#
# # List of supported/valid TLS versions. By default all TLS versions 1.0 up to
# # 1.2 are enabled.
# #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
#
# # SSL configuration. By default is off.
# # List of root certificates for HTTPS server verifications
# #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
#
# # Certificate for SSL client authentication
# #ssl.certificate: "/etc/pki/client/cert.pem"
#
# # Client Certificate Key
# #ssl.key: "/etc/pki/client/cert.key"
#
# # Optional passphrase for decrypting the Certificate Key.
# #ssl.key_passphrase: ''
#
# # Configure cipher suites to be used for SSL connections
# #ssl.cipher_suites: []
#
# # Configure curve types for ECDHE based cipher suites
# #ssl.curve_types: []
#
# # Configure what types of renegotiation are supported. Valid options are
# # never, once, and freely. Default is never.
# #ssl.renegotiation: never
#
#
#----------------------------- Logstash output ---------------------------------
output.logstash:
# Boolean flag to enable or disable the output module.
enabled: true
# The Logstash hosts
hosts: {% set IP_ARR=[] %}{% for host in groups['elastic-logstash'] %}{% if IP_ARR.insert(loop.index,hostvars[host]['ansible_host']) %}{% endif %}{% endfor %}[{{ IP_ARR | map('regex_replace', '$', ':' ~ logstash_beat_input_port|string()) | map('regex_replace', '$', '"') | map('regex_replace', '^', '"') | list | join(',' ) }}]
# Number of workers per Logstash host.
#worker: 1
# Set gzip compression level.
#compression_level: 3
# Optional maximum time to live for a connection to Logstash, after which the
# connection will be re-established. A value of `0s` (the default) will
# disable this feature.
#
# Not yet supported for async connections (i.e. with the "pipelining" option set)
#ttl: 30s
# Optional load balance the events between the Logstash hosts. Default is false.
loadbalance: true
# Number of batches to be sent asynchronously to logstash while processing
# new batches.
#pipelining: 2
# If enabled only a subset of events in a batch of events is transferred per
# transaction. The number of events to be sent increases up to `bulk_max_size`
# if no error is encountered.
#slow_start: false
# Optional index name. The default index name is set to metricbeat
# in all lowercase.
#index: 'metricbeat'
# SOCKS5 proxy server URL
#proxy_url: socks5://user:password@socks5-server:2233
# Resolve names locally when using a proxy server. Defaults to false.
#proxy_use_local_resolver: false
# Enable SSL support. SSL is automatically enabled, if any SSL setting is set.
#ssl.enabled: true
# Configure SSL verification mode. If `none` is configured, all server hosts
# and certificates will be accepted. In this mode, SSL based connections are
# susceptible to man-in-the-middle attacks. Use only for testing. Default is
# `full`.
#ssl.verification_mode: full
# List of supported/valid TLS versions. By default all TLS versions 1.0 up to
# 1.2 are enabled.
#ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
# Optional SSL configuration options. SSL is off by default.
# List of root certificates for HTTPS server verifications
#ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
# Certificate for SSL client authentication
#ssl.certificate: "/etc/pki/client/cert.pem"
# Client Certificate Key
#ssl.key: "/etc/pki/client/cert.key"
# Optional passphrase for decrypting the Certificate Key.
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
# Configure curve types for ECDHE based cipher suites
#ssl.curve_types: []
# Configure what types of renegotiation are supported. Valid options are
# never, once, and freely. Default is never.
#ssl.renegotiation: never
#------------------------------- Kafka output ----------------------------------
#output.kafka:
# Boolean flag to enable or disable the output module.
#enabled: true
# The list of Kafka broker addresses from where to fetch the cluster metadata.
# The cluster metadata contain the actual Kafka brokers events are published
# to.
#hosts: ["localhost:9092"]
# The Kafka topic used for produced events. The setting can be a format string
# using any event field. To set the topic from document type use `%{[type]}`.
#topic: beats
# The Kafka event key setting. Use format string to create unique event key.
# By default no event key will be generated.
#key: ''
# The Kafka event partitioning strategy. Default hashing strategy is `hash`
# using the `output.kafka.key` setting or randomly distributes events if
# `output.kafka.key` is not configured.
#partition.hash:
# If enabled, events will only be published to partitions with reachable
# leaders. Default is false.
#reachable_only: false
# Configure alternative event field names used to compute the hash value.
# If empty `output.kafka.key` setting will be used.
# Default value is empty list.
#hash: []
# Authentication details. Password is required if username is set.
#username: ''
#password: ''
# Kafka version metricbeat is assumed to run against. Defaults to the oldest
# supported stable version (currently version 0.8.2.0)
#version: 0.8.2
# Metadata update configuration. Metadata do contain leader information
# deciding which broker to use when publishing.
#metadata:
# Max metadata request retry attempts when cluster is in middle of leader
# election. Defaults to 3 retries.
#retry.max: 3
# Waiting time between retries during leader elections. Default is 250ms.
#retry.backoff: 250ms
# Refresh metadata interval. Defaults to every 10 minutes.
#refresh_frequency: 10m
# The number of concurrent load-balanced Kafka output workers.
#worker: 1
# The number of times to retry publishing an event after a publishing failure.
# After the specified number of retries, the events are typically dropped.
# Some Beats, such as Filebeat, ignore the max_retries setting and retry until
# all events are published. Set max_retries to a value less than 0 to retry
# until all events are published. The default is 3.
#max_retries: 3
# The maximum number of events to bulk in a single Kafka request. The default
# is 2048.
#bulk_max_size: 2048
# The number of seconds to wait for responses from the Kafka brokers before
# timing out. The default is 30s.
#timeout: 30s
# The maximum duration a broker will wait for number of required ACKs. The
# default is 10s.
#broker_timeout: 10s
# The number of messages buffered for each Kafka broker. The default is 256.
#channel_buffer_size: 256
# The keep-alive period for an active network connection. If 0s, keep-alives
# are disabled. The default is 0 seconds.
#keep_alive: 0
# Sets the output compression codec. Must be one of none, snappy and gzip. The
# default is gzip.
#compression: gzip
# The maximum permitted size of JSON-encoded messages. Bigger messages will be
# dropped. The default value is 1000000 (bytes). This value should be equal to
# or less than the broker's message.max.bytes.
#max_message_bytes: 1000000
# The ACK reliability level required from broker. 0=no response, 1=wait for
# local commit, -1=wait for all replicas to commit. The default is 1. Note:
# If set to 0, no ACKs are returned by Kafka. Messages might be lost silently
# on error.
#required_acks: 1
# The configurable ClientID used for logging, debugging, and auditing
# purposes. The default is "beats".
#client_id: beats
# Enable SSL support. SSL is automatically enabled, if any SSL setting is set.
#ssl.enabled: true
# Optional SSL configuration options. SSL is off by default.
# List of root certificates for HTTPS server verifications
#ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
# Configure SSL verification mode. If `none` is configured, all server hosts
# and certificates will be accepted. In this mode, SSL based connections are
# susceptible to man-in-the-middle attacks. Use only for testing. Default is
# `full`.
#ssl.verification_mode: full
# List of supported/valid TLS versions. By default all TLS versions 1.0 up to
# 1.2 are enabled.
#ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
# Certificate for SSL client authentication
#ssl.certificate: "/etc/pki/client/cert.pem"
# Client Certificate Key
#ssl.key: "/etc/pki/client/cert.key"
# Optional passphrase for decrypting the Certificate Key.
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
# Configure curve types for ECDHE based cipher suites
#ssl.curve_types: []
# Configure what types of renegotiation are supported. Valid options are
# never, once, and freely. Default is never.
#ssl.renegotiation: never
#------------------------------- Redis output ----------------------------------
#output.redis:
# Boolean flag to enable or disable the output module.
#enabled: true
# The list of Redis servers to connect to. If load balancing is enabled, the
# events are distributed to the servers in the list. If one server becomes
# unreachable, the events are distributed to the reachable servers only.
#hosts: ["localhost:6379"]
# The Redis port to use if hosts does not contain a port number. The default
# is 6379.
#port: 6379
# The name of the Redis list or channel the events are published to. The
# default is metricbeat.
#key: metricbeat
# The password to authenticate with. The default is no authentication.
#password:
# The Redis database number where the events are published. The default is 0.
#db: 0
# The Redis data type to use for publishing events. If the data type is list,
# the Redis RPUSH command is used. If the data type is channel, the Redis
# PUBLISH command is used. The default value is list.
#datatype: list
# The number of workers to use for each host configured to publish events to
# Redis. Use this setting along with the loadbalance option. For example, if
# you have 2 hosts and 3 workers, in total 6 workers are started (3 for each
# host).
#worker: 1
# If set to true and multiple hosts or workers are configured, the output
# plugin load balances published events onto all Redis hosts. If set to false,
# the output plugin sends all events to only one host (determined at random)
# and will switch to another host if the currently selected one becomes
# unreachable. The default value is true.
#loadbalance: true
# The Redis connection timeout in seconds. The default is 5 seconds.
#timeout: 5s
# The number of times to retry publishing an event after a publishing failure.
# After the specified number of retries, the events are typically dropped.
# Some Beats, such as Filebeat, ignore the max_retries setting and retry until
# all events are published. Set max_retries to a value less than 0 to retry
# until all events are published. The default is 3.
#max_retries: 3
# The maximum number of events to bulk in a single Redis request or pipeline.
# The default is 2048.
#bulk_max_size: 2048
# The URL of the SOCKS5 proxy to use when connecting to the Redis servers. The
# value must be a URL with a scheme of socks5://.
#proxy_url:
# This option determines whether Redis hostnames are resolved locally when
# using a proxy. The default value is false, which means that name resolution
# occurs on the proxy server.
#proxy_use_local_resolver: false
# Enable SSL support. SSL is automatically enabled, if any SSL setting is set.
#ssl.enabled: true
# Configure SSL verification mode. If `none` is configured, all server hosts
# and certificates will be accepted. In this mode, SSL based connections are
# susceptible to man-in-the-middle attacks. Use only for testing. Default is
# `full`.
#ssl.verification_mode: full
# List of supported/valid TLS versions. By default all TLS versions 1.0 up to
# 1.2 are enabled.
#ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
# Optional SSL configuration options. SSL is off by default.
# List of root certificates for HTTPS server verifications
#ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
# Certificate for SSL client authentication
#ssl.certificate: "/etc/pki/client/cert.pem"
# Client Certificate Key
#ssl.key: "/etc/pki/client/cert.key"
# Optional passphrase for decrypting the Certificate Key.
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
# Configure curve types for ECDHE based cipher suites
#ssl.curve_types: []
# Configure what types of renegotiation are supported. Valid options are
# never, once, and freely. Default is never.
#ssl.renegotiation: never
#------------------------------- File output -----------------------------------
#output.file:
# Boolean flag to enable or disable the output module.
#enabled: true
# Path to the directory where to save the generated files. The option is
# mandatory.
#path: "/tmp/metricbeat"
# Name of the generated files. The default is `metricbeat` and it generates
# files: `metricbeat`, `metricbeat.1`, `metricbeat.2`, etc.
#filename: metricbeat
# Maximum size in kilobytes of each file. When this size is reached, and on
# every metricbeat restart, the files are rotated. The default value is 10240
# kB.
#rotate_every_kb: 10000
# Maximum number of files under path. When this number of files is reached,
# the oldest file is deleted and the rest are shifted from last to first. The
# default is 7 files.
#number_of_files: 7
# Permissions to use for file creation. The default is 0600.
#permissions: 0600
#----------------------------- Console output ---------------------------------
#output.console:
# Boolean flag to enable or disable the output module.
#enabled: true
# Pretty print json event
#pretty: false
#================================= Paths ======================================
# The home path for the metricbeat installation. This is the default base path
# for all other path settings and for miscellaneous files that come with the
# distribution (for example, the sample dashboards).
# If not set by a CLI flag or in the configuration file, the default for the
# home path is the location of the binary.
#path.home:
# The configuration path for the metricbeat installation. This is the default
# base path for configuration files, including the main YAML configuration file
# and the Elasticsearch template file. If not set by a CLI flag or in the
# configuration file, the default for the configuration path is the home path.
#path.config: ${path.home}
# The data path for the metricbeat installation. This is the default base path
# for all the files in which metricbeat needs to store its data. If not set by a
# CLI flag or in the configuration file, the default for the data path is a data
# subdirectory inside the home path.
#path.data: ${path.home}/data
# The logs path for a metricbeat installation. This is the default location for
# the Beat's log files. If not set by a CLI flag or in the configuration file,
# the default for the logs path is a logs subdirectory inside the home path.
#path.logs: ${path.home}/logs
#============================== Dashboards =====================================
# These settings control loading the sample dashboards to the Kibana index. Loading
# the dashboards are disabled by default and can be enabled either by setting the
# options here, or by using the `-setup` CLI flag or the `setup` command.
setup.dashboards.enabled: true
# The directory from where to read the dashboards. The default is the `kibana`
# folder in the home path.
#setup.dashboards.directory: ${path.home}/kibana
# The URL from where to download the dashboards archive. It is used instead of
# the directory if it has a value.
#setup.dashboards.url:
# The file archive (zip file) from where to read the dashboards. It is used instead
# of the directory when it has a value.
#setup.dashboards.file:
# In case the archive contains the dashboards from multiple Beats, this lets you
# select which one to load. You can load all the dashboards in the archive by
# setting this to the empty string.
#setup.dashboards.beat: metricbeat
# The name of the Kibana index to use for setting the configuration. Default is ".kibana"
#setup.dashboards.kibana_index: .kibana
# The Elasticsearch index name. This overwrites the index name defined in the
# dashboards and index pattern. Example: testbeat-*
#setup.dashboards.index:
# Always use the Kibana API for loading the dashboards instead of autodetecting
# how to install the dashboards by first querying Elasticsearch.
#setup.dashboards.always_kibana: false
#============================== Template =====================================
# A template is used to set the mapping in Elasticsearch
# By default template loading is enabled and the template is loaded.
# These settings can be adjusted to load your own template or overwrite existing ones.
# Set to false to disable template loading.
setup.template.enabled: true
# Template name. By default the template name is "metricbeat-%{[beat.version]}"
# The template name and pattern has to be set in case the elasticsearch index pattern is modified.
setup.template.name: "metricbeat-%{[beat.version]}"
# Template pattern. By default the template pattern is "-%{[beat.version]}-*" to apply to the default index settings.
# The first part is the version of the beat and then -* is used to match all daily indices.
# The template name and pattern has to be set in case the elasticsearch index pattern is modified.
setup.template.pattern: "metricbeat-%{[beat.version]}-*"
# Path to fields.yml file to generate the template
setup.template.fields: "${path.config}/fields.yml"
# Overwrite existing template
setup.template.overwrite: true
# Elasticsearch template settings
setup.template.settings:
# A dictionary of settings to place into the settings.index dictionary
# of the Elasticsearch template. For more details, please check
# https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html
index:
number_of_shards: 3
codec: best_compression
#number_of_routing_shards: 30
# A dictionary of settings for the _source field. For more details, please check
# https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html
#_source:
#enabled: false
#============================== Kibana =====================================
# Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.
# This requires a Kibana endpoint configuration.
setup.kibana:
# Kibana Host
# Scheme and port can be left out and will be set to the default (http and 5601)
# In case you specify and additional path, the scheme is required: http://localhost:5601/path
# IPv6 addresses should always be defined as: https://[2001:db8::1]:5601
host: "{{ hostvars[groups['kibana'][0]]['ansible_host'] }}:{{ kibana_port }}"
# Optional protocol and basic auth credentials.
#protocol: "https"
#username: "elastic"
#password: "changeme"
# Optional HTTP Path
#path: ""
# Use SSL settings for HTTPS. Default is true.
#ssl.enabled: true
# Configure SSL verification mode. If `none` is configured, all server hosts
# and certificates will be accepted. In this mode, SSL based connections are
# susceptible to man-in-the-middle attacks. Use only for testing. Default is
# `full`.
#ssl.verification_mode: full
# List of supported/valid TLS versions. By default all TLS versions 1.0 up to
# 1.2 are enabled.
#ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
# SSL configuration. By default is off.
# List of root certificates for HTTPS server verifications
#ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
# Certificate for SSL client authentication
#ssl.certificate: "/etc/pki/client/cert.pem"
# Client Certificate Key
#ssl.key: "/etc/pki/client/cert.key"
# Optional passphrase for decrypting the Certificate Key.
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
# Configure curve types for ECDHE based cipher suites
#ssl.curve_types: []
#================================ Logging ======================================
# There are four options for the log output: file, stderr, syslog, eventlog
# The file output is the default.
# Sets log level. The default log level is info.
# Available log levels are: error, warning, info, debug
#logging.level: info
# Enable debug output for selected components. To enable all selectors use ["*"]
# Other available selectors are "beat", "publish", "service"
# Multiple selectors can be chained.
#logging.selectors: [ ]
# Send all logging output to syslog. The default is false.
#logging.to_syslog: false
# Send all logging output to Windows Event Logs. The default is false.
#logging.to_eventlog: false
# If enabled, metricbeat periodically logs its internal metrics that have changed
# in the last period. For each metric that changed, the delta from the value at
# the beginning of the period is logged. Also, the total values for
# all non-zero internal metrics are logged on shutdown. The default is true.
#logging.metrics.enabled: true
# The period after which to log the internal metrics. The default is 30s.
#logging.metrics.period: 30s
# Logging to rotating files. Set logging.to_files to false to disable logging to
# files.
logging.to_files: true
logging.files:
# Configure the path where the logs are written. The default is the logs directory
# under the home path (the binary location).
path: /var/log/metricbeat
# The name of the files where the logs are written to.
name: metricbeat
# Configure log file size limit. If limit is reached, log file will be
# automatically rotated
#rotateeverybytes: 10485760 # = 10MB
# Number of rotated log files to keep. Oldest files will be deleted first.
keepfiles: 2
# The permissions mask to apply when rotating log files. The default value is 0600.
# Must be a valid Unix-style file permissions mask expressed in octal notation.
#permissions: 0600
# Set to true to log messages in json format.
#logging.json: false
#============================== Xpack Monitoring =====================================
# metricbeat can export internal metrics to a central Elasticsearch monitoring cluster.
# This requires xpack monitoring to be enabled in Elasticsearch.
# The reporting is disabled by default.
# Set to true to enable the monitoring reporter.
#xpack.monitoring.enabled: false
# Uncomment to send the metrics to Elasticsearch. Most settings from the
# Elasticsearch output are accepted here as well. Any setting that is not set is
# automatically inherited from the Elasticsearch output configuration, so if you
# have the Elasticsearch output configured, you can simply uncomment the
# following line, and leave the rest commented out.
#xpack.monitoring.elasticsearch:
# Array of hosts to connect to.
# Scheme and port can be left out and will be set to the default (http and 9200)
# In case you specify and additional path, the scheme is required: http://localhost:9200/path
# IPv6 addresses should always be defined as: https://[2001:db8::1]:9200
#hosts: ["localhost:9200"]
# Set gzip compression level.
#compression_level: 0
# Optional protocol and basic auth credentials.
#protocol: "https"
#username: "beats_system"
#password: "changeme"
# Dictionary of HTTP parameters to pass within the url with index operations.
#parameters:
#param1: value1
#param2: value2
# Custom HTTP headers to add to each request
#headers:
# X-My-Header: Contents of the header
# Proxy server url
#proxy_url: http://proxy:3128
# The number of times a particular Elasticsearch index operation is attempted. If
# the indexing operation doesn't succeed after this many retries, the events are
# dropped. The default is 3.
#max_retries: 3
# The maximum number of events to bulk in a single Elasticsearch bulk API index request.
# The default is 50.
#bulk_max_size: 50
# Configure http request timeout before failing an request to Elasticsearch.
#timeout: 90
# Use SSL settings for HTTPS.
#ssl.enabled: true
# Configure SSL verification mode. If `none` is configured, all server hosts
# and certificates will be accepted. In this mode, SSL based connections are
# susceptible to man-in-the-middle attacks. Use only for testing. Default is
# `full`.
#ssl.verification_mode: full
# List of supported/valid TLS versions. By default all TLS versions 1.0 up to
# 1.2 are enabled.
#ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
# SSL configuration. By default is off.
# List of root certificates for HTTPS server verifications
#ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
# Certificate for SSL client authentication
#ssl.certificate: "/etc/pki/client/cert.pem"
# Client Certificate Key
#ssl.key: "/etc/pki/client/cert.key"
# Optional passphrase for decrypting the Certificate Key.
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
# Configure curve types for ECDHE based cipher suites
#ssl.curve_types: []
# Configure what types of renegotiation are supported. Valid options are
# never, once, and freely. Default is never.
#ssl.renegotiation: never
#================================ HTTP Endpoint ======================================
# Each beat can expose internal metrics through a HTTP endpoint. For security
# reasons the endpoint is disabled by default. This feature is currently experimental.
# Stats can be access through http://localhost:5066/stats . For pretty JSON output
# append ?pretty to the URL.
# Defines if the HTTP endpoint is enabled.
#http.enabled: false
# The HTTP endpoint will bind to this hostname or IP address. It is recommended to use only localhost.
#http.host: localhost
# Port on which the HTTP endpoint will bind. Default is 5066.
#http.port: 5066