You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## 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]>
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,24 +86,24 @@ To use the Cloud ID, you need:
86
86
* A user ID and password that has permission to send data to your {{es}} cluster.
87
87
88
88
::::{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.
90
90
::::
91
91
92
92
### Example: Configure Beats with your Cloud ID [ece-cloud-id-beats]
93
93
94
94
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.
95
95
96
96
::::{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.
98
98
::::
99
99
100
100
To get started with Metricbeat and {{ece}}:
101
101
102
102
1.[Log into the Cloud UI](log-into-cloud-ui.md).
103
103
2.[Create a new deployment](create-deployment.md) and copy down the password for the `elastic` user.
104
104
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).
107
107
108
108
::::{note}
109
109
Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-on-k8s/configuration-beats.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ stringData:
73
73
hosts: ["quickstart-es-http.default.svc:9200"]
74
74
```
75
75
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.
77
77
78
78
79
79
## Customize the connection to an Elasticsearch cluster [k8s-beat-connect-es]
@@ -154,7 +154,7 @@ stringData:
154
154
AGENT_NAME_VAR: id_007
155
155
```
156
156
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.
158
158
159
159
160
160
## 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
204
204
205
205
## Role Based Access Control for Beats [k8s-beat-role-based-access-control-for-beats]
206
206
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:
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-on-k8s/logstash-plugins.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -448,7 +448,7 @@ stringData:
448
448
449
449
### Elastic Agent input and Beats input plugins [k8s-logstash-plugin-considerations-agent-beats]
450
450
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.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-on-k8s/troubleshooting-beats.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ When `kibanaRef` is specified, Beat tries to connect to the Kibana instance. If
15
15
16
16
## Configuration containing key: null is malformed [k8s-beat-configuration-containing-key-null-is-malformed]
17
17
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:
19
19
20
20
* 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.
21
21
* Instead of using `config` to define configuration inline, use `configRef` and store the configuration in a Secret.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/elastic-cloud/find-cloud-id.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ To use the Cloud ID, you need:
42
42
* The unique Cloud ID for your deployment, available from the deployment overview page.
43
43
* A user ID and password that has permission to send data to your cluster.
44
44
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.
46
46
47
47
48
48
@@ -51,7 +51,7 @@ To use the Cloud ID, you need:
51
51
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.
52
52
53
53
::::{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.
55
55
::::
56
56
57
57
@@ -60,8 +60,8 @@ To get started with Metricbeat and {{ecloud}}:
60
60
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
61
61
2.[Create a new deployment](create-an-elastic-cloud-hosted-deployment.md) and copy down the password for the `elastic` user.
62
62
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).
65
65
66
66
::::{note}
67
67
Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/self-managed/air-gapped-install.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ Specifically:
38
38
39
39
## {{beats}} [air-gapped-beats]
40
40
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).
Copy file name to clipboardExpand all lines: deploy-manage/monitor/monitoring-data/config-monitoring-indices-metricbeat-7-internal-collection.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ applies_to:
11
11
12
12
# Configuring indices created by Metricbeat 7 or internal collection [config-monitoring-indices-metricbeat-7-internal-collection]
13
13
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:
15
15
16
16
*`.monitoring-{{product}}-7-mb-{{date}}`, when using {{metricbeat}} 7.
17
17
*`.monitoring-{{product}}-7-{{date}}`, when using internal collection.
Copy file name to clipboardExpand all lines: deploy-manage/monitor/stack-monitoring/collecting-log-data-with-filebeat.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ If you’re using {{agent}}, do not deploy {{filebeat}} for log collection. Inst
33
33
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}}.
34
34
::::
35
35
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.
37
37
4. Identify where to send the log data.
38
38
39
39
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
61
61
62
62
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.
63
63
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).
65
65
66
66
5. Optional: Identify where to visualize the data.
67
67
@@ -82,9 +82,9 @@ If you’re using {{agent}}, do not deploy {{filebeat}} for log collection. Inst
82
82
If {{security-features}} are enabled, you must provide a valid user ID and password so that {{filebeat}} can connect to {{kib}}:
83
83
84
84
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).
86
86
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).
88
88
89
89
6. Enable the {{es}} module and set up the initial {{filebeat}} environment on each node.
90
90
@@ -95,20 +95,20 @@ If you’re using {{agent}}, do not deploy {{filebeat}} for log collection. Inst
95
95
filebeat setup -e
96
96
```
97
97
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).
99
99
100
100
7. Configure the {{es}} module in {{filebeat}} on each node.
101
101
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).
103
103
104
104
::::{important}
105
105
If there are JSON logs, configure the `var.paths` settings to point to them instead of the plain text logs.
106
106
::::
107
107
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.
109
109
110
110
::::{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).
112
112
::::
113
113
114
114
9. Check whether the appropriate indices exist on the monitoring cluster.
0 commit comments