diff --git a/filebeat/docs/configuring-howto.asciidoc b/filebeat/docs/configuring-howto.asciidoc index 5fc2ac741d9a..2e950362de0e 100644 --- a/filebeat/docs/configuring-howto.asciidoc +++ b/filebeat/docs/configuring-howto.asciidoc @@ -25,4 +25,5 @@ The following topics describe how to configure Filebeat: -- +pass::[] include::reference/configuration.asciidoc[] diff --git a/filebeat/docs/index.asciidoc b/filebeat/docs/index.asciidoc index 7e4d197a9486..79839219d858 100644 --- a/filebeat/docs/index.asciidoc +++ b/filebeat/docs/index.asciidoc @@ -16,41 +16,60 @@ include::../../libbeat/docs/version.asciidoc[] include::./overview.asciidoc[] +pass::[] include::./getting-started.asciidoc[] +pass::[] include::./command-line.asciidoc[] +pass::[] include::../../libbeat/docs/shared-directory-layout.asciidoc[] +pass::[] include::./upgrading.asciidoc[] +pass::[] include::./how-filebeat-works.asciidoc[] +pass::[] include::./configuring-howto.asciidoc[] +pass::[] include::./filebeat-filtering.asciidoc[] +pass::[] include::./multiline.asciidoc[] +pass::[] include::../../libbeat/docs/shared-config-ingest.asciidoc[] +pass::[] include::../../libbeat/docs/shared-env-vars.asciidoc[] +pass::[] include::./multiple-prospectors.asciidoc[] +pass::[] include::./load-balancing.asciidoc[] :allplatforms: +pass::[] include::../../libbeat/docs/yaml.asciidoc[] +pass::[] include::../../libbeat/docs/regexp.asciidoc[] +pass::[] include::./fields.asciidoc[] +pass::[] include::./securing-filebeat.asciidoc[] +pass::[] include::./troubleshooting.asciidoc[] +pass::[] include::./faq.asciidoc[] +pass::[] include::./migration.asciidoc[] diff --git a/filebeat/docs/reference/configuration.asciidoc b/filebeat/docs/reference/configuration.asciidoc index 309158a36ed7..05d9ec0c05ee 100644 --- a/filebeat/docs/reference/configuration.asciidoc +++ b/filebeat/docs/reference/configuration.asciidoc @@ -23,6 +23,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> +pass::[] include::configuration/filebeat-options.asciidoc[] diff --git a/filebeat/docs/reference/configuration/filebeat-options.asciidoc b/filebeat/docs/reference/configuration/filebeat-options.asciidoc index 92b9d3edd667..599697728f23 100644 --- a/filebeat/docs/reference/configuration/filebeat-options.asciidoc +++ b/filebeat/docs/reference/configuration/filebeat-options.asciidoc @@ -240,7 +240,9 @@ When this option is enabled, Filebeat closes a file as soon as the end of a file WARNING: Only use this option if you understand that data loss is a potential side effect. Another side effect is that multiline events might not be completely sent before the timeout expires. -When this option is enabled, Filebeat gives every harvester a predefined lifetime. Regardless of where the reader is in the file, reading will stop after the `close_timeout` period has elapsed. This option can be useful for older log files when you want to spend only a predefined amount of time on the files. If you set `close_timeout` to equal `ignore_older`, the file will not be picked up if it's modified while the harvester is closed. This combination of settings normally leads to data loss, and the complete file is not sent. +When this option is enabled, Filebeat gives every harvester a predefined lifetime. Regardless of where the reader is in the file, reading will stop after the `close_timeout` period has elapsed. This option can be useful for older log files when you want to spend only a predefined amount of time on the files. While `close_timeout` will close the file after the predefined timeout, if the file is still being updated, the prospector will start a new harvester again per the defined `scan_frequency`. And the close_timeout for this harvester will start again with the countdown for the timeout. + +If you set `close_timeout` to equal `ignore_older`, the file will not be picked up if it's modified while the harvester is closed. This combination of settings normally leads to data loss, and the complete file is not sent. When you use `close_timeout` for logs that contain multiline events, the harvester might stop in the middle of a multiline event, which means that only parts of the event will be sent. If the harvester is started again and the file still exists, only the second part of the event will be sent. @@ -567,13 +569,18 @@ Example configuration: filebeat.shutdown_timeout: 5s ------------------------------------------------------------------------------------- +pass::[] include::../../../../libbeat/docs/generalconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/outputconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/shared-path-config.asciidoc[] +pass::[] include::../../../../libbeat/docs/loggingconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/processors-config.asciidoc[] diff --git a/filebeat/docs/securing-filebeat.asciidoc b/filebeat/docs/securing-filebeat.asciidoc index df525cf5d301..47856fa76332 100644 --- a/filebeat/docs/securing-filebeat.asciidoc +++ b/filebeat/docs/securing-filebeat.asciidoc @@ -9,12 +9,20 @@ The following topics describe how to secure communication between Filebeat and o * <> * <> +//sets block macro for https.asciidoc included in next section +pass::[] + -- [[securing-communication-elasticsearch]] == Securing Communication With Elasticsearch + include::../../libbeat/docs/https.asciidoc[] +//sets block macro for shared-ssl-logstash-config.asciidoc included in next section +pass::[] + [[configuring-ssl-logstash]] == Securing Communication With Logstash by Using SSL + include::../../libbeat/docs/shared-ssl-logstash-config.asciidoc[] \ No newline at end of file diff --git a/filebeat/docs/troubleshooting.asciidoc b/filebeat/docs/troubleshooting.asciidoc index c925d521a6fa..d4cf477c387b 100644 --- a/filebeat/docs/troubleshooting.asciidoc +++ b/filebeat/docs/troubleshooting.asciidoc @@ -10,6 +10,9 @@ following tips: * <> * <> +//sets block macro for getting-help.asciidoc included in next section +pass::[] + -- [[getting-help]] @@ -17,6 +20,9 @@ following tips: include::../../libbeat/docs/getting-help.asciidoc[] +//sets block macro for debugging.asciidoc included in next section +pass::[] + [[enable-filebeat-debugging]] == Debugging diff --git a/libbeat/docs/dashboards.asciidoc b/libbeat/docs/dashboards.asciidoc index de6e95aed9cd..8bc7ce3023e7 100644 --- a/libbeat/docs/dashboards.asciidoc +++ b/libbeat/docs/dashboards.asciidoc @@ -19,7 +19,7 @@ visualizations, and searches for {beatname_uc}. The script also creates an index +{beatname_lc}-*+, for {beatname_uc}. The steps in this section show how to import {beatname_uc} dashboards. You may want to import dashboards for more than -one Beat or specify import options that aren't described here. See {libbeat}/[Importing Existing Beat Dashboards] +one Beat or specify import options that aren't described here. See {libbeat}/import-dashboards.html[Importing Existing Beat Dashboards] in the _Beats Platform Reference_ for a full list of command-line options. To import the Kibana dashboards for {beatname_uc}: diff --git a/libbeat/docs/index.asciidoc b/libbeat/docs/index.asciidoc index 3978f3e8daa2..6e61597ad92e 100644 --- a/libbeat/docs/index.asciidoc +++ b/libbeat/docs/index.asciidoc @@ -16,28 +16,39 @@ include::./version.asciidoc[] include::./overview.asciidoc[] +pass::[] include::./communitybeats.asciidoc[] +pass::[] include::./gettingstarted.asciidoc[] +pass::[] include::./installing-beats.asciidoc[] +pass::[] include::./repositories.asciidoc[] +pass::[] include::./breaking.asciidoc[] +pass::[] include::./upgrading.asciidoc[] +pass::[] include::./config-file-format.asciidoc[] pass::[] +pass::[] include::./newbeat.asciidoc[] +pass::[] include::./event-conventions.asciidoc[] +pass::[] include::./newdashboards.asciidoc[] pass::[] +pass::[] include::./release.asciidoc[] diff --git a/libbeat/docs/outputconfig.asciidoc b/libbeat/docs/outputconfig.asciidoc index 0d58a2f13951..088442c782e4 100644 --- a/libbeat/docs/outputconfig.asciidoc +++ b/libbeat/docs/outputconfig.asciidoc @@ -617,7 +617,8 @@ Valid values are `0.8.2.0`, `0.8.2.1`, `0.8.2.2`, `0.8.2`, `0.8`, `0.9.0.0`, ===== username -The username for connecting to Kafka. If username is configured, the passowrd must be configured as well. Only SASL/PLAIN is supported. +The username for connecting to Kafka. If username is configured, the password +must be configured as well. Only SASL/PLAIN is supported. ===== password @@ -657,7 +658,7 @@ Kafka output broker event partitioning strategy. Must be one of `random`, *`random.group_events`*: Sets the number of events to be published to the same partition, before the partitioner selects a new partition by random. The - default value is 1 meaning after each event a new parition is picked randomly. + default value is 1 meaning after each event a new partition is picked randomly. *`round_robin.group_events`*: Sets the number of events to be published to the same partition, before the partitioner selects the next partition. The default @@ -689,7 +690,7 @@ The number of concurrent load-balanced Kafka output workers. Kafka metadata update settings. The metadata do contain information about brokers, topics, partition, and active leaders to use for publishing. -*`refresh_frequency`*:: Metadata refreash interval. Defaults to 10 minutes. +*`refresh_frequency`*:: Metadata refresh interval. Defaults to 10 minutes. *`retry.max`*:: Total number of metadata update retries when cluster is in middle of leader election. The default is 3. @@ -1104,7 +1105,7 @@ The client certificate key used for client authentication. This option is requir The passphrase used to decrypt an encrypted key stored in the configured `key` file. -===== versions +===== supported_protocols List of allowed SSL/TLS versions. If SSL/TLS server decides for protocol versions not configured, the connection will be dropped during or after the handshake. The diff --git a/libbeat/docs/processors-config.asciidoc b/libbeat/docs/processors-config.asciidoc index c1201dcabed5..9525d6310fe6 100644 --- a/libbeat/docs/processors-config.asciidoc +++ b/libbeat/docs/processors-config.asciidoc @@ -114,7 +114,7 @@ For example, the following condition checks if the process name starts with [source,yaml] ----- -reqexp: +regexp: system.process.name: "foo.*" ----- diff --git a/metricbeat/_meta/beat.full.yml b/metricbeat/_meta/beat.full.yml index df35fcd24aa9..e788d9dddea1 100644 --- a/metricbeat/_meta/beat.full.yml +++ b/metricbeat/_meta/beat.full.yml @@ -95,7 +95,7 @@ metricbeat.modules: #certificate: "/etc/pki/client/cert.pem" #key: "/etc/pki/client/cert.key" -#------------------------------- haproxy Module ------------------------------ +#------------------------------- HAProxy Module ------------------------------ #- module: haproxy #metricsets: ["info", "stat"] #enabled: true diff --git a/metricbeat/docs/configuring-howto.asciidoc b/metricbeat/docs/configuring-howto.asciidoc index 3cd8c7b6ba00..a983d4d2c793 100644 --- a/metricbeat/docs/configuring-howto.asciidoc +++ b/metricbeat/docs/configuring-howto.asciidoc @@ -95,4 +95,5 @@ metricbeat: -- +pass::[] include::reference/configuration.asciidoc[] diff --git a/metricbeat/docs/developer-guide/index.asciidoc b/metricbeat/docs/developer-guide/index.asciidoc index bb94d3b09ba1..04861893de77 100644 --- a/metricbeat/docs/developer-guide/index.asciidoc +++ b/metricbeat/docs/developer-guide/index.asciidoc @@ -58,13 +58,17 @@ directly from the service itself and not via a third-party tool. The goal is to have as few movable parts as possible and for Metricbeat to run as close as possible to the service that it needs to monitor. - +pass::[] include::./create-metricset.asciidoc[] +pass::[] include::./metricset-details.asciidoc[] +pass::[] include::./create-module.asciidoc[] +pass::[] include::./creating-beat-from-metricbeat.asciidoc[] +pass::[] include::./faq.asciidoc[] diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc index ffe2c2acce7a..c28f98b46667 100644 --- a/metricbeat/docs/fields.asciidoc +++ b/metricbeat/docs/fields.asciidoc @@ -1417,24 +1417,24 @@ Total number of outgoing packets. [[exported-fields-haproxy]] -== haproxy Fields +== HAProxy Fields experimental[] -haproxy Module +HAProxy Module [float] == haproxy Fields -HAProx metrics. +HAProxy metrics. [float] == info Fields -General infomration collected on HAProxy process +General information about HAProxy processes. @@ -1443,7 +1443,7 @@ General infomration collected on HAProxy process type: long -Number of processes +Number of processes. [float] @@ -1451,7 +1451,7 @@ Number of processes type: long -Process number +Process number. [float] @@ -1459,7 +1459,7 @@ Process number type: long -Process ID +Process ID. [float] @@ -1481,7 +1481,7 @@ type: long type: long -Current uptime in seconds +Current uptime in seconds. [float] @@ -1491,7 +1491,7 @@ type: long format: bytes -Max number of memory usage in bytes (The 'Memmax_MB' value converted to bytes) +Maximum amount of memory usage in bytes (the 'Memmax_MB' value converted to bytes). [float] @@ -1499,7 +1499,7 @@ Max number of memory usage in bytes (The 'Memmax_MB' value converted to bytes) type: long -Max number of open files for process +Maximum number of open files for the process. [float] @@ -1573,7 +1573,7 @@ type: long type: long -Current Connections +Current connections. [float] @@ -1581,7 +1581,7 @@ Current Connections type: long -Total Connections +Total connections. [float] @@ -1589,7 +1589,7 @@ Total Connections type: long -Current ssl Connections +Current SSL connections. [float] @@ -1597,7 +1597,7 @@ Current ssl Connections type: long -Current Connections +Total SSL connections. [float] @@ -1605,7 +1605,7 @@ Current Connections type: long -Current Connections +Maximum SSL connections. [float] @@ -1613,7 +1613,7 @@ Current Connections type: long -Max connections +Maximum connections. [float] @@ -1820,7 +1820,7 @@ format: percent [float] == stat Fields -Stats collected from HAProxy process +Stats collected from HAProxy processes. @@ -1829,7 +1829,7 @@ Stats collected from HAProxy process type: keyword -status (UP/DOWN/NOLB/MAINT/MAINT(via)...) +Status (UP, DOWN, NOLB, MAINT, or MAINT(via)...). [float] @@ -1837,7 +1837,7 @@ status (UP/DOWN/NOLB/MAINT/MAINT(via)...) type: long -total weight (backend), server weight (server) +Total weight (for backends), or server weight (for servers). [float] @@ -1845,7 +1845,7 @@ total weight (backend), server weight (server) type: long -total downtime (in seconds). The value for the backend is the downtime for the whole backend, not the sum of the server downtime. +Total downtime (in seconds). For backends, this value is the downtime for the whole backend, not the sum of the downtime for the servers. [float] @@ -1853,7 +1853,7 @@ total downtime (in seconds). The value for the backend is the downtime for the w type: integer -(0=frontend, 1=backend, 2=server, 3=socket/listener) +Component type (0=frontend, 1=backend, 2=server, or 3=socket/listener). [float] @@ -1861,7 +1861,7 @@ type: integer type: integer -process id (0 for first instance, 1 for second, ...) +Process ID (0 for first instance, 1 for second, and so on). [float] @@ -1869,7 +1869,7 @@ process id (0 for first instance, 1 for second, ...) type: keyword -service name (FRONTEND for frontend, BACKEND for backend, any name for server/listener) +Service name (FRONTEND for frontend, BACKEND for backend, or any name for server/listener). [float] @@ -1879,7 +1879,7 @@ type: long format: bytes -bytes in +Bytes in. [float] @@ -1889,7 +1889,7 @@ type: long format: bytes -bytes out +Bytes out. [float] @@ -1897,7 +1897,7 @@ bytes out type: integer -number of seconds since the last UP<->DOWN transition +Number of seconds since the last UP->DOWN or DOWN->UP transition. [float] @@ -1907,7 +1907,7 @@ type: scaled_float format: percentage -current throttle percentage for the server, when slowstart is active, or no value if not in slowstart. +Current throttle percentage for the server when slowstart is active, or no value if slowstart is inactive. [float] @@ -1915,7 +1915,7 @@ current throttle percentage for the server, when slowstart is active, or no valu type: long -total number of times a server was selected, either for new sessions, or when re-dispatching. The server counter is the number of times that server was selected. +Total number of times a server was selected, either for new sessions, or when re-dispatching. For servers, this field reports the the number of times the server was selected. [float] @@ -1923,7 +1923,7 @@ total number of times a server was selected, either for new sessions, or when re type: long -id of proxy/server if tracking is enabled. +ID of the proxy/server if tracking is enabled. @@ -1932,7 +1932,7 @@ id of proxy/server if tracking is enabled. type: long -cumulative number of connections +Cumulative number of connections. [float] @@ -1940,7 +1940,7 @@ cumulative number of connections type: long -number of times a connection to a server was retried. +Number of times a connection to a server was retried. [float] @@ -1948,7 +1948,7 @@ number of times a connection to a server was retried. type: long -the average connect time in ms over the 1024 last requests +Average connect time in ms over the last 1024 requests. @@ -1957,9 +1957,10 @@ the average connect time in ms over the 1024 last requests type: long -requests denied because of security concerns. - * For tcp this is because of a matched tcp-request content rule. - * For http this is because of a matched http-request or tarpit rule. +Requests denied because of security concerns. + + * For TCP this is because of a matched tcp-request content rule. + * For HTTP this is because of a matched http-request or tarpit rule. [float] @@ -1967,7 +1968,7 @@ requests denied because of security concerns. type: long -current queued requests. For the backend this reports the number queued without a server assigned +Current queued requests. For backends, this field reports the number of requests queued without a server assigned. [float] @@ -1975,7 +1976,7 @@ current queued requests. For the backend this reports the number queued without type: long -max value of queued.current +Maximum value of queued.current. [float] @@ -1983,8 +1984,9 @@ max value of queued.current type: long -request errors. Some of the possible causes are: - * early termination from the client, before the request has been sent. +Request errors. Some of the possible causes are: + + * early termination from the client, before the request has been sent * read error from the client * client timeout * client closed connection @@ -1997,7 +1999,7 @@ request errors. Some of the possible causes are: type: long -number of times a request was redispatched to another server. The server value counts the number of times that server was switched away from. +Number of times a request was redispatched to another server. For servers, this field reports the number of times the server was switched away from. [float] @@ -2005,7 +2007,7 @@ number of times a request was redispatched to another server. The server value c type: long -number of requests that encountered an error trying to connect to a backend server. The backend stat is the sum of the stat for all servers of that backend, plus any connection errors not associated with a particular server (such as the backend having no active servers). +Number of requests that encountered an error trying to connect to a server. For backends, this field reports the sum of the stat for all backend servers, plus any connection errors not associated with a particular server (such as the backend having no active servers). [float] @@ -2019,7 +2021,7 @@ number of requests that encountered an error trying to connect to a backend serv type: long -HTTP requests per second over last elapsed second +Number of HTTP requests per second over the last elapsed second. [float] @@ -2027,7 +2029,7 @@ HTTP requests per second over last elapsed second type: long -max number of HTTP requests per second observed +Maximum number of HTTP requests per second. [float] @@ -2035,7 +2037,7 @@ max number of HTTP requests per second observed type: long -total number of HTTP requests received +Total number of HTTP requests received. @@ -2044,7 +2046,8 @@ total number of HTTP requests received type: long -response errors. srv_abrt will be counted here also. Some other errors are: * write error on the client socket (won't be counted for the server stat) * failure applying filters to the respons +Number of response errors. This value includes the number of data transfers aborted by the server (haproxy.stat.server.aborted). Some other errors are: +* write errors on the client socket (won't be counted for the server stat) * failure applying filters to the response [float] @@ -2052,7 +2055,7 @@ response errors. srv_abrt will be counted here also. Some other errors are: * wr type: long -the average response time in ms over the 1024 last requests (0 for TCP) +Average response time in ms over the last 1024 requests (0 for TCP). [float] @@ -2060,8 +2063,7 @@ the average response time in ms over the 1024 last requests (0 for TCP) type: integer -responses denied because of security concerns. - * For http this is because of a matched http-request rule, or "option checkcache". +Responses denied because of security concerns. For HTTP this is because of a matched http-request rule, or "option checkcache". [float] @@ -2075,7 +2077,7 @@ responses denied because of security concerns. type: long -http responses with 1xx code +HTTP responses with 1xx code. [float] @@ -2083,7 +2085,7 @@ http responses with 1xx code type: long -http responses with 2xx code +HTTP responses with 2xx code. [float] @@ -2091,7 +2093,7 @@ http responses with 2xx code type: long -http responses with 3xx code +HTTP responses with 3xx code. [float] @@ -2099,7 +2101,7 @@ http responses with 3xx code type: long -http responses with 4xx code +HTTP responses with 4xx code. [float] @@ -2107,7 +2109,7 @@ http responses with 4xx code type: long -http responses with 5xx code +HTTP responses with 5xx code. [float] @@ -2115,7 +2117,7 @@ http responses with 5xx code type: long -http responses with other codes (protocol error) +HTTP responses with other codes (protocol error). @@ -2124,7 +2126,7 @@ http responses with other codes (protocol error) type: long -current sessions +Number of current sessions. [float] @@ -2132,7 +2134,7 @@ current sessions type: long -max sessions +Maximum number of sessions. [float] @@ -2140,7 +2142,7 @@ max sessions type: long -configured session limit +Configured session limit. @@ -2149,7 +2151,7 @@ configured session limit type: integer -number of sessions per second over last elapsed second +Number of sessions per second over the last elapsed second. [float] @@ -2157,7 +2159,7 @@ number of sessions per second over last elapsed second type: integer -configured limit on new sessions per second +Configured limit on new sessions per second. [float] @@ -2165,7 +2167,7 @@ configured limit on new sessions per second type: integer -max number of new sessions per second +Maximum number of new sessions per second. [float] @@ -2179,7 +2181,8 @@ max number of new sessions per second type: keyword -status of last health check, one of: +Status of the last health check. One of: + UNK -> unknown INI -> initializing SOCKERR -> socket error @@ -2203,7 +2206,7 @@ status of last health check, one of: type: long -layer5-7 code, if available +Layer 5-7 code, if available. [float] @@ -2211,7 +2214,7 @@ layer5-7 code, if available type: long -time in ms took to finish last health check +Time in ms that it took to finish the last health check. [float] @@ -2240,7 +2243,7 @@ type: integer type: long -number of failed checks. (Only counts checks failed when the server is up.) +Number of checks that failed while the server was up. [float] @@ -2248,7 +2251,7 @@ number of failed checks. (Only counts checks failed when the server is up.) type: long -number of UP->DOWN transitions. The backend counter counts transitions to the whole backend being down, rather than the sum of the counters for each server. +Number of UP->DOWN transitions. For backends, this value is the number of transitions to the whole backend being down, rather than the sum of the transitions for each server. [float] @@ -2256,7 +2259,7 @@ number of UP->DOWN transitions. The backend counter counts transitions to the wh type: integer -number of data transfers aborted by the client +Number of data transfers aborted by the client. [float] @@ -2270,7 +2273,7 @@ number of data transfers aborted by the client type: integer -server id (unique inside a proxy) +Server ID (unique inside a proxy). [float] @@ -2278,7 +2281,7 @@ server id (unique inside a proxy) type: integer -number of data transfers aborted by the server (inc. in eresp) +Number of data transfers aborted by the server. This value is included in haproxy.stat.response.errors. [float] @@ -2286,7 +2289,7 @@ number of data transfers aborted by the server (inc. in eresp) type: integer -number of active servers (backend), server is active (server) +Number of backend servers that are active, meaning that they are healthy and can receive requests from the load balancer. [float] @@ -2294,7 +2297,7 @@ number of active servers (backend), server is active (server) type: integer -number of backup servers (backend), server is backup (server) +Number of backend servers that are backup servers. [float] @@ -2310,7 +2313,7 @@ type: long format: bytes -number of HTTP response bytes fed to the compressor +Number of HTTP response bytes fed to the compressor. [float] @@ -2320,7 +2323,7 @@ type: integer format: bytes -number of HTTP response bytes emitted by the compressor +Number of HTTP response bytes emitted by the compressor. [float] @@ -2330,7 +2333,7 @@ type: long format: bytes -number of bytes that bypassed the HTTP compressor (CPU/BW limit) +Number of bytes that bypassed the HTTP compressor (CPU/BW limit). [float] @@ -2340,7 +2343,7 @@ type: long format: bytes -number of HTTP responses that were compressed +Number of HTTP responses that were compressed. [float] @@ -2354,7 +2357,7 @@ number of HTTP responses that were compressed type: integer -unique proxy id +Unique proxy ID. [float] @@ -2362,7 +2365,7 @@ unique proxy id type: keyword -proxy name +Proxy name. [float] @@ -2376,7 +2379,7 @@ proxy name type: integer -configured maxqueue for the server, or nothing in the value is 0 (default, meaning no limit) +Configured queue limit (maxqueue) for the server, or nothing if the value of maxqueue is 0 (meaning no limit). [float] @@ -2384,7 +2387,7 @@ configured maxqueue for the server, or nothing in the value is 0 (default, meani type: integer -the average queue time in ms over the 1024 last requests +The average queue time in ms over the last 1024 requests. [[exported-fields-kafka]] diff --git a/metricbeat/docs/how-metricbeat-works.asciidoc b/metricbeat/docs/how-metricbeat-works.asciidoc index ff16af4beb15..d52c30ccaf15 100644 --- a/metricbeat/docs/how-metricbeat-works.asciidoc +++ b/metricbeat/docs/how-metricbeat-works.asciidoc @@ -158,8 +158,6 @@ Elasticsearch, and it can optimize storage. Basic meta information about each metric (such as the host) is also sent as part of each event. -//QUESTION: I didn't mention the ability to provide additional information, like unit, because it sounds like that's no implemented, right? - [[multiple-events-in-one]] ==== Multiple Metrics in One Event diff --git a/metricbeat/docs/index.asciidoc b/metricbeat/docs/index.asciidoc index 49bd3d2f086b..73fd2bbcf164 100644 --- a/metricbeat/docs/index.asciidoc +++ b/metricbeat/docs/index.asciidoc @@ -13,41 +13,60 @@ include::../../libbeat/docs/version.asciidoc[] include::./overview.asciidoc[] +pass::[] include::./gettingstarted.asciidoc[] +pass::[] include::./command-line.asciidoc[] +pass::[] include::../../libbeat/docs/shared-directory-layout.asciidoc[] +pass::[] include::./upgrading.asciidoc[] +pass::[] include::./how-metricbeat-works.asciidoc[] +pass::[] include::./metricbeat-in-a-container.asciidoc[] +pass::[] include::./configuring-howto.asciidoc[] +pass::[] include::./metricbeat-filtering.asciidoc[] +pass::[] include::../../libbeat/docs/shared-config-ingest.asciidoc[] +pass::[] include::./configuring-logstash.asciidoc[] +pass::[] include::../../libbeat/docs/shared-env-vars.asciidoc[] :allplatforms: +pass::[] include::../../libbeat/docs/yaml.asciidoc[] +pass::[] include::../../libbeat/docs/regexp.asciidoc[] +pass::[] include::./modules.asciidoc[] +pass::[] include::./fields.asciidoc[] +pass::[] include::./securing-metricbeat.asciidoc[] +pass::[] include::./troubleshooting.asciidoc[] +pass::[] include::./faq.asciidoc[] +pass::[] include::./developer-guide/index.asciidoc[] diff --git a/metricbeat/docs/modules.asciidoc b/metricbeat/docs/modules.asciidoc index ea572984ff3a..a4c3e798f3b9 100644 --- a/metricbeat/docs/modules.asciidoc +++ b/metricbeat/docs/modules.asciidoc @@ -7,6 +7,8 @@ This section contains detailed information about the metric collecting modules contained in {beatname_uc}. Each module contains one or multiple metricsets. More details about each module can be found under the links below. +//pass macro block used here to remove Edit links from modules documentation because it is generated +pass::[] include::modules_list.asciidoc[] diff --git a/metricbeat/docs/modules/haproxy.asciidoc b/metricbeat/docs/modules/haproxy.asciidoc index 87add046406d..14fa204d3900 100644 --- a/metricbeat/docs/modules/haproxy.asciidoc +++ b/metricbeat/docs/modules/haproxy.asciidoc @@ -5,13 +5,15 @@ This file is generated! See scripts/docs_collector.py [[metricbeat-module-haproxy]] == HAProxy Module -This is the haproxy Module. To enable stats collection from HAProxy, you must enable the stats socket via TCP. -For example, placing the following statement under the `global` or `default` section of the haproxy config: +This module collects stats from http://www.haproxy.org/[HAProxy]. To configure +HAProxy to collect stats, you must enable the stats socket via TCP. For example, +to enable stats reporting via any local IP on port 14567, place this statement +under the `global` or `default` section of the haproxy config: `stats socket 127.0.0.1:14567` -will enable stats reporting via any local IP on port 14567. Please note that you should probably use an internal private IP -or secure this with a firewall rule so that only designated hosts can access this data. +NOTE: You should use an internal private IP, or secure this with a firewall +rule, so that only designated hosts can access this data. [float] === Compatibility @@ -22,7 +24,7 @@ The HAProxy metricsets were tested with HAProxy 1.6 and are expected to work wit [float] === Example Configuration -The haproxy module supports the standard configuration options that are described +The HAProxy module supports the standard configuration options that are described in <>. Here is an example configuration: [source,yaml] diff --git a/metricbeat/docs/modules_list.asciidoc b/metricbeat/docs/modules_list.asciidoc index 29e714950a18..74b85359d7c5 100644 --- a/metricbeat/docs/modules_list.asciidoc +++ b/metricbeat/docs/modules_list.asciidoc @@ -5,7 +5,7 @@ This file is generated! See scripts/docs_collector.py * <> * <> * <> - * <> + * <> * <> * <> * <> diff --git a/metricbeat/docs/reference/configuration.asciidoc b/metricbeat/docs/reference/configuration.asciidoc index 4e47584f9777..0f4c26fe90bc 100644 --- a/metricbeat/docs/reference/configuration.asciidoc +++ b/metricbeat/docs/reference/configuration.asciidoc @@ -21,4 +21,5 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> +pass::[] include::configuration/metricbeat-options.asciidoc[] diff --git a/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc b/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc index a44607d2fa6f..875e8e3824f2 100644 --- a/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc +++ b/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc @@ -66,13 +66,18 @@ deprecated[5.1,This option will be renamed and changed in a future release] A list of filters to apply to the data generated by the module. +pass::[] include::../../../../libbeat/docs/generalconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/outputconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/shared-path-config.asciidoc[] +pass::[] include::../../../../libbeat/docs/loggingconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/processors-config.asciidoc[] diff --git a/metricbeat/docs/securing-metricbeat.asciidoc b/metricbeat/docs/securing-metricbeat.asciidoc index f0de98065024..89f682b33b29 100644 --- a/metricbeat/docs/securing-metricbeat.asciidoc +++ b/metricbeat/docs/securing-metricbeat.asciidoc @@ -10,12 +10,18 @@ The following topics describe how to secure communication between * <> * <> +//sets block macro for https.asciidoc included in next section +pass::[] + -- [[securing-communication-elasticsearch]] == Securing Communication With Elasticsearch include::../../libbeat/docs/https.asciidoc[] +//sets block macro for shared-ssl-logstash-config.asciidoc included in next section +pass::[] + [[configuring-ssl-logstash]] == Securing Communication With Logstash by Using SSL include::../../libbeat/docs/shared-ssl-logstash-config.asciidoc[] diff --git a/metricbeat/docs/troubleshooting.asciidoc b/metricbeat/docs/troubleshooting.asciidoc index c8d694e62286..fb4c00e42fcb 100644 --- a/metricbeat/docs/troubleshooting.asciidoc +++ b/metricbeat/docs/troubleshooting.asciidoc @@ -9,6 +9,9 @@ If you have issues installing or running {beatname_uc}, read the following tips: * <> * <> +//sets block macro for getting-help.asciidoc included in next section +pass::[] + -- [[getting-help]] @@ -16,6 +19,9 @@ If you have issues installing or running {beatname_uc}, read the following tips: include::../../libbeat/docs/getting-help.asciidoc[] +//sets block macro for debugging.asciidoc included in next section +pass::[] + [[enable-metricbeat-debugging]] == Debugging diff --git a/metricbeat/metricbeat.full.yml b/metricbeat/metricbeat.full.yml index 3ee45a2779d4..a6c19bb3ebdb 100644 --- a/metricbeat/metricbeat.full.yml +++ b/metricbeat/metricbeat.full.yml @@ -95,7 +95,7 @@ metricbeat.modules: #certificate: "/etc/pki/client/cert.pem" #key: "/etc/pki/client/cert.key" -#------------------------------- haproxy Module ------------------------------ +#------------------------------- HAProxy Module ------------------------------ #- module: haproxy #metricsets: ["info", "stat"] #enabled: true diff --git a/metricbeat/module/haproxy/_meta/docs.asciidoc b/metricbeat/module/haproxy/_meta/docs.asciidoc index 780fd3920b6d..f6407ce40723 100644 --- a/metricbeat/module/haproxy/_meta/docs.asciidoc +++ b/metricbeat/module/haproxy/_meta/docs.asciidoc @@ -1,12 +1,14 @@ == HAProxy Module -This is the haproxy Module. To enable stats collection from HAProxy, you must enable the stats socket via TCP. -For example, placing the following statement under the `global` or `default` section of the haproxy config: +This module collects stats from http://www.haproxy.org/[HAProxy]. To configure +HAProxy to collect stats, you must enable the stats socket via TCP. For example, +to enable stats reporting via any local IP on port 14567, place this statement +under the `global` or `default` section of the haproxy config: `stats socket 127.0.0.1:14567` -will enable stats reporting via any local IP on port 14567. Please note that you should probably use an internal private IP -or secure this with a firewall rule so that only designated hosts can access this data. +NOTE: You should use an internal private IP, or secure this with a firewall +rule, so that only designated hosts can access this data. [float] === Compatibility diff --git a/metricbeat/module/haproxy/_meta/fields.yml b/metricbeat/module/haproxy/_meta/fields.yml index 2cd41422f569..fe6b56168085 100644 --- a/metricbeat/module/haproxy/_meta/fields.yml +++ b/metricbeat/module/haproxy/_meta/fields.yml @@ -1,13 +1,13 @@ - key: haproxy - title: "haproxy" + title: "HAProxy" description: > experimental[] - haproxy Module + HAProxy Module short_config: false fields: - name: haproxy type: group description: > - HAProx metrics. + HAProxy metrics. fields: diff --git a/metricbeat/module/haproxy/info/_meta/docs.asciidoc b/metricbeat/module/haproxy/info/_meta/docs.asciidoc index 1eb0c3c062b7..abb5442a0dde 100644 --- a/metricbeat/module/haproxy/info/_meta/docs.asciidoc +++ b/metricbeat/module/haproxy/info/_meta/docs.asciidoc @@ -1,3 +1,3 @@ -=== HAProxy info MetricSet +=== HAProxy Info Metricset -This is the info metricset of the haproxy module. +The HAProxy `info` metricset collects general information about HAProxy processes. diff --git a/metricbeat/module/haproxy/info/_meta/fields.yml b/metricbeat/module/haproxy/info/_meta/fields.yml index 6252c0cbc4f3..c8ff0ed331fd 100644 --- a/metricbeat/module/haproxy/info/_meta/fields.yml +++ b/metricbeat/module/haproxy/info/_meta/fields.yml @@ -1,22 +1,22 @@ - name: info type: group description: > - General infomration collected on HAProxy process + General information about HAProxy processes. fields: - name: processes type: long description: > - Number of processes + Number of processes. - name: process_num type: long description: > - Process number + Process number. - name: pid type: long description: > - Process ID + Process ID. - name: run_queue type: long @@ -29,18 +29,18 @@ - name: uptime.sec type: long description: > - Current uptime in seconds + Current uptime in seconds. - name: memory.max.bytes type: long format: bytes description: > - Max number of memory usage in bytes (The 'Memmax_MB' value converted to bytes) + Maximum amount of memory usage in bytes (the 'Memmax_MB' value converted to bytes). - name: ulimit_n type: long description: > - Max number of open files for process + Maximum number of open files for the process. - name: compress type: group @@ -89,32 +89,32 @@ - name: current type: long description: > - Current Connections + Current connections. - name: total type: long description: > - Total Connections + Total connections. - name: ssl.current type: long description: > - Current ssl Connections + Current SSL connections. - name: ssl.total type: long description: > - Current Connections + Total SSL connections. - name: ssl.max type: long description: > - Current Connections + Maximum SSL connections. - name: max type: long description: > - Max connections + Maximum connections. - name: hard_max type: long diff --git a/metricbeat/module/haproxy/stat/_meta/docs.asciidoc b/metricbeat/module/haproxy/stat/_meta/docs.asciidoc index c3c90f78d0f6..63e90104b3c4 100644 --- a/metricbeat/module/haproxy/stat/_meta/docs.asciidoc +++ b/metricbeat/module/haproxy/stat/_meta/docs.asciidoc @@ -1,133 +1,5 @@ -=== HAProxy stat MetricSet +=== HAProxy Stat Metricset -This is the stat metricset of the haproxy module. +The HAProxy `stat` metricset collects 'stat' fields from HAProxy processes. - -[float] -=== Official documentation for fields - -A list of the 'stat' fields along with a basic description can be found here: - -http://www.haproxy.org/download/1.6/doc/management.txt - -The following documentation bellow is an extract from the URL above, more specifically from section "9.1. CSV format" - -[source,log] ----- -In brackets after each field name are the types which may have a value for -that field. The types are L (Listeners), F (Frontends), B (Backends), and -S (Servers). - - 0. pxname [LFBS]: proxy name - 1. svname [LFBS]: service name (FRONTEND for frontend, BACKEND for backend, - any name for server/listener) - 2. qcur [..BS]: current queued requests. For the backend this reports the - number queued without a server assigned. - 3. qmax [..BS]: max value of qcur - 4. scur [LFBS]: current sessions - 5. smax [LFBS]: max sessions - 6. slim [LFBS]: configured session limit - 7. stot [LFBS]: cumulative number of connections - 8. bin [LFBS]: bytes in - 9. bout [LFBS]: bytes out - 10. dreq [LFB.]: requests denied because of security concerns. - - For tcp this is because of a matched tcp-request content rule. - - For http this is because of a matched http-request or tarpit rule. - 11. dresp [LFBS]: responses denied because of security concerns. - - For http this is because of a matched http-request rule, or - "option checkcache". - 12. ereq [LF..]: request errors. Some of the possible causes are: - - early termination from the client, before the request has been sent. - - read error from the client - - client timeout - - client closed connection - - various bad requests from the client. - - request was tarpitted. - 13. econ [..BS]: number of requests that encountered an error trying to - connect to a backend server. The backend stat is the sum of the stat - for all servers of that backend, plus any connection errors not - associated with a particular server (such as the backend having no - active servers). - 14. eresp [..BS]: response errors. srv_abrt will be counted here also. - Some other errors are: - - write error on the client socket (won't be counted for the server stat) - - failure applying filters to the response. - 15. wretr [..BS]: number of times a connection to a server was retried. - 16. wredis [..BS]: number of times a request was redispatched to another - server. The server value counts the number of times that server was - switched away from. - 17. status [LFBS]: status (UP/DOWN/NOLB/MAINT/MAINT(via)...) - 18. weight [..BS]: total weight (backend), server weight (server) - 19. act [..BS]: number of active servers (backend), server is active (server) - 20. bck [..BS]: number of backup servers (backend), server is backup (server) - 21. chkfail [...S]: number of failed checks. (Only counts checks failed when - the server is up.) - 22. chkdown [..BS]: number of UP->DOWN transitions. The backend counter counts - transitions to the whole backend being down, rather than the sum of the - counters for each server. - 23. lastchg [..BS]: number of seconds since the last UP<->DOWN transition - 24. downtime [..BS]: total downtime (in seconds). The value for the backend - is the downtime for the whole backend, not the sum of the server downtime. - 25. qlimit [...S]: configured maxqueue for the server, or nothing in the - value is 0 (default, meaning no limit) - 26. pid [LFBS]: process id (0 for first instance, 1 for second, ...) - 27. iid [LFBS]: unique proxy id - 28. sid [L..S]: server id (unique inside a proxy) - 29. throttle [...S]: current throttle percentage for the server, when - slowstart is active, or no value if not in slowstart. - 30. lbtot [..BS]: total number of times a server was selected, either for new - sessions, or when re-dispatching. The server counter is the number - of times that server was selected. - 31. tracked [...S]: id of proxy/server if tracking is enabled. - 32. type [LFBS]: (0=frontend, 1=backend, 2=server, 3=socket/listener) - 33. rate [.FBS]: number of sessions per second over last elapsed second - 34. rate_lim [.F..]: configured limit on new sessions per second - 35. rate_max [.FBS]: max number of new sessions per second - 36. check_status [...S]: status of last health check, one of: - UNK -> unknown - INI -> initializing - SOCKERR -> socket error - L4OK -> check passed on layer 4, no upper layers testing enabled - L4TOUT -> layer 1-4 timeout - L4CON -> layer 1-4 connection problem, for example - "Connection refused" (tcp rst) or "No route to host" (icmp) - L6OK -> check passed on layer 6 - L6TOUT -> layer 6 (SSL) timeout - L6RSP -> layer 6 invalid response - protocol error - L7OK -> check passed on layer 7 - L7OKC -> check conditionally passed on layer 7, for example 404 with - disable-on-404 - L7TOUT -> layer 7 (HTTP/SMTP) timeout - L7RSP -> layer 7 invalid response - protocol error - L7STS -> layer 7 response error, for example HTTP 5xx - 37. check_code [...S]: layer5-7 code, if available - 38. check_duration [...S]: time in ms took to finish last health check - 39. hrsp_1xx [.FBS]: http responses with 1xx code - 40. hrsp_2xx [.FBS]: http responses with 2xx code - 41. hrsp_3xx [.FBS]: http responses with 3xx code - 42. hrsp_4xx [.FBS]: http responses with 4xx code - 43. hrsp_5xx [.FBS]: http responses with 5xx code - 44. hrsp_other [.FBS]: http responses with other codes (protocol error) - 45. hanafail [...S]: failed health checks details - 46. req_rate [.F..]: HTTP requests per second over last elapsed second - 47. req_rate_max [.F..]: max number of HTTP requests per second observed - 48. req_tot [.F..]: total number of HTTP requests received - 49. cli_abrt [..BS]: number of data transfers aborted by the client - 50. srv_abrt [..BS]: number of data transfers aborted by the server - (inc. in eresp) - 51. comp_in [.FB.]: number of HTTP response bytes fed to the compressor - 52. comp_out [.FB.]: number of HTTP response bytes emitted by the compressor - 53. comp_byp [.FB.]: number of bytes that bypassed the HTTP compressor - (CPU/BW limit) - 54. comp_rsp [.FB.]: number of HTTP responses that were compressed - 55. lastsess [..BS]: number of seconds since last session assigned to - server/backend - 56. last_chk [...S]: last health check contents or textual error - 57. last_agt [...S]: last agent check contents or textual error - 58. qtime [..BS]: the average queue time in ms over the 1024 last requests - 59. ctime [..BS]: the average connect time in ms over the 1024 last requests - 60. rtime [..BS]: the average response time in ms over the 1024 last requests - (0 for TCP) - 61. ttime [..BS]: the average total session time in ms over the 1024 last - requests ----- +See section "9.1. CSV format" of the http://www.haproxy.org/download/1.6/doc/management.txt[official HAProxy Management Guide] for a full list of 'stat' fields. diff --git a/metricbeat/module/haproxy/stat/_meta/fields.yml b/metricbeat/module/haproxy/stat/_meta/fields.yml index 12beb8cb87c0..98b90c3ad03d 100644 --- a/metricbeat/module/haproxy/stat/_meta/fields.yml +++ b/metricbeat/module/haproxy/stat/_meta/fields.yml @@ -1,75 +1,75 @@ - name: stat type: group description: > - Stats collected from HAProxy process + Stats collected from HAProxy processes. fields: - name: status type: keyword description: > - status (UP/DOWN/NOLB/MAINT/MAINT(via)...) + Status (UP, DOWN, NOLB, MAINT, or MAINT(via)...). - name: weight type: long description: > - total weight (backend), server weight (server) + Total weight (for backends), or server weight (for servers). - name: downtime type: long description: > - total downtime (in seconds). The value for the backend - is the downtime for the whole backend, not the sum of the server downtime. + Total downtime (in seconds). For backends, this value is the downtime + for the whole backend, not the sum of the downtime for the servers. - name: component_type type: integer description: > - (0=frontend, 1=backend, 2=server, 3=socket/listener) + Component type (0=frontend, 1=backend, 2=server, or 3=socket/listener). - name: process_id type: integer description: > - process id (0 for first instance, 1 for second, ...) + Process ID (0 for first instance, 1 for second, and so on). - name: service_name type: keyword description: > - service name (FRONTEND for frontend, BACKEND for backend, any name for server/listener) + Service name (FRONTEND for frontend, BACKEND for backend, or any name for server/listener). - name: in.bytes type: long format: bytes description: > - bytes in + Bytes in. - name: out.bytes type: long format: bytes description: > - bytes out + Bytes out. - name: last_change type: integer description: > - number of seconds since the last UP<->DOWN transition + Number of seconds since the last UP->DOWN or DOWN->UP transition. - name: throttle.pct type: scaled_float format: percentage description: > - current throttle percentage for the server, when - slowstart is active, or no value if not in slowstart. + Current throttle percentage for the server when slowstart + is active, or no value if slowstart is inactive. - name: selected.total type: long description: > - total number of times a server was selected, either for new - sessions, or when re-dispatching. The server counter is the number - of times that server was selected. + Total number of times a server was selected, either for new + sessions, or when re-dispatching. For servers, this field reports the + the number of times the server was selected. - name: tracked.id type: long description: > - id of proxy/server if tracking is enabled. + ID of the proxy/server if tracking is enabled. - name: connection type: group @@ -78,17 +78,17 @@ - name: total type: long description: > - cumulative number of connections + Cumulative number of connections. - name: retried type: long description: > - number of times a connection to a server was retried. + Number of times a connection to a server was retried. - name: time.avg type: long description: > - the average connect time in ms over the 1024 last requests + Average connect time in ms over the last 1024 requests. - name: request type: group @@ -97,25 +97,28 @@ - name: denied type: long description: > - requests denied because of security concerns. - * For tcp this is because of a matched tcp-request content rule. - * For http this is because of a matched http-request or tarpit rule. + Requests denied because of security concerns. + + * For TCP this is because of a matched tcp-request content rule. + * For HTTP this is because of a matched http-request or tarpit rule. - name: queued.current type: long description: > - current queued requests. For the backend this reports the number queued without a server assigned + Current queued requests. For backends, this field reports the number + of requests queued without a server assigned. - name: queued.max type: long description: > - max value of queued.current + Maximum value of queued.current. - name: errors type: long description: > - request errors. Some of the possible causes are: - * early termination from the client, before the request has been sent. + Request errors. Some of the possible causes are: + + * early termination from the client, before the request has been sent * read error from the client * client timeout * client closed connection @@ -125,16 +128,16 @@ - name: redispatched type: long description: > - number of times a request was redispatched to another - server. The server value counts the number of times that server was + Number of times a request was redispatched to another server. For + servers, this field reports the number of times the server was switched away from. - name: connection.errors type: long description: > - number of requests that encountered an error trying to - connect to a backend server. The backend stat is the sum of the stat - for all servers of that backend, plus any connection errors not + Number of requests that encountered an error trying to + connect to a server. For backends, this field reports the sum of + the stat for all backend servers, plus any connection errors not associated with a particular server (such as the backend having no active servers). @@ -145,16 +148,16 @@ - name: value type: long description: > - HTTP requests per second over last elapsed second + Number of HTTP requests per second over the last elapsed second. - name: max type: long description: > - max number of HTTP requests per second observed + Maximum number of HTTP requests per second. - name: total type: long description: > - total number of HTTP requests received + Total number of HTTP requests received. - name: response @@ -164,22 +167,24 @@ - name: errors type: long description: > - response errors. srv_abrt will be counted here also. + Number of response errors. This value includes the number of data + transfers aborted by the server (haproxy.stat.server.aborted). Some other errors are: - * write error on the client socket (won't be counted for the server stat) - * failure applying filters to the respons + + * write errors on the client socket (won't be counted for the server stat) + * failure applying filters to the response - name: time.avg type: long description: > - the average response time in ms over the 1024 last requests (0 for TCP) + Average response time in ms over the last 1024 requests (0 for TCP). - name: denied type: integer description: > - responses denied because of security concerns. - * For http this is because of a matched http-request rule, or "option checkcache". + Responses denied because of security concerns. For HTTP this is + because of a matched http-request rule, or "option checkcache". - name: http type: group @@ -189,32 +194,32 @@ - name: 1xx type: long description: > - http responses with 1xx code + HTTP responses with 1xx code. - name: 2xx type: long description: > - http responses with 2xx code + HTTP responses with 2xx code. - name: 3xx type: long description: > - http responses with 3xx code + HTTP responses with 3xx code. - name: 4xx type: long description: > - http responses with 4xx code + HTTP responses with 4xx code. - name: 5xx type: long description: > - http responses with 5xx code + HTTP responses with 5xx code. - name: other type: long description: > - http responses with other codes (protocol error) + HTTP responses with other codes (protocol error). - name: session @@ -224,17 +229,17 @@ - name: current type: long description: > - current sessions + Number of current sessions. - name: max type: long description: > - max sessions + Maximum number of sessions. - name: limit type: long description: > - configured session limit + Configured session limit. - name: rate type: group @@ -242,17 +247,17 @@ - name: value type: integer description: > - number of sessions per second over last elapsed second + Number of sessions per second over the last elapsed second. - name: limit type: integer description: > - configured limit on new sessions per second + Configured limit on new sessions per second. - name: max type: integer description: > - max number of new sessions per second + Maximum number of new sessions per second. - name: check @@ -263,7 +268,8 @@ - name: status type: keyword description: > - status of last health check, one of: + Status of the last health check. One of: + UNK -> unknown INI -> initializing SOCKERR -> socket error @@ -284,12 +290,12 @@ - name: code type: long description: > - layer5-7 code, if available + Layer 5-7 code, if available. - name: duration type: long description: > - time in ms took to finish last health check + Time in ms that it took to finish the last health check. - name: health.last type: long @@ -306,20 +312,19 @@ - name: failed type: long description: > - number of failed checks. (Only counts checks failed when - the server is up.) + Number of checks that failed while the server was up. - name: down type: long description: > - number of UP->DOWN transitions. The backend counter counts - transitions to the whole backend being down, rather than the sum of the - counters for each server. + Number of UP->DOWN transitions. For backends, this value is the + number of transitions to the whole backend being down, rather than + the sum of the transitions for each server. - name: client.aborted type: integer description: > - number of data transfers aborted by the client + Number of data transfers aborted by the client. - name: server @@ -330,22 +335,24 @@ - name: id type: integer description: > - server id (unique inside a proxy) + Server ID (unique inside a proxy). - name: aborted type: integer description: > - number of data transfers aborted by the server (inc. in eresp) + Number of data transfers aborted by the server. This value is + included in haproxy.stat.response.errors. - name: active type: integer description: > - number of active servers (backend), server is active (server) + Number of backend servers that are active, meaning that they are + healthy and can receive requests from the load balancer. - name: backup type: integer description: > - number of backup servers (backend), server is backup (server) + Number of backend servers that are backup servers. - name: compressor @@ -357,25 +364,25 @@ type: long format: bytes description: > - number of HTTP response bytes fed to the compressor + Number of HTTP response bytes fed to the compressor. - name: out.bytes type: integer format: bytes description: > - number of HTTP response bytes emitted by the compressor + Number of HTTP response bytes emitted by the compressor. - name: bypassed.bytes type: long format: bytes description: > - number of bytes that bypassed the HTTP compressor (CPU/BW limit) + Number of bytes that bypassed the HTTP compressor (CPU/BW limit). - name: response.bytes type: long format: bytes description: > - number of HTTP responses that were compressed + Number of HTTP responses that were compressed. - name: proxy type: group @@ -385,12 +392,12 @@ - name: id type: integer description: > - unique proxy id + Unique proxy ID. - name: name type: keyword description: > - proxy name + Proxy name. - name: queue @@ -401,13 +408,13 @@ - name: limit type: integer description: > - configured maxqueue for the server, or nothing in the - value is 0 (default, meaning no limit) + Configured queue limit (maxqueue) for the server, or nothing if the + value of maxqueue is 0 (meaning no limit). - name: time.avg type: integer description: > - the average queue time in ms over the 1024 last requests + The average queue time in ms over the last 1024 requests. diff --git a/packetbeat/docs/configuring-howto.asciidoc b/packetbeat/docs/configuring-howto.asciidoc index 5029ec50ee9a..6958c9927757 100644 --- a/packetbeat/docs/configuring-howto.asciidoc +++ b/packetbeat/docs/configuring-howto.asciidoc @@ -27,5 +27,6 @@ The following topics describe how to configure Packetbeat: -- +pass::[] include::reference/configuration.asciidoc[] diff --git a/packetbeat/docs/index.asciidoc b/packetbeat/docs/index.asciidoc index 4bad0684efdd..97d76267b754 100644 --- a/packetbeat/docs/index.asciidoc +++ b/packetbeat/docs/index.asciidoc @@ -19,49 +19,71 @@ include::../../libbeat/docs/version.asciidoc[] include::./overview.asciidoc[] +pass::[] include::./gettingstarted.asciidoc[] + +pass::[] include::./command-line.asciidoc[] +pass::[] include::../../libbeat/docs/shared-directory-layout.asciidoc[] +pass::[] include::./upgrading.asciidoc[] +pass::[] include::./configuring-howto.asciidoc[] +pass::[] include::./packetbeat-filtering.asciidoc[] +pass::[] include::../../libbeat/docs/shared-config-ingest.asciidoc[] +pass::[] include::./packetbeat-geoip.asciidoc[] +pass::[] include::./configuring-logstash.asciidoc[] +pass::[] include::../../libbeat/docs/shared-env-vars.asciidoc[] +pass::[] include::./capturing.asciidoc[] +pass::[] include::./thrift.asciidoc[] +pass::[] include::./maintaining-topology.asciidoc[] :allplatforms: +pass::[] include::../../libbeat/docs/yaml.asciidoc[] +pass::[] include::./fields.asciidoc[] +pass::[] include::./securing-packetbeat.asciidoc[] +pass::[] include::./visualizing-data-packetbeat.asciidoc[] +pass::[] include::./filtering.asciidoc[] +pass::[] include::./troubleshooting.asciidoc[] +pass::[] include::./faq.asciidoc[] pass::[] +pass::[] include::./new_protocol.asciidoc[] pass::[] diff --git a/packetbeat/docs/reference/configuration.asciidoc b/packetbeat/docs/reference/configuration.asciidoc index 8abf934423c8..db2c97cadab6 100644 --- a/packetbeat/docs/reference/configuration.asciidoc +++ b/packetbeat/docs/reference/configuration.asciidoc @@ -28,6 +28,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes NOTE: Packetbeat maintains a real-time topology map of all the servers in your network. See <> for more details. +pass::[] include::configuration/packetbeat-options.asciidoc[] diff --git a/packetbeat/docs/reference/configuration/packetbeat-options.asciidoc b/packetbeat/docs/reference/configuration/packetbeat-options.asciidoc index 75bf10008e46..7f90c349b694 100644 --- a/packetbeat/docs/reference/configuration/packetbeat-options.asciidoc +++ b/packetbeat/docs/reference/configuration/packetbeat-options.asciidoc @@ -792,16 +792,22 @@ periodically afterwards, it scans the process table for processes that match the values specified for this option. The match is done against the process' command line as read from `/proc//cmdline`. +pass::[] include::../../../../libbeat/docs/generalconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/outputconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/shared-path-config.asciidoc[] +pass::[] include::../../../../libbeat/docs/loggingconfig.asciidoc[] +pass::[] include::./runconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/processors-config.asciidoc[] diff --git a/packetbeat/docs/securing-packetbeat.asciidoc b/packetbeat/docs/securing-packetbeat.asciidoc index c0da3e5a3503..4d047256443f 100644 --- a/packetbeat/docs/securing-packetbeat.asciidoc +++ b/packetbeat/docs/securing-packetbeat.asciidoc @@ -9,12 +9,18 @@ The following topics describe how to secure communication between Packetbeat and * <> * <> +//sets block macro for https.asciidoc included in next section +pass::[] + -- [[securing-communication-elasticsearch]] == Securing Communication With Elasticsearch include::../../libbeat/docs/https.asciidoc[] +//sets block macro for shared-ssl-logstash-config.asciidoc included in next section +pass::[] + [[configuring-ssl-logstash]] == Securing Communication With Logstash by Using SSL include::../../libbeat/docs/shared-ssl-logstash-config.asciidoc[] diff --git a/packetbeat/docs/troubleshooting.asciidoc b/packetbeat/docs/troubleshooting.asciidoc index 2dbb7cee97bb..fcad073f5f72 100644 --- a/packetbeat/docs/troubleshooting.asciidoc +++ b/packetbeat/docs/troubleshooting.asciidoc @@ -11,7 +11,8 @@ following tips: * <> * <> - +//sets block macro for getting-help.asciidoc included in next section +pass::[] -- @@ -20,11 +21,17 @@ following tips: include::../../libbeat/docs/getting-help.asciidoc[] +//sets block macro for debugging.asciidoc included in next section +pass::[] + [[enable-packetbeat-debugging]] == Debugging include::../../libbeat/docs/debugging.asciidoc[] +//sets block macro for recording-trace content included in next section +pass::[] + [[recording-trace]] == Recording a Trace diff --git a/winlogbeat/docs/configuring-howto.asciidoc b/winlogbeat/docs/configuring-howto.asciidoc index fb8dd4f0b915..b70694409dcd 100644 --- a/winlogbeat/docs/configuring-howto.asciidoc +++ b/winlogbeat/docs/configuring-howto.asciidoc @@ -21,5 +21,6 @@ The following topics describe how to configure Winlogbeat: -- +pass::[] include::reference/configuration.asciidoc[] diff --git a/winlogbeat/docs/index.asciidoc b/winlogbeat/docs/index.asciidoc index 19a3b6eb5d62..a477f378223a 100644 --- a/winlogbeat/docs/index.asciidoc +++ b/winlogbeat/docs/index.asciidoc @@ -16,29 +16,42 @@ include::../../libbeat/docs/version.asciidoc[] include::./overview.asciidoc[] +pass::[] include::./getting-started.asciidoc[] +pass::[] include::./command-line.asciidoc[] +pass::[] include::../../libbeat/docs/shared-directory-layout.asciidoc[] +pass::[] include::./upgrading.asciidoc[] +pass::[] include::./configuring-howto.asciidoc[] +pass::[] include::./winlogbeat-filtering.asciidoc[] +pass::[] include::../../libbeat/docs/shared-config-ingest.asciidoc[] +pass::[] include::../../libbeat/docs/shared-env-vars.asciidoc[] :win: +pass::[] include::../../libbeat/docs/yaml.asciidoc[] +pass::[] include::./fields.asciidoc[] +pass::[] include::./securing-winlogbeat.asciidoc[] +pass::[] include::./troubleshooting.asciidoc[] +pass::[] include::./faq.asciidoc[] diff --git a/winlogbeat/docs/reference/configuration.asciidoc b/winlogbeat/docs/reference/configuration.asciidoc index 8794d8ce7505..e100c0c92618 100644 --- a/winlogbeat/docs/reference/configuration.asciidoc +++ b/winlogbeat/docs/reference/configuration.asciidoc @@ -22,6 +22,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> +pass::[] include::configuration/winlogbeat-options.asciidoc[] diff --git a/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc b/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc index d680ea3dc89d..fbc7622e31fa 100644 --- a/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc +++ b/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc @@ -349,13 +349,18 @@ The metrics are served as a JSON document. The metrics include: - total number of successfully published events - uptime +pass::[] include::../../../../libbeat/docs/generalconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/outputconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/shared-path-config.asciidoc[] +pass::[] include::../../../../libbeat/docs/loggingconfig.asciidoc[] +pass::[] include::../../../../libbeat/docs/processors-config.asciidoc[] diff --git a/winlogbeat/docs/securing-winlogbeat.asciidoc b/winlogbeat/docs/securing-winlogbeat.asciidoc index df18577a0c18..60d382a72988 100644 --- a/winlogbeat/docs/securing-winlogbeat.asciidoc +++ b/winlogbeat/docs/securing-winlogbeat.asciidoc @@ -9,12 +9,18 @@ The following topics describe how to secure communication between Winlogbeat and * <> * <> +//sets block macro for https.asciidoc included in next section +pass::[] + -- [[securing-communication-elasticsearch]] == Securing Communication With Elasticsearch include::../../libbeat/docs/https.asciidoc[] +//sets block macro for shared-ssl-logstash-config.asciidoc included in next section +pass::[] + [[configuring-ssl-logstash]] == Securing Communication With Logstash by Using SSL include::../../libbeat/docs/shared-ssl-logstash-config.asciidoc[] diff --git a/winlogbeat/docs/troubleshooting.asciidoc b/winlogbeat/docs/troubleshooting.asciidoc index cf3807f0c793..b972f9a0aee8 100644 --- a/winlogbeat/docs/troubleshooting.asciidoc +++ b/winlogbeat/docs/troubleshooting.asciidoc @@ -9,6 +9,9 @@ If you have issues installing or running Winlogbeat, read the following tips: * <> * <> +//sets block macro for getting-help.asciidoc included in next section +pass::[] + -- [[getting-help]] @@ -16,6 +19,9 @@ If you have issues installing or running Winlogbeat, read the following tips: include::../../libbeat/docs/getting-help.asciidoc[] +//sets block macro for debugging.asciidoc included in next section +pass::[] + [[enable-winlogbeat-debugging]] == Debugging