Skip to content

Commit 296e956

Browse files
[8.7](backport #4926) [Observability Docs] Replace placeholder URLs (#4935)
* [Observability Docs] Replace placeholder URLs (#4926) (cherry picked from commit 5b5a5c9) * fix conflicts --------- Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> Co-authored-by: Mike Birnstiehl <michael.birnstiehl@elastic.co>
1 parent 5ee526c commit 296e956

7 files changed

Lines changed: 22 additions & 22 deletions

File tree

docs/en/apm-server/legacy/copied-from-beats/docs/https.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ For example:
3232
["source","yaml",subs="attributes,callouts"]
3333
----------------------------------------------------------------------
3434
output.elasticsearch:
35-
hosts: ["https://myEShost:9200"]
35+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
3636
username: "{beat_default_index_prefix}_writer" <1>
3737
password: "{pwd}" <2>
3838
----------------------------------------------------------------------
@@ -55,7 +55,7 @@ For example:
5555
["source","yaml",subs="attributes,callouts"]
5656
----------------------------------------------------------------------
5757
output.elasticsearch:
58-
hosts: ["https://myEShost:9200"]
58+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
5959
api_key: "KnR6yE41RrSowb0kQ0HWoA" <1>
6060
----------------------------------------------------------------------
6161
<1> This API key must have the privileges required to publish events to {es}.
@@ -71,7 +71,7 @@ For example:
7171
["source","yaml",subs="attributes,callouts"]
7272
----------------------------------------------------------------------
7373
output.elasticsearch:
74-
hosts: ["https://myEShost:9200"]
74+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
7575
ssl.certificate: "/etc/pki/client/cert.pem" <1>
7676
ssl.key: "/etc/pki/client/cert.key" <2>
7777
----------------------------------------------------------------------
@@ -98,7 +98,7 @@ Here is an example configuration:
9898
["source","yaml",subs="attributes,callouts"]
9999
----------------------------------------------------------------------
100100
output.elasticsearch:
101-
hosts: ["https://myEShost:9200"]
101+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
102102
ssl.certificate_authorities: <1>
103103
- /etc/pki/my_root_ca.pem
104104
- /etc/pki/my_other_ca.pem

docs/en/apm-server/legacy/copied-from-beats/docs/monitoring/monitoring-internal-collection.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ monitoring:
7979
enabled: true
8080
cluster_uuid: PRODUCTION_ES_CLUSTER_UUID <1>
8181
elasticsearch:
82-
hosts: ["https://example.com:9200", "https://example2.com:9200"] <2>
82+
hosts: ["<HOST_URL>:9200", "<HOST_URL>:9200"] <2>
8383
api_key: id:api_key <3>
8484
username: {beat_monitoring_user}
8585
password: somepassword
@@ -102,7 +102,7 @@ monitoring:
102102
enabled: true
103103
cluster_uuid: PRODUCTION_ES_CLUSTER_UUID
104104
elasticsearch:
105-
hosts: ["https://example.com:9200", "https://example2.com:9200"]
105+
hosts: ["<HOST_URL>:9200", "<HOST_URL>:9200"]
106106
username: ""
107107
ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
108108
ssl.certificate: "/etc/pki/client/cert.pem"

docs/en/apm-server/legacy/copied-from-beats/docs/shared-ssl-logstash-config.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,26 +86,26 @@ Before running {beatname_uc}, you should validate the {ls} server's certificate.
8686

8787
[source,shell]
8888
------------------------------------------------------------------------------
89-
curl -v --cacert ca.crt https://logs.mycompany.com:5044
89+
curl -v --cacert ca.crt <YOUR_URL>:5044
9090
------------------------------------------------------------------------------
9191

9292
If the test is successful, you'll receive an empty response error:
9393

9494
[source,shell]
9595
------------------------------------------------------------------------------
96-
* Rebuilt URL to: https://logs.mycompany.com:5044/
96+
* Rebuilt URL to: <YOUR_URL>:5044/
9797
* Trying 192.168.99.100...
98-
* Connected to logs.mycompany.com (192.168.99.100) port 5044 (#0)
98+
* Connected to <YOUR_URL> (192.168.99.100) port 5044 (#0)
9999
* TLS 1.2 connection using TLS_DHE_RSA_WITH_AES_256_CBC_SHA
100-
* Server certificate: logs.mycompany.com
101-
* Server certificate: mycompany.com
100+
* Server certificate: <YOUR_URL>
101+
* Server certificate: <YOUR_URL>
102102
> GET / HTTP/1.1
103-
> Host: logs.mycompany.com:5044
103+
> Host: <YOUR_URL>:5044
104104
> User-Agent: curl/7.43.0
105105
> Accept: */*
106106
>
107107
* Empty reply from server
108-
* Connection #0 to host logs.mycompany.com left intact
108+
* Connection #0 to host <YOUR_URL> left intact
109109
curl: (52) Empty reply from server
110110
------------------------------------------------------------------------------
111111

docs/en/apm-server/legacy/copied-from-beats/outputs/elasticsearch/docs/elasticsearch.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Example configuration:
1414
["source","yaml",subs="attributes"]
1515
----
1616
output.elasticsearch:
17-
hosts: ["https://myEShost:9200"] <1>
17+
hosts: ["<YOUR_ES_HOST_URL>:9200"] <1>
1818
----
1919
<1> To enable SSL, add `https` to all URLs defined under __hosts__.
2020

@@ -30,7 +30,7 @@ output, {beatname_uc} can use any of the following authentication methods:
3030
["source","yaml",subs="attributes,callouts"]
3131
----
3232
output.elasticsearch:
33-
hosts: ["https://myEShost:9200"]
33+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
3434
username: "{beat_default_index_prefix}_writer"
3535
password: "{pwd}"
3636
----
@@ -40,7 +40,7 @@ output.elasticsearch:
4040
["source","yaml",subs="attributes,callouts"]
4141
----
4242
output.elasticsearch:
43-
hosts: ["https://myEShost:9200"]
43+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
4444
api_key: "ZCV7VnwBgnX0T19fN8Qe:KnR6yE41RrSowb0kQ0HWoA"
4545
----
4646

@@ -49,7 +49,7 @@ output.elasticsearch:
4949
["source","yaml",subs="attributes,callouts"]
5050
----
5151
output.elasticsearch:
52-
hosts: ["https://myEShost:9200"]
52+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
5353
ssl.certificate: "/etc/pki/client/cert.pem"
5454
ssl.key: "/etc/pki/client/cert.key"
5555
----

docs/en/observability/ci-cd-observability.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ passing the configuration details as environment variables:
362362

363363
[source,bash]
364364
----
365-
export OTEL_EXPORTER_OTLP_ENDPOINT="https://elastic-apm-server.example.com:8200"
365+
export OTEL_EXPORTER_OTLP_ENDPOINT="<YOUR_APM_SERVER_URL>:8200"
366366
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer an_apm_secret_token"
367367
export OTEL_TRACES_EXPORTER="otlp"
368368
@@ -374,7 +374,7 @@ command line argument “-Dmaven.ext.class.path=...”
374374

375375
[source,bash]
376376
----
377-
export OTEL_EXPORTER_OTLP_ENDPOINT="https://elastic-apm-server.example.com:8200"
377+
export OTEL_EXPORTER_OTLP_ENDPOINT="<YOUR_APM_SERVER_URL>:8200"
378378
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer an_apm_secret_token"
379379
export OTEL_TRACES_EXPORTER="otlp"
380380
@@ -520,7 +520,7 @@ through the `TRACEPARENT`.
520520

521521
[source,bash]
522522
----
523-
OTEL_EXPORTER_OTLP_ENDPOINT=https://elastic-apm-server.example.com:8200 \
523+
OTEL_EXPORTER_OTLP_ENDPOINT=<YOUR_APM_SERVER_URL>:8200 \
524524
OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer an_apm_secret_token" \
525525
OTEL_SERVICE_NAME=pytest_otel \
526526
pytest --otel-session-name='My_Test_cases'

docs/en/observability/monitor-java-app.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1709,7 +1709,7 @@ environment variables. The `.env` file should look like this:
17091709
[source,bash]
17101710
----
17111711
ELASTIC_APM_SERVICE_NAME=javalin-app
1712-
ELASTIC_APM_SERVER_URLS=https://APM_ENDPOINT_URL
1712+
ELASTIC_APM_SERVER_URLS=<YOUR_APM_ENDPOINT_URL>
17131713
ELASTIC_APM_SECRET_TOKEN=PqWTHGtHZS2i0ZuBol
17141714
----
17151715
+

docs/en/observability/synthetics-configuration.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ To list available locations you can:
104104
Locations will be listed in _Locations_.
105105

106106
`privateLocations` (`Array<string>`)::
107-
The <<synthetics-private-location,{private-location}s>> to which the monitors will be deployed. These {private-location}s refer to locations hosted and managed by you, whereas
107+
The <<synthetics-private-location,{private-location}s>> to which the monitors will be deployed. These {private-location}s refer to locations hosted and managed by you, whereas
108108
`locations` are hosted by Elastic. You can specify a {private-location} using the location's name.
109109
+
110110
To list available {private-location}s you can:

0 commit comments

Comments
 (0)