Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 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
2 changes: 1 addition & 1 deletion deploy-manage/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This section focuses on deploying and managing {{es}} and {{kib}}, as well as su
To learn how to deploy optional {{stack}} components, refer to the following sections:
* [Fleet and Elastic Agent](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/index.md)
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
* [Beats](asciidocalypse://docs/beats/docs/reference/index.md)
* [Beats](beats://reference/index.md)
* [Logstash](asciidocalypse://docs/logstash/docs/reference/index.md)
:::

Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/_snippets/installation-order.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ If you're deploying the {{stack}} in a self-managed cluster, then install the {{
* {{es}}
* {{kib}}
* [Logstash](logstash://reference/index.md)
* [{{agent}}](/reference/ingestion-tools/fleet/index.md) or [Beats](asciidocalypse://docs/beats/docs/reference/index.md)
* [{{agent}}](/reference/ingestion-tools/fleet/index.md) or [Beats](beats://reference/index.md)
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
* [Elasticsearch Hadoop](elasticsearch-hadoop://reference/index.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,24 +86,24 @@ To use the Cloud ID, you need:
* A user ID and password that has permission to send data to your {{es}} cluster.

::::{important}
In our examples, we use the `elastic` superuser that every {{es}} cluster comes with. The password for the `elastic` user is provided when you create a deployment (and can also be [reset](../../users-roles/cluster-or-deployment-auth/built-in-users.md) if you forget it). On a production system, you should adapt these examples by creating a user that can write to and access only the minimally required indices. For each Beat, review the specific feature and role table, similar to the one in [Metricbeat](asciidocalypse://docs/beats/docs/reference/metricbeat/feature-roles.md) documentation.
In our examples, we use the `elastic` superuser that every {{es}} cluster comes with. The password for the `elastic` user is provided when you create a deployment (and can also be [reset](../../users-roles/cluster-or-deployment-auth/built-in-users.md) if you forget it). On a production system, you should adapt these examples by creating a user that can write to and access only the minimally required indices. For each Beat, review the specific feature and role table, similar to the one in [Metricbeat](beats://reference/metricbeat/feature-roles.md) documentation.
::::

### Example: Configure Beats with your Cloud ID [ece-cloud-id-beats]

The following example shows how you can send operational data from Metricbeat to a new ECE deployment by using the Cloud ID. While this example uses Metricbeat, the same approach applies to other Beats.

::::{tip}
For others, you can learn more about [getting started](asciidocalypse://docs/beats/docs/reference/index.md) with each Beat.
For others, you can learn more about [getting started](beats://reference/index.md) with each Beat.
::::

To get started with Metricbeat and {{ece}}:

1. [Log into the Cloud UI](log-into-cloud-ui.md).
2. [Create a new deployment](create-deployment.md) and copy down the password for the `elastic` user.
3. On the deployment overview page, copy down the Cloud ID.
4. Set up the Beat of your choice, such as [Metricbeat](asciidocalypse://docs/beats/docs/reference/metricbeat/metricbeat-installation-configuration.md).
5. [Configure the Beat output to send to Elastic Cloud](asciidocalypse://docs/beats/docs/reference/metricbeat/configure-cloud-id.md).
4. Set up the Beat of your choice, such as [Metricbeat](beats://reference/metricbeat/metricbeat-installation-configuration.md).
5. [Configure the Beat output to send to Elastic Cloud](beats://reference/metricbeat/configure-cloud-id.md).

::::{note}
Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information.
Expand Down
6 changes: 3 additions & 3 deletions deploy-manage/deploy/cloud-on-k8s/configuration-beats.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ stringData:
hosts: ["quickstart-es-http.default.svc:9200"]
```

For more details, check the [Beats configuration](asciidocalypse://docs/beats/docs/reference/libbeat/config-file-format.md) section.
For more details, check the [Beats configuration](beats://reference/libbeat/config-file-format.md) section.


## Customize the connection to an Elasticsearch cluster [k8s-beat-connect-es]
Expand Down Expand Up @@ -154,7 +154,7 @@ stringData:
AGENT_NAME_VAR: id_007
```

Check [Beats documentation](asciidocalypse://docs/beats/docs/reference/filebeat/keystore.md) for more details.
Check [Beats documentation](beats://reference/filebeat/keystore.md) for more details.


## Set Beat output [k8s-beat-set-beat-output]
Expand Down Expand Up @@ -204,7 +204,7 @@ Consider picking the `Recreate` strategy if you are using a `hostPath` volume as

## Role Based Access Control for Beats [k8s-beat-role-based-access-control-for-beats]

Some Beats features (such as [autodiscover](asciidocalypse://docs/beats/docs/reference/filebeat/configuration-autodiscover.md) or Kubernetes module [metricsets](asciidocalypse://docs/beats/docs/reference/metricbeat/metricbeat-metricset-kubernetes-apiserver.md)) require that Beat Pods interact with Kubernetes APIs. Specific permissions are needed to allow this functionality. Standard Kubernetes [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) rules apply. For example, to allow for autodiscover:
Some Beats features (such as [autodiscover](beats://reference/filebeat/configuration-autodiscover.md) or Kubernetes module [metricsets](beats://reference/metricbeat/metricbeat-metricset-kubernetes-apiserver.md)) require that Beat Pods interact with Kubernetes APIs. Specific permissions are needed to allow this functionality. Standard Kubernetes [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) rules apply. For example, to allow for autodiscover:

```yaml
apiVersion: beat.k8s.elastic.co/v1beta1
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/cloud-on-k8s/logstash-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ stringData:

### Elastic Agent input and Beats input plugins [k8s-logstash-plugin-considerations-agent-beats]

When you use the [Elastic Agent input](logstash://reference/plugins-inputs-elastic_agent.md) or the [Beats input](logstash://reference/plugins-inputs-beats.md), set the [`ttl`](asciidocalypse://docs/beats/docs/reference/filebeat/logstash-output.md#_ttl) value on the Agent or Beat to ensure that load is distributed appropriately.
When you use the [Elastic Agent input](logstash://reference/plugins-inputs-elastic_agent.md) or the [Beats input](logstash://reference/plugins-inputs-beats.md), set the [`ttl`](beats://reference/filebeat/logstash-output.md#_ttl) value on the Agent or Beat to ensure that load is distributed appropriately.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When `kibanaRef` is specified, Beat tries to connect to the Kibana instance. If

## Configuration containing key: null is malformed [k8s-beat-configuration-containing-key-null-is-malformed]

When `kubectl` is used to modify a resource, it calculates the diff between the user applied and the existing configuration. This diff has special [semantics](https://tools.ietf.org/html/rfc7396#section-1) that forces the removal of keys if they have special values. For example, if the user-applied configuration contains `some_key: null` (or equivalent `some_key: ~`), this is interpreted as an instruction to remove `some_key`. In Beats configurations, this is often a problem when it comes to defining things like [processors](asciidocalypse://docs/beats/docs/reference/filebeat/add-cloud-metadata.md). To avoid this problem:
When `kubectl` is used to modify a resource, it calculates the diff between the user applied and the existing configuration. This diff has special [semantics](https://tools.ietf.org/html/rfc7396#section-1) that forces the removal of keys if they have special values. For example, if the user-applied configuration contains `some_key: null` (or equivalent `some_key: ~`), this is interpreted as an instruction to remove `some_key`. In Beats configurations, this is often a problem when it comes to defining things like [processors](beats://reference/filebeat/add-cloud-metadata.md). To avoid this problem:

* Use `some_key: {}` (empty map) or `some_key: []` (empty array) instead of `some_key: null` if doing so does not affect the behaviour. This might not be possible in all cases as some applications distinguish between null values and empty values and behave differently.
* Instead of using `config` to define configuration inline, use `configRef` and store the configuration in a Secret.
Expand Down
8 changes: 4 additions & 4 deletions deploy-manage/deploy/elastic-cloud/find-cloud-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To use the Cloud ID, you need:
* The unique Cloud ID for your deployment, available from the deployment overview page.
* A user ID and password that has permission to send data to your cluster.

In our examples, we use the `elastic` superuser that every Elasticsearch cluster comes with. The password for the `elastic` user is provided when you create a deployment (and can also be [reset](../../users-roles/cluster-or-deployment-auth/built-in-users.md) if you forget it). On a production system, you should adapt these examples by creating a user that can write to and access only the minimally required indices. For each Beat, review the specific feature and role table, similar to the one in [Metricbeat](asciidocalypse://docs/beats/docs/reference/metricbeat/feature-roles.md) documentation.
In our examples, we use the `elastic` superuser that every Elasticsearch cluster comes with. The password for the `elastic` user is provided when you create a deployment (and can also be [reset](../../users-roles/cluster-or-deployment-auth/built-in-users.md) if you forget it). On a production system, you should adapt these examples by creating a user that can write to and access only the minimally required indices. For each Beat, review the specific feature and role table, similar to the one in [Metricbeat](beats://reference/metricbeat/feature-roles.md) documentation.



Expand All @@ -51,7 +51,7 @@ To use the Cloud ID, you need:
The following example shows how you can send operational data from Metricbeat to {{ecloud}} by using the Cloud ID. Any of the available Beats will work, but we had to pick one for this example.

::::{tip}
For others, you can learn more about [getting started](asciidocalypse://docs/beats/docs/reference/index.md) with each Beat.
For others, you can learn more about [getting started](beats://reference/index.md) with each Beat.
::::


Expand All @@ -60,8 +60,8 @@ To get started with Metricbeat and {{ecloud}}:
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
2. [Create a new deployment](create-an-elastic-cloud-hosted-deployment.md) and copy down the password for the `elastic` user.
3. On the deployment overview page, copy down the Cloud ID.
4. Set up the Beat of your choice, such as [Metricbeat version 7.17](asciidocalypse://docs/beats/docs/reference/metricbeat/metricbeat-installation-configuration.md).
5. [Configure the Beat output to send to Elastic Cloud](asciidocalypse://docs/beats/docs/reference/metricbeat/configure-cloud-id.md).
4. Set up the Beat of your choice, such as [Metricbeat version 7.17](beats://reference/metricbeat/metricbeat-installation-configuration.md).
5. [Configure the Beat output to send to Elastic Cloud](beats://reference/metricbeat/configure-cloud-id.md).

::::{note}
Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information.
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/self-managed/air-gapped-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Specifically:

## {{beats}} [air-gapped-beats]

Elastic {{beats}} are light-weight data shippers. They do not require any special configuration in air-gapped environments. To learn more, refer to the [{{beats}} documentation](asciidocalypse://docs/beats/docs/reference/index.md).
Elastic {{beats}} are light-weight data shippers. They do not require any special configuration in air-gapped environments. To learn more, refer to the [{{beats}} documentation](beats://reference/index.md).


## {{ls}} [air-gapped-logstash]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ applies_to:

# Configuring indices created by Metricbeat 7 or internal collection [config-monitoring-indices-metricbeat-7-internal-collection]

When monitoring [using {{metricbeat}} 7](../stack-monitoring/collecting-monitoring-data-with-metricbeat.md) or [internal collection](asciidocalypse://docs/beats/docs/reference/filebeat/monitoring-internal-collection.md), data is stored in a set of indices called either:
When monitoring [using {{metricbeat}} 7](../stack-monitoring/collecting-monitoring-data-with-metricbeat.md) or [internal collection](beats://reference/filebeat/monitoring-internal-collection.md), data is stored in a set of indices called either:

* `.monitoring-{{product}}-7-mb-{{date}}`, when using {{metricbeat}} 7.
* `.monitoring-{{product}}-7-{{date}}`, when using internal collection.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ If you’re using {{agent}}, do not deploy {{filebeat}} for log collection. Inst
If there are both structured (`*.json`) and unstructured (plain text) versions of the logs, you must use the structured logs. Otherwise, they might not appear in the appropriate context in {{kib}}.
::::

3. [Install {{filebeat}}](asciidocalypse://docs/beats/docs/reference/filebeat/filebeat-installation-configuration.md) on the {{es}} nodes that contain logs that you want to monitor.
3. [Install {{filebeat}}](beats://reference/filebeat/filebeat-installation-configuration.md) on the {{es}} nodes that contain logs that you want to monitor.
4. Identify where to send the log data.

For example, specify {{es}} output information for your monitoring cluster in the {{filebeat}} configuration file (`filebeat.yml`):
Expand Down Expand Up @@ -61,7 +61,7 @@ If you’re using {{agent}}, do not deploy {{filebeat}} for log collection. Inst

If {{es}} {{security-features}} are enabled on the monitoring cluster, you must provide a valid user ID and password so that {{filebeat}} can send metrics successfully.

For more information about these configuration options, see [Configure the {{es}} output](asciidocalypse://docs/beats/docs/reference/filebeat/elasticsearch-output.md).
For more information about these configuration options, see [Configure the {{es}} output](beats://reference/filebeat/elasticsearch-output.md).

5. Optional: Identify where to visualize the data.

Expand All @@ -82,9 +82,9 @@ If you’re using {{agent}}, do not deploy {{filebeat}} for log collection. Inst
If {{security-features}} are enabled, you must provide a valid user ID and password so that {{filebeat}} can connect to {{kib}}:

1. Create a user on the monitoring cluster that has the [`kibana_admin` built-in role](../../users-roles/cluster-or-deployment-auth/built-in-roles.md) or equivalent privileges.
2. Add the `username` and `password` settings to the {{es}} output information in the {{filebeat}} configuration file. The example shows a hard-coded password, but you should store sensitive values in the [secrets keystore](asciidocalypse://docs/beats/docs/reference/filebeat/keystore.md).
2. Add the `username` and `password` settings to the {{es}} output information in the {{filebeat}} configuration file. The example shows a hard-coded password, but you should store sensitive values in the [secrets keystore](beats://reference/filebeat/keystore.md).

See [Configure the {{kib}} endpoint](asciidocalypse://docs/beats/docs/reference/filebeat/setup-kibana-endpoint.md).
See [Configure the {{kib}} endpoint](beats://reference/filebeat/setup-kibana-endpoint.md).

6. Enable the {{es}} module and set up the initial {{filebeat}} environment on each node.

Expand All @@ -95,20 +95,20 @@ If you’re using {{agent}}, do not deploy {{filebeat}} for log collection. Inst
filebeat setup -e
```

For more information, see [{{es}} module](asciidocalypse://docs/beats/docs/reference/filebeat/filebeat-module-elasticsearch.md).
For more information, see [{{es}} module](beats://reference/filebeat/filebeat-module-elasticsearch.md).

7. Configure the {{es}} module in {{filebeat}} on each node.

If the logs that you want to monitor aren’t in the default location, set the appropriate path variables in the `modules.d/elasticsearch.yml` file. See [Configure the {{es}} module](asciidocalypse://docs/beats/docs/reference/filebeat/filebeat-module-elasticsearch.md#configuring-elasticsearch-module).
If the logs that you want to monitor aren’t in the default location, set the appropriate path variables in the `modules.d/elasticsearch.yml` file. See [Configure the {{es}} module](beats://reference/filebeat/filebeat-module-elasticsearch.md#configuring-elasticsearch-module).

::::{important}
If there are JSON logs, configure the `var.paths` settings to point to them instead of the plain text logs.
::::

8. [Start {{filebeat}}](asciidocalypse://docs/beats/docs/reference/filebeat/filebeat-starting.md) on each node.
8. [Start {{filebeat}}](beats://reference/filebeat/filebeat-starting.md) on each node.

::::{note}
Depending on how you’ve installed {{filebeat}}, you might see errors related to file ownership or permissions when you try to run {{filebeat}} modules. See [Config file ownership and permissions](asciidocalypse://docs/beats/docs/reference/libbeat/config-file-permissions.md).
Depending on how you’ve installed {{filebeat}}, you might see errors related to file ownership or permissions when you try to run {{filebeat}} modules. See [Config file ownership and permissions](beats://reference/libbeat/config-file-permissions.md).
::::

9. Check whether the appropriate indices exist on the monitoring cluster.
Expand Down
Loading
Loading