Skip to content

Commit 1a78c05

Browse files
Updates links pointing to beats (#819)
## Description Related to #673 This PR updates the links that point to the `beats` repo from `asciidocalypse://docs/beats/docs/reference/` to `beats://reference/`. --------- Co-authored-by: Colleen McGinnis <[email protected]>
1 parent d29206f commit 1a78c05

File tree

79 files changed

+305
-305
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+305
-305
lines changed

deploy-manage/deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This section focuses on deploying and managing {{es}} and {{kib}}, as well as su
2525
To learn how to deploy optional {{stack}} components, refer to the following sections:
2626
* [Fleet and Elastic Agent](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/index.md)
2727
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
28-
* [Beats](asciidocalypse://docs/beats/docs/reference/index.md)
28+
* [Beats](beats://reference/index.md)
2929
* [Logstash](asciidocalypse://docs/logstash/docs/reference/index.md)
3030
:::
3131

deploy-manage/deploy/_snippets/installation-order.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ If you're deploying the {{stack}} in a self-managed cluster, then install the {{
33
* {{es}}
44
* {{kib}}
55
* [Logstash](logstash://reference/index.md)
6-
* [{{agent}}](/reference/ingestion-tools/fleet/index.md) or [Beats](asciidocalypse://docs/beats/docs/reference/index.md)
6+
* [{{agent}}](/reference/ingestion-tools/fleet/index.md) or [Beats](beats://reference/index.md)
77
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
88
* [Elasticsearch Hadoop](elasticsearch-hadoop://reference/index.md)
99

deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,24 +86,24 @@ To use the Cloud ID, you need:
8686
* A user ID and password that has permission to send data to your {{es}} cluster.
8787

8888
::::{important}
89-
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.
89+
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.
9090
::::
9191

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

9494
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.
9595

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

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

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

108108
::::{note}
109109
Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information.

deploy-manage/deploy/cloud-on-k8s/configuration-beats.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ stringData:
7373
hosts: ["quickstart-es-http.default.svc:9200"]
7474
```
7575

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

7878

7979
## Customize the connection to an Elasticsearch cluster [k8s-beat-connect-es]
@@ -154,7 +154,7 @@ stringData:
154154
AGENT_NAME_VAR: id_007
155155
```
156156

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

159159

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

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

207-
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:
207+
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:
208208

209209
```yaml
210210
apiVersion: beat.k8s.elastic.co/v1beta1

deploy-manage/deploy/cloud-on-k8s/logstash-plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,7 @@ stringData:
448448

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

451-
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.
451+
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.
452452

453453

454454

deploy-manage/deploy/cloud-on-k8s/troubleshooting-beats.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ When `kibanaRef` is specified, Beat tries to connect to the Kibana instance. If
1515

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

18-
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:
18+
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:
1919

2020
* 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.
2121
* Instead of using `config` to define configuration inline, use `configRef` and store the configuration in a Secret.

deploy-manage/deploy/elastic-cloud/find-cloud-id.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ To use the Cloud ID, you need:
4242
* The unique Cloud ID for your deployment, available from the deployment overview page.
4343
* A user ID and password that has permission to send data to your cluster.
4444

45-
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.
45+
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.
4646

4747

4848

@@ -51,7 +51,7 @@ To use the Cloud ID, you need:
5151
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.
5252

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

5757

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

6666
::::{note}
6767
Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information.

deploy-manage/deploy/self-managed/air-gapped-install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Specifically:
3838

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

41-
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).
41+
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).
4242

4343

4444
## {{ls}} [air-gapped-logstash]

deploy-manage/monitor/monitoring-data/config-monitoring-indices-metricbeat-7-internal-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ applies_to:
1111

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

14-
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:
14+
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:
1515

1616
* `.monitoring-{{product}}-7-mb-{{date}}`, when using {{metricbeat}} 7.
1717
* `.monitoring-{{product}}-7-{{date}}`, when using internal collection.

deploy-manage/monitor/stack-monitoring/collecting-log-data-with-filebeat.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ If you’re using {{agent}}, do not deploy {{filebeat}} for log collection. Inst
3333
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}}.
3434
::::
3535

36-
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.
36+
3. [Install {{filebeat}}](beats://reference/filebeat/filebeat-installation-configuration.md) on the {{es}} nodes that contain logs that you want to monitor.
3737
4. Identify where to send the log data.
3838

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

6262
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.
6363

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

6666
5. Optional: Identify where to visualize the data.
6767

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

8484
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.
85-
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).
85+
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).
8686

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

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

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

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

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

102-
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).
102+
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).
103103

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

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

110110
::::{note}
111-
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).
111+
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).
112112
::::
113113

114114
9. Check whether the appropriate indices exist on the monitoring cluster.

0 commit comments

Comments
 (0)