Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelog/fragments/1774377466-fix-typos-docs-ingest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
kind: bug-fix
summary: Fix grammar errors in user-facing reference docs (dashboard agreement, pipelines spelling, settings agreement, configuring usage)
component: all
2 changes: 1 addition & 1 deletion docs/reference/auditbeat/configuration-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ When dashboard loading is enabled, Auditbeat overwrites any existing dashboards
::::


If no other options are set, the dashboard are loaded from the local `kibana` directory in the home path of the Auditbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option).
If no other options are set, the dashboards are loaded from the local `kibana` directory in the home path of the Auditbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option).


### `setup.dashboards.directory` [directory-option]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/auditbeat/syslog.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t

## Metrics [_metrics]

Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/auditbeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint.
Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/auditbeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint.

For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/filebeat/configuration-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ When dashboard loading is enabled, Filebeat overwrites any existing dashboards t
::::


If no other options are set, the dashboard are loaded from the local `kibana` directory in the home path of the Filebeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option).
If no other options are set, the dashboards are loaded from the local `kibana` directory in the home path of the Filebeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option).


### `setup.dashboards.directory` [directory-option]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/filebeat/filebeat-input-winlog.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ If this option is specified, the input filters events that are older than the sp
A boolean flag to indicate that the log contains only events collected from remote hosts using the Windows Event Collector. The value defaults to true for the ForwardedEvents log and false for any other log. **{This option is only available on operating systems +
supporting the Windows Event Log API (Microsoft Windows Vista and newer).}**

This settings allows Filebeat to optimize reads for forwarded events that are already rendered. When the value is true Filebeat does not attempt to render the event using message files from the host computer. The Windows Event Collector subscription should be configured to use the "RenderedText" format (this is the default) to ensure that the events are distributed with messages and descriptions.
This setting allows Filebeat to optimize reads for forwarded events that are already rendered. When the value is true Filebeat does not attempt to render the event using message files from the host computer. The Windows Event Collector subscription should be configured to use the "RenderedText" format (this is the default) to ensure that the events are distributed with messages and descriptions.


### `event_id` [_event_id]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/filebeat/syslog.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t

## Metrics [_metrics_19]

Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/filebeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint.
Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/filebeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint.

For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/heartbeat/syslog.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t

## Metrics [_metrics]

Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/heartbeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint.
Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/heartbeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint.

For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/metricbeat/configuration-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ When dashboard loading is enabled, Metricbeat overwrites any existing dashboards
::::


If no other options are set, the dashboard are loaded from the local `kibana` directory in the home path of the Metricbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option).
If no other options are set, the dashboards are loaded from the local `kibana` directory in the home path of the Metricbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option).


### `setup.dashboards.directory` [directory-option]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/metricbeat/syslog.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t

## Metrics [_metrics]

Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/metricbeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint.
Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/metricbeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint.

For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/packetbeat/configuration-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ When dashboard loading is enabled, Packetbeat overwrites any existing dashboards
::::


If no other options are set, the dashboard are loaded from the local `kibana` directory in the home path of the Packetbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option).
If no other options are set, the dashboards are loaded from the local `kibana` directory in the home path of the Packetbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option).


### `setup.dashboards.directory` [directory-option]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/packetbeat/syslog.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t

## Metrics [_metrics]

Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/packetbeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint.
Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/packetbeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint.

For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`:

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/winlogbeat/command-line-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ $$$ilm-policy-subcommand$$$
$$$pipeline-subcommand$$$

**`pipeline`**
: Exports the ingest piplines. You must specify the `--es.version` to specify which version of {{es}} the pipelines should be compatible with. You can optionally specify `--dir` to control where the pipelines are written.
: Exports the ingest pipelines. You must specify the `--es.version` to specify which version of {{es}} the pipelines should be compatible with. You can optionally specify `--dir` to control where the pipelines are written.

**FLAGS**

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/winlogbeat/configuration-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ When dashboard loading is enabled, Winlogbeat overwrites any existing dashboards
::::


If no other options are set, the dashboard are loaded from the local `kibana` directory in the home path of the Winlogbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option).
If no other options are set, the dashboards are loaded from the local `kibana` directory in the home path of the Winlogbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option).


### `setup.dashboards.directory` [directory-option]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ winlogbeat.event_logs:

A boolean flag to indicate that the log contains only events collected from remote hosts using the Windows Event Collector. The value defaults to true for the ForwardedEvents log and false for any other log. **This option is only available on operating systems supporting the Windows Event Log API (Microsoft Windows Vista and newer).**

This settings allows Winlogbeat to optimize reads for forwarded events that are already rendered. When the value is true Winlogbeat does not attempt to render the event using message files from the host computer. The Windows Event Collector subscription should be configured to use the "RenderedText" format (this is the default) to ensure that the events are distributed with messages and descriptions.
This setting allows Winlogbeat to optimize reads for forwarded events that are already rendered. When the value is true Winlogbeat does not attempt to render the event using message files from the host computer. The Windows Event Collector subscription should be configured to use the "RenderedText" format (this is the default) to ensure that the events are distributed with messages and descriptions.


### `event_logs.event_id` [_event_logs_event_id]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/winlogbeat/syslog.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t

## Metrics [_metrics]

Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/winlogbeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint.
Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/winlogbeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint.

For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`:

Expand Down
Loading