diff --git a/auditbeat/auditbeat.reference.yml b/auditbeat/auditbeat.reference.yml index 825466b4b3a..bbc3f1ace5c 100644 --- a/auditbeat/auditbeat.reference.yml +++ b/auditbeat/auditbeat.reference.yml @@ -195,7 +195,7 @@ auditbeat.modules: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -209,7 +209,7 @@ auditbeat.modules: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -366,7 +366,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -374,7 +374,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -390,14 +390,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -420,39 +420,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -474,7 +473,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -484,7 +483,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -517,7 +516,7 @@ output.elasticsearch: # 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. + # 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 @@ -526,7 +525,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -537,7 +536,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -546,7 +545,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -573,7 +572,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -582,7 +581,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -608,20 +607,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -631,7 +630,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -679,7 +678,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -692,7 +691,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -708,7 +707,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -725,10 +724,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -741,7 +740,7 @@ output.elasticsearch: # default is auditbeat. #key: auditbeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -842,10 +841,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -877,10 +876,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -968,12 +967,12 @@ output.elasticsearch: #setup.template.enabled: true # Template name. By default the template name is "auditbeat-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.name: "auditbeat-%{[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. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.pattern: "auditbeat-%{[beat.version]}-*" # Path to fields.yml file to generate the template @@ -986,10 +985,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -1031,7 +1030,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -1043,27 +1042,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1122,10 +1121,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1158,7 +1157,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1190,7 +1189,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1202,27 +1201,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/filebeat/filebeat.reference.yml b/filebeat/filebeat.reference.yml index 51c8881e5ed..2a5a5d1b7e4 100644 --- a/filebeat/filebeat.reference.yml +++ b/filebeat/filebeat.reference.yml @@ -890,7 +890,7 @@ filebeat.inputs: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -904,7 +904,7 @@ filebeat.inputs: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -1061,7 +1061,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -1069,7 +1069,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1085,14 +1085,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -1115,39 +1115,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1169,7 +1168,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -1179,7 +1178,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -1212,7 +1211,7 @@ output.elasticsearch: # 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. + # 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 @@ -1221,7 +1220,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -1232,7 +1231,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -1241,7 +1240,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1268,7 +1267,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -1277,7 +1276,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -1303,20 +1302,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -1326,7 +1325,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -1374,7 +1373,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -1387,7 +1386,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -1403,7 +1402,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1420,10 +1419,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -1436,7 +1435,7 @@ output.elasticsearch: # default is filebeat. #key: filebeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -1537,10 +1536,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -1572,10 +1571,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -1663,12 +1662,12 @@ output.elasticsearch: #setup.template.enabled: true # Template name. By default the template name is "filebeat-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.name: "filebeat-%{[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. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.pattern: "filebeat-%{[beat.version]}-*" # Path to fields.yml file to generate the template @@ -1681,10 +1680,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -1726,7 +1725,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -1738,27 +1737,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1817,10 +1816,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1853,7 +1852,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1885,7 +1884,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1897,27 +1896,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml index 99ccee877a8..1033a04ffa1 100644 --- a/heartbeat/heartbeat.reference.yml +++ b/heartbeat/heartbeat.reference.yml @@ -339,7 +339,7 @@ heartbeat.scheduler: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -353,7 +353,7 @@ heartbeat.scheduler: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -510,7 +510,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -518,7 +518,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -534,14 +534,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -564,39 +564,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -618,7 +617,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -628,7 +627,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -661,7 +660,7 @@ output.elasticsearch: # 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. + # 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 @@ -670,7 +669,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -681,7 +680,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -690,7 +689,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -717,7 +716,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -726,7 +725,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -752,20 +751,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -775,7 +774,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -823,7 +822,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -836,7 +835,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -852,7 +851,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -869,10 +868,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -885,7 +884,7 @@ output.elasticsearch: # default is heartbeat. #key: heartbeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -986,10 +985,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -1021,10 +1020,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -1112,12 +1111,12 @@ output.elasticsearch: #setup.template.enabled: true # Template name. By default the template name is "heartbeat-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.name: "heartbeat-%{[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. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.pattern: "heartbeat-%{[beat.version]}-*" # Path to fields.yml file to generate the template @@ -1130,10 +1129,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -1175,7 +1174,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -1187,27 +1186,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1266,10 +1265,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1302,7 +1301,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1334,7 +1333,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1346,27 +1345,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/journalbeat/journalbeat.reference.yml b/journalbeat/journalbeat.reference.yml index b53113f516e..d4a003f9dc9 100644 --- a/journalbeat/journalbeat.reference.yml +++ b/journalbeat/journalbeat.reference.yml @@ -129,7 +129,7 @@ journalbeat.inputs: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -143,7 +143,7 @@ journalbeat.inputs: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -300,7 +300,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -308,7 +308,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -324,14 +324,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -354,39 +354,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -408,7 +407,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -418,7 +417,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -451,7 +450,7 @@ output.elasticsearch: # 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. + # 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 @@ -460,7 +459,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -471,7 +470,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -480,7 +479,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -507,7 +506,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -516,7 +515,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -542,20 +541,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -565,7 +564,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -613,7 +612,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -626,7 +625,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -642,7 +641,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -659,10 +658,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -675,7 +674,7 @@ output.elasticsearch: # default is journalbeat. #key: journalbeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -776,10 +775,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -811,10 +810,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -902,12 +901,12 @@ output.elasticsearch: #setup.template.enabled: true # Template name. By default the template name is "journalbeat-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.name: "journalbeat-%{[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. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.pattern: "journalbeat-%{[beat.version]}-*" # Path to fields.yml file to generate the template @@ -920,10 +919,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -965,7 +964,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -977,27 +976,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1056,10 +1055,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1092,7 +1091,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1124,7 +1123,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1136,27 +1135,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/libbeat/_meta/config.reference.yml b/libbeat/_meta/config.reference.yml index fe458d66775..cca7344d84f 100644 --- a/libbeat/_meta/config.reference.yml +++ b/libbeat/_meta/config.reference.yml @@ -83,7 +83,7 @@ # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -97,7 +97,7 @@ #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -254,7 +254,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -262,7 +262,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -278,14 +278,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -308,39 +308,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -362,7 +361,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -372,7 +371,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -405,7 +404,7 @@ output.elasticsearch: # 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. + # 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 @@ -414,7 +413,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -425,7 +424,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -434,7 +433,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -461,7 +460,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -470,7 +469,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -496,20 +495,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -519,7 +518,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -567,7 +566,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -580,7 +579,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -596,7 +595,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -613,10 +612,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -629,7 +628,7 @@ output.elasticsearch: # default is beatname. #key: beatname - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -730,10 +729,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -765,10 +764,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -856,12 +855,12 @@ output.elasticsearch: #setup.template.enabled: true # Template name. By default the template name is "beat-index-prefix-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.name: "beat-index-prefix-%{[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. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.pattern: "beat-index-prefix-%{[beat.version]}-*" # Path to fields.yml file to generate the template @@ -874,10 +873,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -919,7 +918,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -931,27 +930,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1010,10 +1009,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1046,7 +1045,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1078,7 +1077,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1090,27 +1089,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml index 26ad57ed02d..3f3d29ce8a4 100644 --- a/metricbeat/metricbeat.reference.yml +++ b/metricbeat/metricbeat.reference.yml @@ -770,7 +770,7 @@ metricbeat.modules: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -784,7 +784,7 @@ metricbeat.modules: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -941,7 +941,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -949,7 +949,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -965,14 +965,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -995,39 +995,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1049,7 +1048,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -1059,7 +1058,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -1092,7 +1091,7 @@ output.elasticsearch: # 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. + # 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 @@ -1101,7 +1100,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -1112,7 +1111,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -1121,7 +1120,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1148,7 +1147,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -1157,7 +1156,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -1183,20 +1182,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -1206,7 +1205,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -1254,7 +1253,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -1267,7 +1266,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -1283,7 +1282,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1300,10 +1299,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -1316,7 +1315,7 @@ output.elasticsearch: # default is metricbeat. #key: metricbeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -1417,10 +1416,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -1452,10 +1451,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -1543,12 +1542,12 @@ output.elasticsearch: #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. +# 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. +# 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 @@ -1561,10 +1560,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -1606,7 +1605,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -1618,27 +1617,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1697,10 +1696,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1733,7 +1732,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1765,7 +1764,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1777,27 +1776,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml index ad1b43fa4b6..aa93d925d54 100644 --- a/packetbeat/packetbeat.reference.yml +++ b/packetbeat/packetbeat.reference.yml @@ -572,7 +572,7 @@ packetbeat.protocols: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -586,7 +586,7 @@ packetbeat.protocols: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -743,7 +743,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -751,7 +751,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -767,14 +767,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -797,39 +797,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -851,7 +850,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -861,7 +860,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -894,7 +893,7 @@ output.elasticsearch: # 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. + # 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 @@ -903,7 +902,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -914,7 +913,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -923,7 +922,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -950,7 +949,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -959,7 +958,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -985,20 +984,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -1008,7 +1007,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -1056,7 +1055,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -1069,7 +1068,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -1085,7 +1084,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1102,10 +1101,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -1118,7 +1117,7 @@ output.elasticsearch: # default is packetbeat. #key: packetbeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -1219,10 +1218,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -1254,10 +1253,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -1345,12 +1344,12 @@ output.elasticsearch: #setup.template.enabled: true # Template name. By default the template name is "packetbeat-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.name: "packetbeat-%{[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. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.pattern: "packetbeat-%{[beat.version]}-*" # Path to fields.yml file to generate the template @@ -1363,10 +1362,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -1408,7 +1407,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -1420,27 +1419,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1499,10 +1498,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1535,7 +1534,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1567,7 +1566,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1579,27 +1578,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/winlogbeat/winlogbeat.reference.yml b/winlogbeat/winlogbeat.reference.yml index d2487c225ec..d8585af89ca 100644 --- a/winlogbeat/winlogbeat.reference.yml +++ b/winlogbeat/winlogbeat.reference.yml @@ -112,7 +112,7 @@ winlogbeat.event_logs: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -126,7 +126,7 @@ winlogbeat.event_logs: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -283,7 +283,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -291,7 +291,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -307,14 +307,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -337,39 +337,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -391,7 +390,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -401,7 +400,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -434,7 +433,7 @@ output.elasticsearch: # 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. + # 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 @@ -443,7 +442,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -454,7 +453,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -463,7 +462,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -490,7 +489,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -499,7 +498,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -525,20 +524,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -548,7 +547,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -596,7 +595,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -609,7 +608,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -625,7 +624,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -642,10 +641,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -658,7 +657,7 @@ output.elasticsearch: # default is winlogbeat. #key: winlogbeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -759,10 +758,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -794,10 +793,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -885,12 +884,12 @@ output.elasticsearch: #setup.template.enabled: true # Template name. By default the template name is "winlogbeat-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.name: "winlogbeat-%{[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. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.pattern: "winlogbeat-%{[beat.version]}-*" # Path to fields.yml file to generate the template @@ -903,10 +902,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -948,7 +947,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -960,27 +959,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1039,10 +1038,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1075,7 +1074,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1107,7 +1106,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1119,27 +1118,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/x-pack/auditbeat/auditbeat.reference.yml b/x-pack/auditbeat/auditbeat.reference.yml index cbadf7596a9..7b7d36dc6c9 100644 --- a/x-pack/auditbeat/auditbeat.reference.yml +++ b/x-pack/auditbeat/auditbeat.reference.yml @@ -221,7 +221,7 @@ auditbeat.modules: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -235,7 +235,7 @@ auditbeat.modules: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -392,7 +392,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -400,7 +400,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -416,14 +416,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -446,39 +446,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -500,7 +499,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -510,7 +509,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -543,7 +542,7 @@ output.elasticsearch: # 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. + # 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 @@ -552,7 +551,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -563,7 +562,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -572,7 +571,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -599,7 +598,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -608,7 +607,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -634,20 +633,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -657,7 +656,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -705,7 +704,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -718,7 +717,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -734,7 +733,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -751,10 +750,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -767,7 +766,7 @@ output.elasticsearch: # default is auditbeat. #key: auditbeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -868,10 +867,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -903,10 +902,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -994,12 +993,12 @@ output.elasticsearch: #setup.template.enabled: true # Template name. By default the template name is "auditbeat-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.name: "auditbeat-%{[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. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.pattern: "auditbeat-%{[beat.version]}-*" # Path to fields.yml file to generate the template @@ -1012,10 +1011,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -1057,7 +1056,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -1069,27 +1068,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1148,10 +1147,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1184,7 +1183,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1216,7 +1215,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1228,27 +1227,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/x-pack/filebeat/filebeat.reference.yml b/x-pack/filebeat/filebeat.reference.yml index b32717a9e2b..db402aa28da 100644 --- a/x-pack/filebeat/filebeat.reference.yml +++ b/x-pack/filebeat/filebeat.reference.yml @@ -924,7 +924,7 @@ filebeat.inputs: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -938,7 +938,7 @@ filebeat.inputs: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -1095,7 +1095,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -1103,7 +1103,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1119,14 +1119,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -1149,39 +1149,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1203,7 +1202,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -1213,7 +1212,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -1246,7 +1245,7 @@ output.elasticsearch: # 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. + # 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 @@ -1255,7 +1254,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -1266,7 +1265,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -1275,7 +1274,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1302,7 +1301,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -1311,7 +1310,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -1337,20 +1336,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -1360,7 +1359,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -1408,7 +1407,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -1421,7 +1420,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -1437,7 +1436,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1454,10 +1453,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -1470,7 +1469,7 @@ output.elasticsearch: # default is filebeat. #key: filebeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -1571,10 +1570,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -1606,10 +1605,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -1697,12 +1696,12 @@ output.elasticsearch: #setup.template.enabled: true # Template name. By default the template name is "filebeat-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.name: "filebeat-%{[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. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.pattern: "filebeat-%{[beat.version]}-*" # Path to fields.yml file to generate the template @@ -1715,10 +1714,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -1760,7 +1759,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -1772,27 +1771,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1851,10 +1850,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1887,7 +1886,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1919,7 +1918,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1931,27 +1930,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/x-pack/functionbeat/functionbeat.reference.yml b/x-pack/functionbeat/functionbeat.reference.yml index 65caa69cc84..84340a232dc 100644 --- a/x-pack/functionbeat/functionbeat.reference.yml +++ b/x-pack/functionbeat/functionbeat.reference.yml @@ -177,7 +177,7 @@ functionbeat.provider.aws.functions: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -191,7 +191,7 @@ functionbeat.provider.aws.functions: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -348,7 +348,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -356,7 +356,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -372,14 +372,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -402,39 +402,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -456,7 +455,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -466,7 +465,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -499,7 +498,7 @@ output.elasticsearch: # 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. + # 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 @@ -508,7 +507,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -519,7 +518,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -528,7 +527,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -555,7 +554,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -564,7 +563,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -590,20 +589,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -613,7 +612,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -661,7 +660,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -674,7 +673,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -690,7 +689,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -707,10 +706,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -723,7 +722,7 @@ output.elasticsearch: # default is functionbeat. #key: functionbeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -824,10 +823,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -859,10 +858,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -950,12 +949,12 @@ output.elasticsearch: #setup.template.enabled: true # Template name. By default the template name is "functionbeat-%{[beat.version]}" -# The template name and pattern has to be set in case the elasticsearch index pattern is modified. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.name: "functionbeat-%{[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. +# The template name and pattern has to be set in case the Elasticsearch index pattern is modified. #setup.template.pattern: "functionbeat-%{[beat.version]}-*" # Path to fields.yml file to generate the template @@ -968,10 +967,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -1013,7 +1012,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -1025,27 +1024,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1104,10 +1103,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1140,7 +1139,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1172,7 +1171,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1184,27 +1183,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml index 954e8e42d19..97202c7b51e 100644 --- a/x-pack/metricbeat/metricbeat.reference.yml +++ b/x-pack/metricbeat/metricbeat.reference.yml @@ -778,7 +778,7 @@ metricbeat.modules: # Sets the write buffer size. #buffer_size: 1MiB - # Maximum duration after which events are flushed, if the write buffer + # Maximum duration after which events are flushed if the write buffer # is not full yet. The default value is 1s. #flush.timeout: 1s @@ -792,7 +792,7 @@ metricbeat.modules: #codec: cbor #read: # Reader flush timeout, waiting for more events to become available, so - # to fill a complete batch, as required by the outputs. + # to fill a complete batch as required by the outputs. # If flush_timeout is 0, all available events are forwarded to the # outputs immediately. # The default value is 0s. @@ -949,7 +949,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 0 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional protocol and basic auth credentials. @@ -957,7 +957,7 @@ output.elasticsearch: #username: "elastic" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -973,14 +973,14 @@ output.elasticsearch: # Optional ingest node pipeline. By default no pipeline will be used. #pipeline: "" - # Optional HTTP Path + # 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 server URL #proxy_url: http://proxy:3128 # The number of times a particular Elasticsearch index operation is attempted. If @@ -1003,39 +1003,38 @@ output.elasticsearch: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing a request to Elasticsearch. + # Configure HTTP request timeout before failing a 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 + # 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 + # List of supported/valid TLS versions. By default all TLS versions from 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1057,7 +1056,7 @@ output.elasticsearch: # Set gzip compression level. #compression_level: 3 - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Optional maximum time to live for a connection to Logstash, after which the @@ -1067,7 +1066,7 @@ output.elasticsearch: # 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. + # Optionally load-balance events between Logstash hosts. Default is false. #loadbalance: false # Number of batches to be sent asynchronously to Logstash while processing @@ -1100,7 +1099,7 @@ output.elasticsearch: # 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. + # 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 @@ -1109,7 +1108,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -1120,7 +1119,7 @@ output.elasticsearch: # Certificate for SSL client authentication #ssl.certificate: "/etc/pki/client/cert.pem" - # Client Certificate Key + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" # Optional passphrase for decrypting the Certificate Key. @@ -1129,7 +1128,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1156,7 +1155,7 @@ output.elasticsearch: # 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 list of Kafka broker addresses from which to fetch the cluster metadata. # The cluster metadata contain the actual Kafka brokers events are published # to. #hosts: ["localhost:9092"] @@ -1165,7 +1164,7 @@ output.elasticsearch: # 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. + # The Kafka event key setting. Use format string to create a unique event key. # By default no event key will be generated. #key: '' @@ -1191,20 +1190,20 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # Metadata update configuration. Metadata do contain leader information - # deciding which broker to use when publishing. + # Metadata update configuration. Metadata contains leader information + # used to decide 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. + # Wait time between retries during leader elections. Default is 250ms. #retry.backoff: 250ms # Refresh metadata interval. Defaults to every 10 minutes. @@ -1214,7 +1213,7 @@ output.elasticsearch: #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. + # After the specified number of retries, 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. @@ -1262,7 +1261,7 @@ output.elasticsearch: # purposes. The default is "beats". #client_id: beats - # Enable SSL support. SSL is automatically enabled, if any SSL setting is set. + # 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. @@ -1275,7 +1274,7 @@ output.elasticsearch: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] @@ -1291,7 +1290,7 @@ output.elasticsearch: # Configure cipher suites to be used for SSL connections #ssl.cipher_suites: [] - # Configure curve types for ECDHE based cipher suites + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are @@ -1308,10 +1307,10 @@ output.elasticsearch: # Pretty print json event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true - # The list of Redis servers to connect to. If load balancing is enabled, the + # 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"] @@ -1324,7 +1323,7 @@ output.elasticsearch: # default is metricbeat. #key: metricbeat - # The password to authenticate with. The default is no authentication. + # The password to authenticate to Redis with. The default is no authentication. #password: # The Redis database number where the events are published. The default is 0. @@ -1425,10 +1424,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true # Path to the directory where to save the generated files. The option is @@ -1460,10 +1459,10 @@ output.elasticsearch: # Configure JSON encoding #codec.json: - # Pretty print json event + # Pretty-print JSON event #pretty: false - # Configure escaping html symbols in strings. + # Configure escaping HTML symbols in strings. #escape_html: true #================================= Paths ====================================== @@ -1551,12 +1550,12 @@ output.elasticsearch: #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. +# 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. +# 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 @@ -1569,10 +1568,10 @@ output.elasticsearch: #- name: field_name # type: field_type -# Enable json template loading. If this is enabled, the fields.yml is ignored. +# Enable JSON template loading. If this is enabled, the fields.yml is ignored. #setup.template.json.enabled: false -# Path to the json template file +# Path to the JSON template file #setup.template.json.path: "${path.config}/template.json" # Name under which the template is stored in Elasticsearch @@ -1614,7 +1613,7 @@ setup.kibana: #username: "elastic" #password: "changeme" - # Optional HTTP Path + # Optional HTTP path #path: "" # Use SSL settings for HTTPS. Default is true. @@ -1626,27 +1625,27 @@ setup.kibana: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] @@ -1705,10 +1704,10 @@ logging.files: # 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 - # unix epoch. Defaults to disabled. + # Unix epoch. Defaults to disabled. #interval: 0 -# Set to true to log messages in json format. +# Set to true to log messages in JSON format. #logging.json: false @@ -1741,7 +1740,7 @@ logging.files: #username: "beats_system" #password: "changeme" - # Dictionary of HTTP parameters to pass within the url with index operations. + # Dictionary of HTTP parameters to pass within the URL with index operations. #parameters: #param1: value1 #param2: value2 @@ -1773,7 +1772,7 @@ logging.files: # Elasticsearch after a network error. The default is 60s. #backoff.max: 60s - # Configure http request timeout before failing an request to Elasticsearch. + # Configure HTTP request timeout before failing an request to Elasticsearch. #timeout: 90 # Use SSL settings for HTTPS. @@ -1785,27 +1784,27 @@ logging.files: # `full`. #ssl.verification_mode: full - # List of supported/valid TLS versions. By default all TLS versions 1.0 up to + # List of supported/valid TLS versions. By default all TLS versions from 1.0 up to # 1.2 are enabled. #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2] - # SSL configuration. By default is off. + # SSL configuration. The 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 + # Client certificate key #ssl.key: "/etc/pki/client/cert.key" - # Optional passphrase for decrypting the Certificate 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 + # Configure curve types for ECDHE-based cipher suites #ssl.curve_types: [] # Configure what types of renegotiation are supported. Valid options are