Skip to content

Commit 157e642

Browse files
[9.1](backport #46301) [docs] Replace placeholder URLs (#46772)
* [docs] Replace placeholder URLs (#46301) * replace placeholder URLs * replace more placeholder URLs * use replaceable placeholders for requests * update generated docs * apply suggestions from code review Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * replace example dot co dot uk examples * fix check-docs --------- Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> (cherry picked from commit 3dc7203) # Conflicts: # auditbeat/include/fields.go * resolve conflicts --------- Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
1 parent 8ac79d1 commit 157e642

36 files changed

+143
-143
lines changed

auditbeat/include/fields.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/auditbeat/configuring-ssl-logstash.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ To use SSL mutual authentication:
6565
Before running Auditbeat, you should validate the Logstash server’s certificate. You can use `curl` to validate the certificate even though the protocol used to communicate with Logstash is not based on HTTP. For example:
6666

6767
```shell
68-
curl -v --cacert ca.crt https://logs.example.com:5044
68+
curl -v --cacert ca.crt https://logs.example.com:5044
6969
```
7070

71-
If the test is successful, you’ll receive an empty response error:
71+
If the test is successful, you’ll receive an empty response error. Here's an example response assuming the `HOST_URL` was `logs.example.com` and `PORT` was `5044`:
7272

7373
```shell
7474
* Rebuilt URL to: https://logs.example.com:5044/

docs/reference/auditbeat/exported-fields-ecs.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ Client / server representations can add semantic context to an exchange, which i
317317

318318

319319
**`client.subdomain`**
320-
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
320+
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.example.com" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
321321

322322
type: keyword
323323

@@ -1044,7 +1044,7 @@ Destination fields are usually populated in conjunction with source fields. The
10441044

10451045

10461046
**`destination.subdomain`**
1047-
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
1047+
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.example.com" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
10481048

10491049
type: keyword
10501050

@@ -5510,7 +5510,7 @@ Client / server representations can add semantic context to an exchange, which i
55105510

55115511

55125512
**`server.subdomain`**
5513-
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
5513+
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.example.com" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
55145514

55155515
type: keyword
55165516

@@ -6006,7 +6006,7 @@ Source fields are usually populated in conjunction with destination fields. The
60066006

60076007

60086008
**`source.subdomain`**
6009-
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
6009+
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.example.com" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
60106010

60116011
type: keyword
60126012

@@ -7195,7 +7195,7 @@ Field is not indexed.
71957195

71967196

71977197
**`threat.enrichments.indicator.url.subdomain`**
7198-
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
7198+
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.example.com" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
71997199

72007200
type: keyword
72017201

@@ -7413,7 +7413,7 @@ Field is not indexed.
74137413

74147414
type: keyword
74157415

7416-
example: bad-domain.com
7416+
example: example.com
74177417

74187418

74197419
**`threat.enrichments.matched.field`**
@@ -8569,7 +8569,7 @@ Field is not indexed.
85698569

85708570

85718571
**`threat.indicator.url.subdomain`**
8572-
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
8572+
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.example.com" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
85738573

85748574
type: keyword
85758575

@@ -9645,7 +9645,7 @@ URL fields provide support for complete or partial URLs, and supports the breaki
96459645

96469646

96479647
**`url.subdomain`**
9648-
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
9648+
: The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.example.com" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.
96499649

96509650
type: keyword
96519651

docs/reference/auditbeat/monitoring-internal-collection.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Use internal collectors to send {{beats}} monitoring data directly to your monit
4242
enabled: true
4343
cluster_uuid: PRODUCTION_ES_CLUSTER_UUID <1>
4444
elasticsearch:
45-
hosts: ["https://example.com:9200", "https://example2.com:9200"] <2>
45+
hosts: ["<HOST_URL_1>:<PORT_1>", "<HOST_URL_2>:<PORT_2>"] <2>
4646
api_key: id:api_key <3>
4747
username: beats_system
4848
password: somepassword
@@ -60,7 +60,7 @@ Use internal collectors to send {{beats}} monitoring data directly to your monit
6060
enabled: true
6161
cluster_uuid: PRODUCTION_ES_CLUSTER_UUID
6262
elasticsearch:
63-
hosts: ["https://example.com:9200", "https://example2.com:9200"]
63+
hosts: ["<HOST_URL_1>:<PORT_1>", "<HOST_URL_2>:<PORT_2>"]
6464
username: ""
6565
ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
6666
ssl.certificate: "/etc/pki/client/cert.pem"

docs/reference/filebeat/configuring-ssl-logstash.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To use SSL mutual authentication:
2626

2727
```yaml
2828
output.logstash:
29-
hosts: ["logs.mycompany.com:5044"]
29+
hosts: ["<HOST_URL>:<PORT>"]
3030
ssl.certificate_authorities: ["/etc/ca.crt"]
3131
ssl.certificate: "/etc/client.crt"
3232
ssl.key: "/etc/client.key"
@@ -65,25 +65,25 @@ To use SSL mutual authentication:
6565
Before running Filebeat, you should validate the Logstash server’s certificate. You can use `curl` to validate the certificate even though the protocol used to communicate with Logstash is not based on HTTP. For example:
6666

6767
```shell
68-
curl -v --cacert ca.crt https://logs.mycompany.com:5044
68+
curl -v --cacert ca.crt <HOST_URL>:<PORT>
6969
```
7070

71-
If the test is successful, you’ll receive an empty response error:
71+
If the test is successful, you’ll receive an empty response error. Here's an example response assuming the `HOST_URL` was `logs.example.com` and `PORT` was `5044`:
7272

7373
```shell
74-
* Rebuilt URL to: https://logs.mycompany.com:5044/
74+
* Rebuilt URL to: https://logs.example.com:5044/
7575
* Trying 192.168.99.100...
76-
* Connected to logs.mycompany.com (192.168.99.100) port 5044 (#0)
76+
* Connected to logs.example.com (192.168.99.100) port 5044 (#0)
7777
* TLS 1.2 connection using TLS_DHE_RSA_WITH_AES_256_CBC_SHA
78-
* Server certificate: logs.mycompany.com
79-
* Server certificate: mycompany.com
78+
* Server certificate: logs.example.com
79+
* Server certificate: example.com
8080
> GET / HTTP/1.1
81-
> Host: logs.mycompany.com:5044
81+
> Host: logs.example.com:5044
8282
> User-Agent: curl/7.43.0
8383
> Accept: */*
8484
>
8585
* Empty reply from server
86-
* Connection #0 to host logs.mycompany.com left intact
86+
* Connection #0 to host logs.example.com left intact
8787
curl: (52) Empty reply from server
8888
```
8989

@@ -93,7 +93,7 @@ The following example uses the IP address rather than the hostname to validate t
9393
curl -v --cacert ca.crt https://192.168.99.100:5044
9494
```
9595

96-
Validation for this test fails because the certificate is not valid for the specified IP address. It’s only valid for the `logs.mycompany.com`, the hostname that appears in the Subject field of the certificate.
96+
Validation for this test fails because the certificate is not valid for the specified IP address. It’s only valid for the `logs.example.com`, the hostname that appears in the Subject field of the certificate.
9797

9898
```shell
9999
* Rebuilt URL to: https://192.168.99.100:5044/

docs/reference/filebeat/exported-fields-cef.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -932,7 +932,7 @@ Collection of key-value pairs carried in the CEF extension field.
932932

933933

934934
**`cef.extensions.sourceHostName`**
935-
: Identifies the source that an event refers to in an IP network. The format should be a fully qualified domain name (FQDN) associated with the source node, when a mode is available. Examples: 'host' or 'host.domain.com'.
935+
: Identifies the source that an event refers to in an IP network. The format should be a fully qualified domain name (FQDN) associated with the source node, when a mode is available. Examples: 'host' or 'host.example.com'.
936936

937937
type: keyword
938938

0 commit comments

Comments
 (0)