Skip to content

Commit

Permalink
[8.12](backport #4147) Add tags to fix chunking in obs guide (#4152)
Browse files Browse the repository at this point in the history
* Add tags to fix chunking in obs guide (#4147)

* Fix chunking

* update some leveloffsets

---------

Co-authored-by: Colleen McGinnis <[email protected]>
(cherry picked from commit 048c755)

# Conflicts:
#	docs/en/observability/apm-ui/api.asciidoc
#	docs/en/observability/apm/configure/outputs/elasticsearch.asciidoc
#	docs/en/observability/apm/configure/outputs/kafka.asciidoc
#	docs/en/observability/apm/configure/outputs/logstash.asciidoc
#	docs/en/observability/apm/configure/outputs/redis.asciidoc
#	docs/en/observability/apm/sampling.asciidoc

* Resolve conflicts

* 2nd pass

---------

Co-authored-by: DeDe Morton <[email protected]>
  • Loading branch information
mergify[bot] and dedemorton authored Aug 14, 2024
1 parent f1e14ba commit c2371c5
Show file tree
Hide file tree
Showing 7 changed files with 115 additions and 7 deletions.
6 changes: 6 additions & 0 deletions docs/en/observability/apm/configure/outputs/console.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,32 @@ ifdef::apm-server[]
include::../../shared-kibana-endpoint.asciidoc[tag=shared-kibana-config]
endif::[]

[float]
=== Configuration options

You can specify the following `output.console` options in the +{beatname_lc}.yml+ config file:

[float]
==== `enabled`

The enabled config is a boolean setting to enable or disable the output. If set
to false, the output is disabled.

The default value is `true`.

[float]
==== `pretty`

If `pretty` is set to true, events written to stdout will be nicely formatted. The default is false.

[float]
==== `codec`

Output codec configuration. If the `codec` section is missing, events will be JSON encoded using the `pretty` option.

See <<configuration-output-codec>> for more information.

[float]
==== `bulk_max_size`

The maximum number of events to buffer internally during publishing. The default is 2048.
Expand All @@ -65,4 +70,5 @@ Setting `bulk_max_size` to values less than or equal to 0 disables the
splitting of batches. When splitting is disabled, the queue decides on the
number of events to be contained in a batch.

[float]
include::codec.asciidoc[leveloffset=+1]
29 changes: 26 additions & 3 deletions docs/en/observability/apm/configure/outputs/elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,24 +61,27 @@ output.elasticsearch:

See <<securing-communication-elasticsearch>> for details on each authentication method.

[float]
=== Compatibility

This output works with all compatible versions of {es}. See the
https://www.elastic.co/support/matrix#matrix_compatibility[Elastic Support
Matrix].

[float]
=== Configuration options

You can specify the following options in the `elasticsearch` section of the +{beatname_lc}.yml+ config file:

[float]
==== `enabled`

The enabled config is a boolean setting to enable or disable the output. If set
to `false`, the output is disabled.

The default value is `true`.


[float]
[[hosts-option]]
==== `hosts`

Expand All @@ -102,6 +105,7 @@ output.elasticsearch:
In the previous example, the {es} nodes are available at `https://10.45.3.2:9220/elasticsearch` and
`https://10.45.3.1:9230/elasticsearch`.

[float]
==== `compression_level`

The gzip compression level. Setting this value to `0` disables compression.
Expand All @@ -111,34 +115,40 @@ Increasing the compression level will reduce the network usage but will increase

The default value is `0`.

[float]
==== `escape_html`

Configure escaping of HTML in strings. Set to `true` to enable escaping.

The default value is `false`.

[float]
==== `api_key`

Instead of using a username and password, you can use API keys to secure communication
with {es}. The value must be the ID of the API key and the API key joined by a colon: `id:api_key`.

See <<beats-api-keys>> for more information.

[float]
==== `username`

The basic authentication username for connecting to {es}.

This user needs the privileges required to publish events to {es}.
To create a user like this, see <<privileges-to-publish-events>>.

[float]
==== `password`

The basic authentication password for connecting to {es}.

[float]
==== `parameters`

Dictionary of HTTP parameters to pass within the URL with index operations.

[float]
[[protocol-option]]
==== `protocol`

Expand All @@ -147,13 +157,15 @@ The name of the protocol {es} is reachable on. The options are:
<<hosts-option,`hosts`>>, the value of `protocol` is overridden by whatever scheme you
specify in the URL.

[float]
[[path-option]]
==== `path`

An HTTP path prefix that is prepended to the HTTP API calls. This is useful for
the cases where {es} listens behind an HTTP reverse proxy that exports
the API under a custom prefix.

[float]
==== `headers`

Custom HTTP headers to add to each request created by the {es} output.
Expand All @@ -168,6 +180,7 @@ output.elasticsearch.headers:
It is possible to specify multiple header values for the same header
name by separating them with a comma.

[float]
==== `proxy_url`

The URL of the proxy to use when connecting to the {es} servers. The
Expand Down Expand Up @@ -303,6 +316,7 @@ values. You cannot specify format strings within the mapping pairs.
endif::apm-server[]

ifndef::no_ilm[]
[float]
[[ilm-es]]
==== `ilm`

Expand All @@ -312,6 +326,7 @@ See <<ilm>> for more information.
endif::no_ilm[]

ifndef::no-pipeline[]
[float]
[[pipeline-option-es]]
==== `pipeline`

Expand Down Expand Up @@ -347,6 +362,7 @@ TIP: To learn how to add custom fields to events, see the
See the <<pipelines-option-es,`pipelines`>> setting for other ways to set the
ingest node pipeline dynamically.

[float]
[[pipelines-option-es]]
==== `pipelines`

Expand Down Expand Up @@ -418,6 +434,7 @@ For more information about ingest node pipelines, see

endif::[]

[float]
==== `max_retries`

ifdef::ignores_max_retries[]
Expand All @@ -433,16 +450,19 @@ Set `max_retries` to a value less than 0 to retry until all events are published
The default is 3.
endif::[]

[float]
==== `flush_bytes`

The bulk request size threshold, in bytes, before flushing to {es}.
The value must have a suffix, e.g. `"2MB"`. The default is `1MB`.

[float]
==== `flush_interval`

The maximum duration to accumulate events for a bulk request before being flushed to {es}.
The value must have a duration suffix, e.g. `"5s"`. The default is `1s`.

[float]
==== `backoff.init`

The number of seconds to wait before trying to reconnect to {es} after
Expand All @@ -451,16 +471,18 @@ reconnect. If the attempt fails, the backoff timer is increased exponentially up
to `backoff.max`. After a successful connection, the backoff timer is reset. The
default is `1s`.


[float]
==== `backoff.max`

The maximum number of seconds to wait before attempting to connect to
{es} after a network error. The default is `60s`.

[float]
==== `timeout`

The HTTP request timeout in seconds for the {es} request. The default is 90.

[float]
==== `ssl`

Configuration options for SSL parameters like the certificate authority to use
Expand All @@ -471,4 +493,5 @@ See the <<securing-communication-elasticsearch,secure communication with {es}>>
or <<configuration-ssl,SSL configuration reference>> for more information.

// Elasticsearch security
include::{apm-server-dir}/https.asciidoc[]
[float]
include::{apm-server-dir}/https.asciidoc[leveloffset=+1]
Loading

0 comments on commit c2371c5

Please sign in to comment.