Skip to content

Commit dcc8cb6

Browse files
[Observability Docs] Replace placeholder URLs (#4926) (#4946)
(cherry picked from commit 5b5a5c9) Co-authored-by: Mike Birnstiehl <[email protected]>
1 parent 3ec6c46 commit dcc8cb6

15 files changed

+30
-30
lines changed

docs/en/observability/apm/collect-application-data/open-telemetry/otel-direct.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ For example, if you are instrumenting a Java app, define the following environme
107107
[source,bash]
108108
----
109109
export OTEL_RESOURCE_ATTRIBUTES=service.name=checkoutService,service.version=1.1,deployment.environment=production
110-
export OTEL_EXPORTER_OTLP_ENDPOINT=https://apm_server_url:8200
110+
export OTEL_EXPORTER_OTLP_ENDPOINT=<YOUR_APM_SERVER_URL>:8200
111111
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer an_apm_secret_token"
112112
export OTEL_METRICS_EXPORTER="otlp" \
113113
export OTEL_LOGS_EXPORTER="otlp" \ <1>

docs/en/observability/apm/configure/advanced-setup/command-reference.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@ For example:
507507
+
508508
["source","sh",subs="attributes"]
509509
----------------------------------------------------------------------
510-
apm-server -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"
510+
apm-server -E "name=mybeat" -E "output.elasticsearch.hosts=['<YOUR_HOST_URL>:9200']"
511511
----------------------------------------------------------------------
512512
+
513513
This setting is applied to the currently running APM Server process.

docs/en/observability/apm/configure/outputs/elasticsearch.asciidoc

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

@@ -35,7 +35,7 @@ output, APM Server can use any of the following authentication methods:
3535
["source","yaml",subs="attributes,callouts"]
3636
----
3737
output.elasticsearch:
38-
hosts: ["https://myEShost:9200"]
38+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
3939
username: "apm_writer"
4040
password: "{pwd}"
4141
----
@@ -45,7 +45,7 @@ output.elasticsearch:
4545
["source","yaml",subs="attributes,callouts"]
4646
----
4747
output.elasticsearch:
48-
hosts: ["https://myEShost:9200"]
48+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
4949
api_key: "ZCV7VnwBgnX0T19fN8Qe:KnR6yE41RrSowb0kQ0HWoA" <1>
5050
----
5151
<1> {blank}
@@ -56,7 +56,7 @@ include::elasticsearch.asciidoc[tag=configure-beats]
5656
["source","yaml",subs="attributes,callouts"]
5757
----
5858
output.elasticsearch:
59-
hosts: ["https://myEShost:9200"]
59+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
6060
ssl.certificate: "/etc/pki/client/cert.pem"
6161
ssl.key: "/etc/pki/client/cert.key"
6262
----

docs/en/observability/apm/https.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For example:
1818
["source","yaml",subs="attributes,callouts"]
1919
----------------------------------------------------------------------
2020
output.elasticsearch:
21-
hosts: ["https://myEShost:9200"]
21+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
2222
username: "apm_writer" <1>
2323
password: "{pwd}"
2424
----------------------------------------------------------------------
@@ -33,7 +33,7 @@ For example:
3333
["source","yaml",subs="attributes,callouts"]
3434
----------------------------------------------------------------------
3535
output.elasticsearch:
36-
hosts: ["https://myEShost:9200"]
36+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
3737
api_key: "KnR6yE41RrSowb0kQ0HWoA" <1>
3838
----------------------------------------------------------------------
3939
<1> This API key must have the privileges required to publish events to {es}.
@@ -49,7 +49,7 @@ For example:
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" <1>
5454
ssl.key: "/etc/pki/client/cert.key" <2>
5555
----------------------------------------------------------------------
@@ -76,7 +76,7 @@ Here is an example configuration:
7676
["source","yaml",subs="attributes,callouts"]
7777
----------------------------------------------------------------------
7878
output.elasticsearch:
79-
hosts: ["https://myEShost:9200"]
79+
hosts: ["<YOUR_ES_HOST_URL>:9200"]
8080
ssl.certificate_authorities: <1>
8181
- /etc/pki/my_root_ca.pem
8282
- /etc/pki/my_other_ca.pem

docs/en/observability/apm/monitor-apm-server/monitoring-internal-collection.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ monitoring:
6565
enabled: true
6666
cluster_uuid: PRODUCTION_ES_CLUSTER_UUID <1>
6767
elasticsearch:
68-
hosts: ["https://example.com:9200", "https://example2.com:9200"] <2>
68+
hosts: ["<HOST_URL>:9200", "<HOST_URL>:9200"] <2>
6969
api_key: id:api_key <3>
7070
username: apm_system
7171
password: somepassword
@@ -88,7 +88,7 @@ monitoring:
8888
enabled: true
8989
cluster_uuid: PRODUCTION_ES_CLUSTER_UUID
9090
elasticsearch:
91-
hosts: ["https://example.com:9200", "https://example2.com:9200"]
91+
hosts: ["<HOST_URL>:9200", "<HOST_URL>:9200"]
9292
username: ""
9393
ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
9494
ssl.certificate: "/etc/pki/client/cert.pem"

docs/en/observability/apm/shared-ssl-logstash-config.asciidoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,26 +73,26 @@ Before running APM Server, you should validate the {ls} server's certificate. Yo
7373

7474
[source,shell]
7575
------------------------------------------------------------------------------
76-
curl -v --cacert ca.crt https://logs.mycompany.com:5044
76+
curl -v --cacert ca.crt <YOUR_URL>:5044
7777
------------------------------------------------------------------------------
7878

7979
If the test is successful, you'll receive an empty response error:
8080

8181
[source,shell]
8282
------------------------------------------------------------------------------
83-
* Rebuilt URL to: https://logs.mycompany.com:5044/
83+
* Rebuilt URL to: <YOUR_URL>:5044/
8484
* Trying 192.168.99.100...
85-
* Connected to logs.mycompany.com (192.168.99.100) port 5044 (#0)
85+
* Connected to <YOUR_URL> (192.168.99.100) port 5044 (#0)
8686
* TLS 1.2 connection using TLS_DHE_RSA_WITH_AES_256_CBC_SHA
87-
* Server certificate: logs.mycompany.com
88-
* Server certificate: mycompany.com
87+
* Server certificate: <YOUR_URL>
88+
* Server certificate: <YOUR_URL>
8989
> GET / HTTP/1.1
90-
> Host: logs.mycompany.com:5044
90+
> Host: <YOUR_URL>:5044
9191
> User-Agent: curl/7.43.0
9292
> Accept: */*
9393
>
9494
* Empty reply from server
95-
* Connection #0 to host logs.mycompany.com left intact
95+
* Connection #0 to host <YOUR_URL> left intact
9696
curl: (52) Empty reply from server
9797
------------------------------------------------------------------------------
9898

docs/en/observability/apm/tab-widgets/install-agents.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ plugins {
2828
2929
elasticApm {
3030
// Minimal configuration
31-
serverUrl = "https://your.elastic.server"
31+
serverUrl = "<YOUR_ELASTIC_SERVER>"
3232
3333
// Optional
3434
serviceName = "your app name" <2>

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

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

367367
[source,bash]
368368
----
369-
export OTEL_EXPORTER_OTLP_ENDPOINT="https://elastic-apm-server.example.com:8200"
369+
export OTEL_EXPORTER_OTLP_ENDPOINT="<YOUR_APM_SERVER_URL>:8200"
370370
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer an_apm_secret_token"
371371
export OTEL_TRACES_EXPORTER="otlp"
372372
@@ -378,7 +378,7 @@ command line argument “-Dmaven.ext.class.path=...”
378378

379379
[source,bash]
380380
----
381-
export OTEL_EXPORTER_OTLP_ENDPOINT="https://elastic-apm-server.example.com:8200"
381+
export OTEL_EXPORTER_OTLP_ENDPOINT="<YOUR_APM_SERVER_URL>:8200"
382382
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer an_apm_secret_token"
383383
export OTEL_TRACES_EXPORTER="otlp"
384384
@@ -524,7 +524,7 @@ through the `TRACEPARENT`.
524524

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

docs/en/observability/logs-ecs-application.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ output.elasticsearch:
8888
api_key: "id:api_key"
8989
----
9090

91-
. Set the `hosts` to your deployment's {es} endpoint. Copy the {es} endpoint from *Help menu (image:images/help-icon.png[]) → Connection details*. For example, `https://my-deployment.es.us-central1.gcp.cloud.es.io:443`.
91+
. Set the `hosts` to your deployment's {es} endpoint. Copy the {es} endpoint from *Help menu (image:images/help-icon.png[]) → Connection details*. For example, `<YOUR_ELASTICSEARCH_ENDPOINT>:443`.
9292
. From **Developer tools**, run the following command to create an API key that grants `manage` permissions for the `cluster` and the `filebeat-*` indices using:
9393
+
9494
[source,console]

docs/en/observability/logs-plaintext.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ output.elasticsearch:
5050
api_key: "id:api_key"
5151
----
5252

53-
. Set the `hosts` to your deployment's {es} endpoint. Copy the {es} endpoint from *Help menu (image:images/help-icon.png[]) → Connection details*. For example, `https://my-deployment.es.us-central1.gcp.cloud.es.io:443`.
53+
. Set the `hosts` to your deployment's {es} endpoint. Copy the {es} endpoint from *Help menu (image:images/help-icon.png[]) → Connection details*. For example, `<YOUR_ELASTICSEARCH_ENDPOINT>:443`.
5454
. From **Developer tools**, run the following command to create an API key that grants `manage` permissions for the `cluster` and the `filebeat-*` indices using:
5555
+
5656
[source,console]

0 commit comments

Comments
 (0)