icingabeat/icingabeat.reference.yml

1569 lines
59 KiB
YAML
Raw Permalink Normal View History

2017-12-19 13:23:32 +01:00
2021-09-23 12:17:14 +02:00
# ================================== General ===================================
2017-12-19 13:23:32 +01:00
# 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.
2018-08-08 09:22:21 +02:00
# The default value is set to 2048.
# A value of 0 ensures events are immediately available
2017-12-19 13:23:32 +01:00
# to be sent to the outputs.
#flush.min_events: 2048
# Maximum duration after which events are available to the outputs,
2019-11-07 09:46:03 +01:00
# if the number of events stored in the queue is < `flush.min_events`.
2017-12-19 13:23:32 +01:00
#flush.timeout: 1s
2022-05-31 10:09:56 +02:00
2021-09-23 12:17:14 +02:00
# The disk queue stores incoming events on disk until the output is
# ready for them. This allows a higher event limit than the memory-only
# queue and lets pending events persist through a restart.
#disk:
# The directory path to store the queue's data.
#path: "${path.data}/diskqueue"
2022-05-31 10:09:56 +02:00
2021-09-23 12:17:14 +02:00
# The maximum space the queue should occupy on disk. Depending on
# input settings, events that exceed this limit are delayed or discarded.
#max_size: 10GB
# The maximum size of a single queue data file. Data in the queue is
# stored in smaller segments that are deleted after all their events
# have been processed.
#segment_size: 1GB
# The number of events to read from disk to memory while waiting for
# the output to request them.
#read_ahead: 512
# The number of events to accept from inputs while waiting for them
# to be written to disk. If event data arrives faster than it
# can be written to disk, this setting prevents it from overflowing
# main memory.
#write_ahead: 2048
# The duration to wait before retrying when the queue encounters a disk
# write error.
#retry_interval: 1s
# The maximum length of time to wait before retrying on a disk write
# error. If the queue encounters repeated errors, it will double the
# length of its retry interval each time, up to this maximum.
#max_retry_interval: 30s
2017-12-19 13:23:32 +01:00
2018-08-08 09:22:21 +02:00
# The spool queue will store events in a local spool file, before
# forwarding the events to the outputs.
2022-05-31 10:09:56 +02:00
# Note: the spool queue is deprecated and will be removed in the future.
# Use the disk queue instead.
2018-08-08 09:22:21 +02:00
#
# The spool file is a circular buffer, which blocks once the file/buffer is full.
# Events are put into a write buffer and flushed once the write buffer
# is full or the flush_timeout is triggered.
# Once ACKed by the output, events are removed immediately from the queue,
# making space for new events to be persisted.
#spool:
# The file namespace configures the file path and the file creation settings.
# Once the file exists, the `size`, `page_size` and `prealloc` settings
# will have no more effect.
#file:
# Location of spool file. The default value is ${path.data}/spool.dat.
#path: "${path.data}/spool.dat"
# Configure file permissions if file is created. The default value is 0600.
#permissions: 0600
# File size hint. The spool blocks, once this limit is reached. The default value is 100 MiB.
#size: 100MiB
# The files page size. A file is split into multiple pages of the same size. The default value is 4KiB.
#page_size: 4KiB
# If prealloc is set, the required space for the file is reserved using
# truncate. The default value is true.
#prealloc: true
# Spool writer settings
# Events are serialized into a write buffer. The write buffer is flushed if:
# - The buffer limit has been reached.
# - The configured limit of buffered events is reached.
# - The flush timeout is triggered.
#write:
# Sets the write buffer size.
#buffer_size: 1MiB
2019-08-15 14:08:08 +02:00
# Maximum duration after which events are flushed if the write buffer
2018-08-08 09:22:21 +02:00
# is not full yet. The default value is 1s.
#flush.timeout: 1s
# Number of maximum buffered events. The write buffer is flushed once the
# limit is reached.
#flush.events: 16384
# Configure the on-disk event encoding. The encoding can be changed
# between restarts.
# Valid encodings are: json, ubjson, and cbor.
#codec: cbor
#read:
# Reader flush timeout, waiting for more events to become available, so
2019-08-15 14:08:08 +02:00
# to fill a complete batch as required by the outputs.
2018-08-08 09:22:21 +02:00
# If flush_timeout is 0, all available events are forwarded to the
# outputs immediately.
# The default value is 0s.
#flush.timeout: 0s
2017-12-19 13:23:32 +01:00
# 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:
2021-09-23 12:17:14 +02:00
# ================================= Processors =================================
2017-12-19 13:23:32 +01:00
# 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,
# decode_json_fields, and add_cloud_metadata.
2017-12-19 13:23:32 +01:00
#
# 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:
2021-09-23 12:17:14 +02:00
# - include_fields:
# fields: ["cpu"]
# - drop_fields:
# fields: ["cpu.user", "cpu.system"]
2017-12-19 13:23:32 +01:00
#
# The following example drops the events that have the HTTP response code 200:
#
#processors:
2021-09-23 12:17:14 +02:00
# - drop_event:
# when:
# equals:
# http.code: 200
2017-12-19 13:23:32 +01:00
#
2018-08-08 09:22:21 +02:00
# The following example renames the field a to b:
#
#processors:
2021-09-23 12:17:14 +02:00
# - rename:
# fields:
# - from: "a"
# to: "b"
2018-08-08 09:22:21 +02:00
#
# The following example tokenizes the string into fields:
#
#processors:
2021-09-23 12:17:14 +02:00
# - dissect:
# tokenizer: "%{key1} - %{key2}"
# field: "message"
# target_prefix: "dissect"
#
2017-12-19 13:23:32 +01:00
# 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:
2021-09-23 12:17:14 +02:00
# - add_cloud_metadata: ~
2017-12-19 13:23:32 +01:00
#
# The following example enriches each event with the machine's local time zone
# offset from UTC.
#
#processors:
2021-09-23 12:17:14 +02:00
# - add_locale:
# format: offset
2017-12-19 13:23:32 +01:00
#
# 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:
2021-09-23 12:17:14 +02:00
# - 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
# match_short_id: false
# cleanup_timeout: 60
# labels.dedot: false
# # 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"
2017-12-19 13:23:32 +01:00
#
# 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:
2021-09-23 12:17:14 +02:00
# - add_docker_metadata: ~
#
# The following example enriches each event with host metadata.
#
#processors:
2021-09-23 12:17:14 +02:00
# - add_host_metadata: ~
#
# The following example enriches each event with process metadata using
# process IDs included in the event.
#
#processors:
2021-09-23 12:17:14 +02:00
# - add_process_metadata:
# match_pids: ["system.process.ppid"]
# target: system.process.parent
#
# The following example decodes fields containing JSON strings
# and replaces the strings with valid JSON objects.
#
#processors:
2021-09-23 12:17:14 +02:00
# - decode_json_fields:
# fields: ["field1", "field2", ...]
# process_array: false
# max_depth: 1
# target: ""
# overwrite_keys: false
2019-08-15 14:08:08 +02:00
#
#processors:
2021-09-23 12:17:14 +02:00
# - decompress_gzip_field:
# from: "field1"
# to: "field2"
# ignore_missing: false
# fail_on_error: true
2019-08-15 14:08:08 +02:00
#
# The following example copies the value of message to message_copied
#
#processors:
2021-09-23 12:17:14 +02:00
# - copy_fields:
# fields:
2019-08-15 14:08:08 +02:00
# - from: message
# to: message_copied
2021-09-23 12:17:14 +02:00
# fail_on_error: true
# ignore_missing: false
2019-08-15 14:08:08 +02:00
#
# The following example truncates the value of message to 1024 bytes
#
#processors:
2021-09-23 12:17:14 +02:00
# - truncate_fields:
# fields:
# - message
# max_bytes: 1024
# fail_on_error: false
# ignore_missing: true
2019-08-15 14:08:08 +02:00
#
# The following example preserves the raw message under event.original
#
#processors:
2021-09-23 12:17:14 +02:00
# - copy_fields:
# fields:
2019-08-15 14:08:08 +02:00
# - from: message
# to: event.original
2021-09-23 12:17:14 +02:00
# fail_on_error: false
# ignore_missing: true
# - truncate_fields:
# fields:
# - event.original
# max_bytes: 1024
# fail_on_error: false
# ignore_missing: true
#
# The following example URL-decodes the value of field1 to field2
#
#processors:
# - urldecode:
# fields:
# - from: "field1"
# to: "field2"
# ignore_missing: false
# fail_on_error: true
2017-12-19 13:23:32 +01:00
2021-09-23 12:17:14 +02:00
# =============================== Elastic Cloud ================================
2017-12-19 13:23:32 +01:00
2019-08-15 14:08:08 +02:00
# These settings simplify using Icingabeat with the Elastic Cloud (https://cloud.elastic.co/).
2017-12-19 13:23:32 +01:00
# 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:
2021-09-23 12:17:14 +02:00
# ================================== Outputs ===================================
2017-12-19 13:23:32 +01:00
# Configure what output to use when sending the data collected by the beat.
2021-09-23 12:17:14 +02:00
# ---------------------------- Elasticsearch Output ----------------------------
2017-12-19 13:23:32 +01:00
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
2019-08-15 14:08:08 +02:00
# Configure escaping HTML symbols in strings.
#escape_html: false
2021-09-23 12:17:14 +02:00
# Protocol - either `http` (default) or `https`.
2017-12-19 13:23:32 +01:00
#protocol: "https"
2021-09-23 12:17:14 +02:00
# Authentication credentials - either API key or username/password.
#api_key: "id:api_key"
2017-12-19 13:23:32 +01:00
#username: "elastic"
#password: "changeme"
2019-08-15 14:08:08 +02:00
# Dictionary of HTTP parameters to pass within the URL with index operations.
2017-12-19 13:23:32 +01:00
#parameters:
#param1: value1
#param2: value2
# Number of workers per Elasticsearch host.
#worker: 1
# Optional index name. The default is "icingabeat" plus date
# and generates [icingabeat-]YYYY.MM.DD keys.
# In case you modify this pattern you must update setup.template.name and setup.template.pattern accordingly.
2019-08-15 14:08:08 +02:00
#index: "icingabeat-%{[agent.version]}-%{+yyyy.MM.dd}"
2017-12-19 13:23:32 +01:00
2022-05-31 10:09:56 +02:00
# Optional ingest pipeline. By default no pipeline will be used.
2017-12-19 13:23:32 +01:00
#pipeline: ""
2019-08-15 14:08:08 +02:00
# Optional HTTP path
2017-12-19 13:23:32 +01:00
#path: "/elasticsearch"
# Custom HTTP headers to add to each request
#headers:
# X-My-Header: Contents of the header
2019-08-15 14:08:08 +02:00
# Proxy server URL
2017-12-19 13:23:32 +01:00
#proxy_url: http://proxy:3128
2019-08-15 14:08:08 +02:00
# Whether to disable proxy settings for outgoing connections. If true, this
# takes precedence over both the proxy_url field and any environment settings
# (HTTP_PROXY, HTTPS_PROXY). The default is false.
#proxy_disable: false
2017-12-19 13:23:32 +01:00
# 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
2018-08-08 09:22:21 +02:00
# The number of seconds to wait before trying to reconnect to Elasticsearch
# after a network error. After waiting backoff.init seconds, the Beat
# tries to reconnect. If the attempt fails, the backoff timer is increased
# exponentially up to backoff.max. After a successful connection, the backoff
# timer is reset. The default is 1s.
#backoff.init: 1s
# The maximum number of seconds to wait before attempting to connect to
# Elasticsearch after a network error. The default is 60s.
#backoff.max: 60s
2019-08-15 14:08:08 +02:00
# Configure HTTP request timeout before failing a request to Elasticsearch.
2017-12-19 13:23:32 +01:00
#timeout: 90
2018-04-06 12:44:37 +02:00
# Use SSL settings for HTTPS.
2017-12-19 13:23:32 +01:00
#ssl.enabled: true
2021-09-23 12:17:14 +02:00
# Controls the verification of certificates. Valid values are:
# * full, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate.
# * strict, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate. If the Subject Alternative
# Name is empty, it returns an error.
# * certificate, which verifies that the provided certificate is signed by a
# trusted authority (CA), but does not perform any hostname verification.
# * none, which performs no verification of the server's certificate. This
# mode disables many of the security benefits of SSL/TLS and should only be used
# after very careful consideration. It is primarily intended as a temporary
# diagnostic mechanism when attempting to resolve TLS errors; its use in
# production environments is strongly discouraged.
# The default value is full.
2017-12-19 13:23:32 +01:00
#ssl.verification_mode: full
2021-09-23 12:17:14 +02:00
# List of supported/valid TLS versions. By default all TLS versions from 1.1
# up to 1.3 are enabled.
#ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
2017-12-19 13:23:32 +01:00
# 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"
2019-08-15 14:08:08 +02:00
# Client certificate key
2017-12-19 13:23:32 +01:00
#ssl.key: "/etc/pki/client/cert.key"
2019-08-15 14:08:08 +02:00
# Optional passphrase for decrypting the certificate key.
2017-12-19 13:23:32 +01:00
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
2019-08-15 14:08:08 +02:00
# Configure curve types for ECDHE-based cipher suites
2017-12-19 13:23:32 +01:00
#ssl.curve_types: []
# Configure what types of renegotiation are supported. Valid options are
# never, once, and freely. Default is never.
#ssl.renegotiation: never
2021-09-23 12:17:14 +02:00
# Configure a pin that can be used to do extra validation of the verified certificate chain,
# this allow you to ensure that a specific certificate is used to validate the chain of trust.
#
# The pin is a base64 encoded string of the SHA-256 fingerprint.
#ssl.ca_sha256: ""
# Enable Kerberos support. Kerberos is automatically enabled if any Kerberos setting is set.
#kerberos.enabled: true
# Authentication type to use with Kerberos. Available options: keytab, password.
#kerberos.auth_type: password
# Path to the keytab file. It is used when auth_type is set to keytab.
#kerberos.keytab: /etc/elastic.keytab
# Path to the Kerberos configuration.
#kerberos.config_path: /etc/krb5.conf
# Name of the Kerberos user.
#kerberos.username: elastic
# Password of the Kerberos user. It is used when auth_type is set to password.
#kerberos.password: changeme
# Kerberos realm.
#kerberos.realm: ELASTIC
# ------------------------------ Logstash Output -------------------------------
2017-12-19 13:23:32 +01:00
#output.logstash:
# Boolean flag to enable or disable the output module.
#enabled: true
# The Logstash hosts
#hosts: ["localhost:5044"]
# Number of workers per Logstash host.
#worker: 1
# Set gzip compression level.
#compression_level: 3
2019-08-15 14:08:08 +02:00
# Configure escaping HTML symbols in strings.
#escape_html: false
2017-12-19 13:23:32 +01:00
# 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
2019-08-15 14:08:08 +02:00
# Optionally load-balance events between Logstash hosts. Default is false.
2017-12-19 13:23:32 +01:00
#loadbalance: false
2018-08-08 09:22:21 +02:00
# Number of batches to be sent asynchronously to Logstash while processing
2017-12-19 13:23:32 +01:00
# new batches.
2018-04-06 12:44:37 +02:00
#pipelining: 2
2017-12-19 13:23:32 +01:00
# 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
2018-08-08 09:22:21 +02:00
# The number of seconds to wait before trying to reconnect to Logstash
# after a network error. After waiting backoff.init seconds, the Beat
# tries to reconnect. If the attempt fails, the backoff timer is increased
# exponentially up to backoff.max. After a successful connection, the backoff
# timer is reset. The default is 1s.
#backoff.init: 1s
# The maximum number of seconds to wait before attempting to connect to
# Logstash after a network error. The default is 60s.
#backoff.max: 60s
2017-12-19 13:23:32 +01:00
# Optional index name. The default index name is set to icingabeat
# in all lowercase.
#index: 'icingabeat'
# 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
2021-09-23 12:17:14 +02:00
# Use SSL settings for HTTPS.
2017-12-19 13:23:32 +01:00
#ssl.enabled: true
2021-09-23 12:17:14 +02:00
# Controls the verification of certificates. Valid values are:
# * full, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate.
# * strict, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate. If the Subject Alternative
# Name is empty, it returns an error.
# * certificate, which verifies that the provided certificate is signed by a
# trusted authority (CA), but does not perform any hostname verification.
# * none, which performs no verification of the server's certificate. This
# mode disables many of the security benefits of SSL/TLS and should only be used
# after very careful consideration. It is primarily intended as a temporary
# diagnostic mechanism when attempting to resolve TLS errors; its use in
# production environments is strongly discouraged.
# The default value is full.
2017-12-19 13:23:32 +01:00
#ssl.verification_mode: full
2021-09-23 12:17:14 +02:00
# List of supported/valid TLS versions. By default all TLS versions from 1.1
# up to 1.3 are enabled.
#ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
2017-12-19 13:23:32 +01:00
# 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"
2019-08-15 14:08:08 +02:00
# Client certificate key
2017-12-19 13:23:32 +01:00
#ssl.key: "/etc/pki/client/cert.key"
2021-09-23 12:17:14 +02:00
# Optional passphrase for decrypting the certificate key.
2017-12-19 13:23:32 +01:00
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
2019-08-15 14:08:08 +02:00
# Configure curve types for ECDHE-based cipher suites
2017-12-19 13:23:32 +01:00
#ssl.curve_types: []
# Configure what types of renegotiation are supported. Valid options are
# never, once, and freely. Default is never.
#ssl.renegotiation: never
2021-09-23 12:17:14 +02:00
# Configure a pin that can be used to do extra validation of the verified certificate chain,
# this allow you to ensure that a specific certificate is used to validate the chain of trust.
#
# The pin is a base64 encoded string of the SHA-256 fingerprint.
#ssl.ca_sha256: ""
# 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 and Winlogbeat, 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 Logstash request. The
# default is 2048.
#bulk_max_size: 2048
# The number of seconds to wait for responses from the Logstash server before
# timing out. The default is 30s.
#timeout: 30s
2021-09-23 12:17:14 +02:00
# -------------------------------- Kafka Output --------------------------------
2017-12-19 13:23:32 +01:00
#output.kafka:
# Boolean flag to enable or disable the output module.
#enabled: true
2019-08-15 14:08:08 +02:00
# The list of Kafka broker addresses from which to fetch the cluster metadata.
2017-12-19 13:23:32 +01:00
# 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
2019-08-15 14:08:08 +02:00
# The Kafka event key setting. Use format string to create a unique event key.
2017-12-19 13:23:32 +01:00
# 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: ''
2021-09-23 12:17:14 +02:00
# SASL authentication mechanism used. Can be one of PLAIN, SCRAM-SHA-256 or SCRAM-SHA-512.
# Defaults to PLAIN when `username` and `password` are configured.
#sasl.mechanism: ''
2019-08-15 14:08:08 +02:00
# Kafka version Icingabeat is assumed to run against. Defaults to the "1.0.0".
#version: '1.0.0'
# Configure JSON encoding
#codec.json:
2019-08-15 14:08:08 +02:00
# Pretty-print JSON event
#pretty: false
2019-08-15 14:08:08 +02:00
# Configure escaping HTML symbols in strings.
#escape_html: false
2017-12-19 13:23:32 +01:00
2019-08-15 14:08:08 +02:00
# Metadata update configuration. Metadata contains leader information
# used to decide which broker to use when publishing.
2017-12-19 13:23:32 +01:00
#metadata:
# Max metadata request retry attempts when cluster is in middle of leader
# election. Defaults to 3 retries.
#retry.max: 3
2019-08-15 14:08:08 +02:00
# Wait time between retries during leader elections. Default is 250ms.
2017-12-19 13:23:32 +01:00
#retry.backoff: 250ms
# Refresh metadata interval. Defaults to every 10 minutes.
#refresh_frequency: 10m
2019-08-15 14:08:08 +02:00
# Strategy for fetching the topics metadata from the broker. Default is false.
#full: false
2017-12-19 13:23:32 +01:00
# The number of concurrent load-balanced Kafka output workers.
#worker: 1
# The number of times to retry publishing an event after a publishing failure.
2019-08-15 14:08:08 +02:00
# After the specified number of retries, events are typically dropped.
2017-12-19 13:23:32 +01:00
# 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
2021-09-23 12:17:14 +02:00
# The number of seconds to wait before trying to republish to Kafka
# after a network error. After waiting backoff.init seconds, the Beat
# tries to republish. If the attempt fails, the backoff timer is increased
# exponentially up to backoff.max. After a successful publish, the backoff
# timer is reset. The default is 1s.
#backoff.init: 1s
# The maximum number of seconds to wait before attempting to republish to
# Kafka after a network error. The default is 60s.
#backoff.max: 60s
2017-12-19 13:23:32 +01:00
# The maximum number of events to bulk in a single Kafka request. The default
# is 2048.
#bulk_max_size: 2048
2019-08-15 14:08:08 +02:00
# Duration to wait before sending bulk Kafka request. 0 is no delay. The default
# is 0.
#bulk_flush_frequency: 0s
2017-12-19 13:23:32 +01:00
# 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
# Set the compression level. Currently only gzip provides a compression level
# between 0 and 9. The default value is chosen by the compression algorithm.
#compression_level: 4
2017-12-19 13:23:32 +01:00
# 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
2021-09-23 12:17:14 +02:00
# Use SSL settings for HTTPS.
2017-12-19 13:23:32 +01:00
#ssl.enabled: true
2021-09-23 12:17:14 +02:00
# Controls the verification of certificates. Valid values are:
# * full, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate.
# * strict, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate. If the Subject Alternative
# Name is empty, it returns an error.
# * certificate, which verifies that the provided certificate is signed by a
# trusted authority (CA), but does not perform any hostname verification.
# * none, which performs no verification of the server's certificate. This
# mode disables many of the security benefits of SSL/TLS and should only be used
# after very careful consideration. It is primarily intended as a temporary
# diagnostic mechanism when attempting to resolve TLS errors; its use in
# production environments is strongly discouraged.
# The default value is full.
2017-12-19 13:23:32 +01:00
#ssl.verification_mode: full
2021-09-23 12:17:14 +02:00
# List of supported/valid TLS versions. By default all TLS versions from 1.1
# up to 1.3 are enabled.
#ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
# List of root certificates for HTTPS server verifications
#ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
2017-12-19 13:23:32 +01:00
# Certificate for SSL client authentication
#ssl.certificate: "/etc/pki/client/cert.pem"
2021-09-23 12:17:14 +02:00
# Client certificate key
2017-12-19 13:23:32 +01:00
#ssl.key: "/etc/pki/client/cert.key"
2021-09-23 12:17:14 +02:00
# Optional passphrase for decrypting the certificate key.
2017-12-19 13:23:32 +01:00
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
2019-08-15 14:08:08 +02:00
# Configure curve types for ECDHE-based cipher suites
2017-12-19 13:23:32 +01:00
#ssl.curve_types: []
# Configure what types of renegotiation are supported. Valid options are
# never, once, and freely. Default is never.
#ssl.renegotiation: never
2021-09-23 12:17:14 +02:00
# Configure a pin that can be used to do extra validation of the verified certificate chain,
# this allow you to ensure that a specific certificate is used to validate the chain of trust.
#
# The pin is a base64 encoded string of the SHA-256 fingerprint.
#ssl.ca_sha256: ""
# Enable Kerberos support. Kerberos is automatically enabled if any Kerberos setting is set.
#kerberos.enabled: true
# Authentication type to use with Kerberos. Available options: keytab, password.
#kerberos.auth_type: password
# Path to the keytab file. It is used when auth_type is set to keytab.
#kerberos.keytab: /etc/security/keytabs/kafka.keytab
# Path to the Kerberos configuration.
#kerberos.config_path: /etc/krb5.conf
# The service name. Service principal name is contructed from
# service_name/hostname@realm.
#kerberos.service_name: kafka
# Name of the Kerberos user.
#kerberos.username: elastic
# Password of the Kerberos user. It is used when auth_type is set to password.
#kerberos.password: changeme
# Kerberos realm.
#kerberos.realm: ELASTIC
# Enables Kerberos FAST authentication. This may
# conflict with certain Active Directory configurations.
#kerberos.enable_krb5_fast: false
# -------------------------------- Redis Output --------------------------------
2017-12-19 13:23:32 +01:00
#output.redis:
# Boolean flag to enable or disable the output module.
#enabled: true
# Configure JSON encoding
#codec.json:
# Pretty print json event
#pretty: false
2019-08-15 14:08:08 +02:00
# Configure escaping HTML symbols in strings.
#escape_html: false
2019-08-15 14:08:08 +02:00
# The list of Redis servers to connect to. If load-balancing is enabled, the
2017-12-19 13:23:32 +01:00
# events are distributed to the servers in the list. If one server becomes
# unreachable, the events are distributed to the reachable servers only.
2021-09-23 12:17:14 +02:00
# The hosts setting supports redis and rediss urls with custom password like
# redis://:password@localhost:6379.
2017-12-19 13:23:32 +01:00
#hosts: ["localhost:6379"]
# The name of the Redis list or channel the events are published to. The
# default is icingabeat.
#key: icingabeat
2019-08-15 14:08:08 +02:00
# The password to authenticate to Redis with. The default is no authentication.
2017-12-19 13:23:32 +01:00
#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 number of seconds to wait before trying to reconnect to Redis
# after a network error. After waiting backoff.init seconds, the Beat
# tries to reconnect. If the attempt fails, the backoff timer is increased
# exponentially up to backoff.max. After a successful connection, the backoff
# timer is reset. The default is 1s.
#backoff.init: 1s
# The maximum number of seconds to wait before attempting to connect to
# Redis after a network error. The default is 60s.
#backoff.max: 60s
2017-12-19 13:23:32 +01:00
# 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
2021-09-23 12:17:14 +02:00
# Use SSL settings for HTTPS.
2017-12-19 13:23:32 +01:00
#ssl.enabled: true
2021-09-23 12:17:14 +02:00
# Controls the verification of certificates. Valid values are:
# * full, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate.
# * strict, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate. If the Subject Alternative
# Name is empty, it returns an error.
# * certificate, which verifies that the provided certificate is signed by a
# trusted authority (CA), but does not perform any hostname verification.
# * none, which performs no verification of the server's certificate. This
# mode disables many of the security benefits of SSL/TLS and should only be used
# after very careful consideration. It is primarily intended as a temporary
# diagnostic mechanism when attempting to resolve TLS errors; its use in
# production environments is strongly discouraged.
# The default value is full.
2017-12-19 13:23:32 +01:00
#ssl.verification_mode: full
2021-09-23 12:17:14 +02:00
# List of supported/valid TLS versions. By default all TLS versions from 1.1
# up to 1.3 are enabled.
#ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
2017-12-19 13:23:32 +01:00
# 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"
2021-09-23 12:17:14 +02:00
# Client certificate key
2017-12-19 13:23:32 +01:00
#ssl.key: "/etc/pki/client/cert.key"
2021-09-23 12:17:14 +02:00
# Optional passphrase for decrypting the certificate key.
2017-12-19 13:23:32 +01:00
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
2021-09-23 12:17:14 +02:00
# Configure curve types for ECDHE-based cipher suites
2017-12-19 13:23:32 +01:00
#ssl.curve_types: []
# Configure what types of renegotiation are supported. Valid options are
# never, once, and freely. Default is never.
#ssl.renegotiation: never
2021-09-23 12:17:14 +02:00
# Configure a pin that can be used to do extra validation of the verified certificate chain,
# this allow you to ensure that a specific certificate is used to validate the chain of trust.
#
# The pin is a base64 encoded string of the SHA-256 fingerprint.
#ssl.ca_sha256: ""
# -------------------------------- File Output ---------------------------------
2017-12-19 13:23:32 +01:00
#output.file:
# Boolean flag to enable or disable the output module.
#enabled: true
# Configure JSON encoding
#codec.json:
2019-08-15 14:08:08 +02:00
# Pretty-print JSON event
#pretty: false
2019-08-15 14:08:08 +02:00
# Configure escaping HTML symbols in strings.
#escape_html: false
2017-12-19 13:23:32 +01:00
# Path to the directory where to save the generated files. The option is
# mandatory.
#path: "/tmp/icingabeat"
# Name of the generated files. The default is `icingabeat` and it generates
# files: `icingabeat`, `icingabeat.1`, `icingabeat.2`, etc.
#filename: icingabeat
# Maximum size in kilobytes of each file. When this size is reached, and on
2019-08-15 14:08:08 +02:00
# every Icingabeat restart, the files are rotated. The default value is 10240
2017-12-19 13:23:32 +01:00
# 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
2021-09-23 12:17:14 +02:00
# ------------------------------- Console Output -------------------------------
2017-12-19 13:23:32 +01:00
#output.console:
# Boolean flag to enable or disable the output module.
#enabled: true
# Configure JSON encoding
#codec.json:
2019-08-15 14:08:08 +02:00
# Pretty-print JSON event
#pretty: false
2019-08-15 14:08:08 +02:00
# Configure escaping HTML symbols in strings.
#escape_html: false
2017-12-19 13:23:32 +01:00
2021-09-23 12:17:14 +02:00
# =================================== Paths ====================================
2017-12-19 13:23:32 +01:00
2019-08-15 14:08:08 +02:00
# The home path for the Icingabeat installation. This is the default base path
2017-12-19 13:23:32 +01:00
# 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:
2019-08-15 14:08:08 +02:00
# The configuration path for the Icingabeat installation. This is the default
2017-12-19 13:23:32 +01:00
# 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}
2019-08-15 14:08:08 +02:00
# The data path for the Icingabeat installation. This is the default base path
# for all the files in which Icingabeat needs to store its data. If not set by a
2017-12-19 13:23:32 +01:00
# 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
2019-08-15 14:08:08 +02:00
# The logs path for a Icingabeat installation. This is the default location for
2017-12-19 13:23:32 +01:00
# 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
2021-09-23 12:17:14 +02:00
# ================================== Keystore ==================================
2018-08-08 09:22:21 +02:00
# Location of the Keystore containing the keys and their sensitive values.
#keystore.path: "${path.config}/beats.keystore"
2021-09-23 12:17:14 +02:00
# ================================= Dashboards =================================
2017-12-19 13:23:32 +01:00
# 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: false
# 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: icingabeat
# 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
2018-08-08 09:22:21 +02:00
# If true and Kibana is not reachable at the time when dashboards are loaded,
# it will retry to reconnect to Kibana instead of exiting with an error.
#setup.dashboards.retry.enabled: false
# Duration interval between Kibana connection retries.
#setup.dashboards.retry.interval: 1s
# Maximum number of retries before exiting with an error, 0 for unlimited retrying.
#setup.dashboards.retry.maximum: 0
2021-09-23 12:17:14 +02:00
# ================================== Template ==================================
2017-12-19 13:23:32 +01:00
# 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
2021-09-23 12:17:14 +02:00
# Select the kind of index template. From Elasticsearch 7.8, it is possible to
# use component templates. Available options: legacy, component, index.
2022-05-31 10:09:56 +02:00
# By default icingabeat uses index templates.
#setup.template.type: index
2021-09-23 12:17:14 +02:00
2019-08-15 14:08:08 +02:00
# Template name. By default the template name is "icingabeat-%{[agent.version]}"
# The template name and pattern has to be set in case the Elasticsearch index pattern is modified.
#setup.template.name: "icingabeat-%{[agent.version]}"
2017-12-19 13:23:32 +01:00
2019-08-15 14:08:08 +02:00
# Template pattern. By default the template pattern is "-%{[agent.version]}-*" to apply to the default index settings.
2017-12-19 13:23:32 +01:00
# The first part is the version of the beat and then -* is used to match all daily indices.
2019-08-15 14:08:08 +02:00
# The template name and pattern has to be set in case the Elasticsearch index pattern is modified.
#setup.template.pattern: "icingabeat-%{[agent.version]}-*"
2017-12-19 13:23:32 +01:00
# Path to fields.yml file to generate the template
#setup.template.fields: "${path.config}/fields.yml"
# A list of fields to be added to the template and Kibana index pattern. Also
# specify setup.template.overwrite: true to overwrite the existing template.
#setup.template.append_fields:
#- name: field_name
# type: field_type
2019-08-15 14:08:08 +02:00
# Enable JSON template loading. If this is enabled, the fields.yml is ignored.
#setup.template.json.enabled: false
2019-08-15 14:08:08 +02:00
# Path to the JSON template file
#setup.template.json.path: "${path.config}/template.json"
# Name under which the template is stored in Elasticsearch
#setup.template.json.name: ""
2017-12-19 13:23:32 +01:00
# Overwrite existing template
2021-09-23 12:17:14 +02:00
# Do not enable this option for more than one instance of icingabeat as it might
# overload your Elasticsearch with too many update requests.
2017-12-19 13:23:32 +01:00
#setup.template.overwrite: false
# 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: 1
#codec: best_compression
# 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
2021-09-23 12:17:14 +02:00
# ====================== Index Lifecycle Management (ILM) ======================
2019-08-15 14:08:08 +02:00
# Configure index lifecycle management (ILM). These settings create a write
# alias and add additional settings to the index template. When ILM is enabled,
# output.elasticsearch.index is ignored, and the write alias is used to set the
# index name.
# Enable ILM support. Valid values are true, false, and auto. When set to auto
# (the default), the Beat uses index lifecycle management when it connects to a
# cluster that supports ILM; otherwise, it creates daily indices.
#setup.ilm.enabled: auto
# Set the prefix used in the index lifecycle write alias name. The default alias
2020-02-26 15:14:18 +01:00
# name is 'icingabeat-%{[agent.version]}'.
2021-09-23 12:17:14 +02:00
#setup.ilm.rollover_alias: 'icingabeat'
2019-08-15 14:08:08 +02:00
# Set the rollover index pattern. The default is "%{now/d}-000001".
#setup.ilm.pattern: "{now/d}-000001"
# Set the lifecycle policy name. The default policy name is
2021-09-23 12:17:14 +02:00
# 'beatname'.
2019-08-15 14:08:08 +02:00
#setup.ilm.policy_name: "mypolicy"
# The path to a JSON file that contains a lifecycle policy configuration. Used
# to load your own lifecycle policy.
#setup.ilm.policy_file:
2021-09-23 12:17:14 +02:00
# Disable the check for an existing lifecycle policy. The default is true. If
2019-08-15 14:08:08 +02:00
# you disable this check, set setup.ilm.overwrite: true so the lifecycle policy
# can be installed.
2021-09-23 12:17:14 +02:00
#setup.ilm.check_exists: true
2019-08-15 14:08:08 +02:00
# Overwrite the lifecycle policy at startup. The default is false.
#setup.ilm.overwrite: false
2021-09-23 12:17:14 +02:00
# =================================== Kibana ===================================
2017-12-19 13:23:32 +01:00
# 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: "localhost:5601"
# Optional protocol and basic auth credentials.
#protocol: "https"
#username: "elastic"
#password: "changeme"
2019-08-15 14:08:08 +02:00
# Optional HTTP path
2017-12-19 13:23:32 +01:00
#path: ""
2021-09-23 12:17:14 +02:00
# Optional Kibana space ID.
#space.id: ""
# Use SSL settings for HTTPS.
2017-12-19 13:23:32 +01:00
#ssl.enabled: true
2021-09-23 12:17:14 +02:00
# Controls the verification of certificates. Valid values are:
# * full, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate.
# * strict, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate. If the Subject Alternative
# Name is empty, it returns an error.
# * certificate, which verifies that the provided certificate is signed by a
# trusted authority (CA), but does not perform any hostname verification.
# * none, which performs no verification of the server's certificate. This
# mode disables many of the security benefits of SSL/TLS and should only be used
# after very careful consideration. It is primarily intended as a temporary
# diagnostic mechanism when attempting to resolve TLS errors; its use in
# production environments is strongly discouraged.
# The default value is full.
2017-12-19 13:23:32 +01:00
#ssl.verification_mode: full
2021-09-23 12:17:14 +02:00
# List of supported/valid TLS versions. By default all TLS versions from 1.1
# up to 1.3 are enabled.
#ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
2017-12-19 13:23:32 +01:00
# 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"
2019-08-15 14:08:08 +02:00
# Client certificate key
2017-12-19 13:23:32 +01:00
#ssl.key: "/etc/pki/client/cert.key"
2019-08-15 14:08:08 +02:00
# Optional passphrase for decrypting the certificate key.
2017-12-19 13:23:32 +01:00
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
2019-08-15 14:08:08 +02:00
# Configure curve types for ECDHE-based cipher suites
2017-12-19 13:23:32 +01:00
#ssl.curve_types: []
2021-09-23 12:17:14 +02:00
# Configure what types of renegotiation are supported. Valid options are
# never, once, and freely. Default is never.
#ssl.renegotiation: never
2017-12-19 13:23:32 +01:00
2021-09-23 12:17:14 +02:00
# Configure a pin that can be used to do extra validation of the verified certificate chain,
# this allow you to ensure that a specific certificate is used to validate the chain of trust.
#
# The pin is a base64 encoded string of the SHA-256 fingerprint.
#ssl.ca_sha256: ""
# ================================== Logging ===================================
2017-12-19 13:23:32 +01:00
2018-04-06 12:44:37 +02:00
# There are four options for the log output: file, stderr, syslog, eventlog
# The file output is the default.
2017-12-19 13:23:32 +01:00
# Sets log level. The default log level is info.
2018-04-06 12:44:37 +02:00
# Available log levels are: error, warning, info, debug
2017-12-19 13:23:32 +01:00
#logging.level: info
# Enable debug output for selected components. To enable all selectors use ["*"]
2021-09-23 12:17:14 +02:00
# Other available selectors are "beat", "publisher", "service"
2017-12-19 13:23:32 +01:00
# Multiple selectors can be chained.
#logging.selectors: [ ]
2019-08-15 14:08:08 +02:00
# Send all logging output to stderr. The default is false.
#logging.to_stderr: false
2017-12-19 13:23:32 +01:00
# Send all logging output to syslog. The default is false.
2018-04-06 12:44:37 +02:00
#logging.to_syslog: false
# Send all logging output to Windows Event Logs. The default is false.
#logging.to_eventlog: false
2017-12-19 13:23:32 +01:00
2019-08-15 14:08:08 +02:00
# If enabled, Icingabeat periodically logs its internal metrics that have changed
2017-12-19 13:23:32 +01:00
# 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
2022-05-31 10:09:56 +02:00
# A list of metrics namespaces to report in the logs. Defaults to [stats].
# `stats` contains general Beat metrics. `dataset` may be present in some
# Beats and contains module or input metrics.
#logging.metrics.namespaces: [stats]
2017-12-19 13:23:32 +01:00
# 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/icingabeat
# The name of the files where the logs are written to.
#name: icingabeat
# 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: 7
# 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
# Enable log file rotation on time intervals in addition to size-based rotation.
# Intervals must be at least 1s. Values of 1m, 1h, 24h, 7*24h, 30*24h, and 365*24h
# are boundary-aligned with minutes, hours, days, weeks, months, and years as
# reported by the local system clock. All other intervals are calculated from the
2019-08-15 14:08:08 +02:00
# Unix epoch. Defaults to disabled.
#interval: 0
2019-08-15 14:08:08 +02:00
# Rotate existing logs on startup rather than appending to the existing
# file. Defaults to true.
# rotateonstartup: true
2021-09-23 12:17:14 +02:00
# Rotated files are either suffixed with a number e.g. icingabeat.1 when
# renamed during rotation. Or when set to date, the date is added to
# the end of the file. On rotation a new file is created, older files are untouched.
#suffix: count
2019-08-15 14:08:08 +02:00
# Set to true to log messages in JSON format.
2022-05-31 10:09:56 +02:00
# Deprecated: As of 7.16.0 this setting is deprecated and will be removed in an upcoming release.
2017-12-19 13:23:32 +01:00
#logging.json: false
2018-04-06 12:44:37 +02:00
2021-09-23 12:17:14 +02:00
# Set to true, to log messages with minimal required Elastic Common Schema (ECS)
# information. Recommended to use in combination with `logging.json=true`
# Defaults to false.
2022-05-31 10:09:56 +02:00
# Deprecated: As of 7.16.0 this setting is deprecated and will be removed in an upcoming release.
2021-09-23 12:17:14 +02:00
#logging.ecs: false
2018-04-06 12:44:37 +02:00
2021-09-23 12:17:14 +02:00
# ============================= X-Pack Monitoring ==============================
2019-08-15 14:08:08 +02:00
# Icingabeat 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.
2018-04-06 12:44:37 +02:00
# Set to true to enable the monitoring reporter.
2019-08-15 14:08:08 +02:00
#monitoring.enabled: false
2018-04-06 12:44:37 +02:00
2019-11-07 09:46:03 +01:00
# Sets the UUID of the Elasticsearch cluster under which monitoring data for this
# Icingabeat instance will appear in the Stack Monitoring UI. If output.elasticsearch
# is enabled, the UUID is derived from the Elasticsearch cluster referenced by output.elasticsearch.
#monitoring.cluster_uuid:
2018-04-06 12:44:37 +02:00
# Uncomment to send the metrics to Elasticsearch. Most settings from the
2019-08-15 14:08:08 +02:00
# Elasticsearch output are accepted here as well.
# Note that the settings should point to your Elasticsearch *monitoring* cluster.
# Any setting that is not set is automatically inherited from the Elasticsearch
# output configuration, so if you have the Elasticsearch output configured such
# that it is pointing to your Elasticsearch monitoring cluster, you can simply
# uncomment the following line.
#monitoring.elasticsearch:
2018-04-06 12:44:37 +02:00
# 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
2021-09-23 12:17:14 +02:00
# Protocol - either `http` (default) or `https`.
2018-04-06 12:44:37 +02:00
#protocol: "https"
2021-09-23 12:17:14 +02:00
# Authentication credentials - either API key or username/password.
#api_key: "id:api_key"
2018-04-06 12:44:37 +02:00
#username: "beats_system"
#password: "changeme"
2019-08-15 14:08:08 +02:00
# Dictionary of HTTP parameters to pass within the URL with index operations.
2018-04-06 12:44:37 +02:00
#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
# The number of seconds to wait before trying to reconnect to Elasticsearch
# after a network error. After waiting backoff.init seconds, the Beat
# tries to reconnect. If the attempt fails, the backoff timer is increased
# exponentially up to backoff.max. After a successful connection, the backoff
# timer is reset. The default is 1s.
#backoff.init: 1s
# The maximum number of seconds to wait before attempting to connect to
# Elasticsearch after a network error. The default is 60s.
#backoff.max: 60s
2019-08-15 14:08:08 +02:00
# Configure HTTP request timeout before failing an request to Elasticsearch.
2018-04-06 12:44:37 +02:00
#timeout: 90
# Use SSL settings for HTTPS.
#ssl.enabled: true
2021-09-23 12:17:14 +02:00
# Controls the verification of certificates. Valid values are:
# * full, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate.
# * strict, which verifies that the provided certificate is signed by a trusted
# authority (CA) and also verifies that the server's hostname (or IP address)
# matches the names identified within the certificate. If the Subject Alternative
# Name is empty, it returns an error.
# * certificate, which verifies that the provided certificate is signed by a
# trusted authority (CA), but does not perform any hostname verification.
# * none, which performs no verification of the server's certificate. This
# mode disables many of the security benefits of SSL/TLS and should only be used
# after very careful consideration. It is primarily intended as a temporary
# diagnostic mechanism when attempting to resolve TLS errors; its use in
# production environments is strongly discouraged.
# The default value is full.
2018-04-06 12:44:37 +02:00
#ssl.verification_mode: full
2021-09-23 12:17:14 +02:00
# List of supported/valid TLS versions. By default all TLS versions from 1.1
# up to 1.3 are enabled.
#ssl.supported_protocols: [TLSv1.1, TLSv1.2, TLSv1.3]
2018-04-06 12:44:37 +02:00
# 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"
2019-08-15 14:08:08 +02:00
# Client certificate key
2018-04-06 12:44:37 +02:00
#ssl.key: "/etc/pki/client/cert.key"
2019-08-15 14:08:08 +02:00
# Optional passphrase for decrypting the certificate key.
2018-04-06 12:44:37 +02:00
#ssl.key_passphrase: ''
# Configure cipher suites to be used for SSL connections
#ssl.cipher_suites: []
2019-08-15 14:08:08 +02:00
# Configure curve types for ECDHE-based cipher suites
2018-04-06 12:44:37 +02:00
#ssl.curve_types: []
# Configure what types of renegotiation are supported. Valid options are
# never, once, and freely. Default is never.
#ssl.renegotiation: never
2021-09-23 12:17:14 +02:00
# Configure a pin that can be used to do extra validation of the verified certificate chain,
# this allow you to ensure that a specific certificate is used to validate the chain of trust.
#
# The pin is a base64 encoded string of the SHA-256 fingerprint.
#ssl.ca_sha256: ""
# Enable Kerberos support. Kerberos is automatically enabled if any Kerberos setting is set.
#kerberos.enabled: true
# Authentication type to use with Kerberos. Available options: keytab, password.
#kerberos.auth_type: password
# Path to the keytab file. It is used when auth_type is set to keytab.
#kerberos.keytab: /etc/elastic.keytab
# Path to the Kerberos configuration.
#kerberos.config_path: /etc/krb5.conf
# Name of the Kerberos user.
#kerberos.username: elastic
# Password of the Kerberos user. It is used when auth_type is set to password.
#kerberos.password: changeme
# Kerberos realm.
#kerberos.realm: ELASTIC
#metrics.period: 10s
#state.period: 1m
2021-09-23 12:17:14 +02:00
# The `monitoring.cloud.id` setting overwrites the `monitoring.elasticsearch.hosts`
# setting. You can find the value for this setting in the Elastic Cloud web UI.
#monitoring.cloud.id:
# The `monitoring.cloud.auth` setting overwrites the `monitoring.elasticsearch.username`
# and `monitoring.elasticsearch.password` settings. The format is `<user>:<pass>`.
#monitoring.cloud.auth:
# =============================== HTTP Endpoint ================================
2018-04-06 12:44:37 +02:00
# 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
2020-02-26 15:14:18 +01:00
# The HTTP endpoint will bind to this hostname, IP address, unix socket or named pipe.
# When using IP addresses, it is recommended to only use localhost.
2018-04-06 12:44:37 +02:00
#http.host: localhost
# Port on which the HTTP endpoint will bind. Default is 5066.
#http.port: 5066
2020-02-26 15:14:18 +01:00
# Define which user should be owning the named pipe.
#http.named_pipe.user:
# Define which the permissions that should be applied to the named pipe, use the Security
# Descriptor Definition Language (SDDL) to define the permission. This option cannot be used with
# `http.user`.
#http.named_pipe.security_descriptor:
2022-05-31 10:09:56 +02:00
# Defines if the HTTP pprof endpoints are enabled.
# It is recommended that this is only enabled on localhost as these endpoints may leak data.
#http.pprof.enabled: false
2021-09-23 12:17:14 +02:00
# ============================== Process Security ==============================
# Enable or disable seccomp system call filtering on Linux. Default is enabled.
#seccomp.enabled: true
2019-08-15 14:08:08 +02:00
2021-09-23 12:17:14 +02:00
# ============================== Instrumentation ===============================
# Instrumentation support for the icingabeat.
#instrumentation:
# Set to true to enable instrumentation of icingabeat.
#enabled: false
# Environment in which icingabeat is running on (eg: staging, production, etc.)
#environment: ""
# APM Server hosts to report instrumentation results to.
#hosts:
# - http://localhost:8200
# API Key for the APM Server(s).
# If api_key is set then secret_token will be ignored.
#api_key:
# Secret token for the APM Server(s).
#secret_token:
# Enable profiling of the server, recording profile samples as events.
#
# This feature is experimental.
#profiling:
#cpu:
# Set to true to enable CPU profiling.
#enabled: false
#interval: 60s
#duration: 10s
#heap:
# Set to true to enable heap profiling.
#enabled: false
#interval: 60s
# ================================= Migration ==================================
2019-08-15 14:08:08 +02:00
# This allows to enable 6.7 migration aliases
#migration.6_to_7.enabled: false
2021-09-23 12:17:14 +02:00