Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/observability/apm/command-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ For example:
+
["source","sh",subs="attributes"]
----------------------------------------------------------------------
apm-server -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"
apm-server -E "name=mybeat" -E "output.elasticsearch.hosts=['<YOUR_HOST_URL>:9200']"
----------------------------------------------------------------------
+
This setting is applied to the currently running APM Server process.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Example configuration:
["source","yaml",subs="attributes"]
----
output.elasticsearch:
hosts: ["https://myEShost:9200"] <1>
hosts: ["<YOUR_ES_HOST_URL>:9200"] <1>
----
<1> To enable SSL, add `https` to all URLs defined under __hosts__.

Expand All @@ -35,7 +35,7 @@ output, APM Server can use any of the following authentication methods:
["source","yaml",subs="attributes,callouts"]
----
output.elasticsearch:
hosts: ["https://myEShost:9200"]
hosts: ["<YOUR_ES_HOST_URL>:9200"]
username: "apm_writer"
password: "{pwd}"
----
Expand All @@ -45,16 +45,16 @@ output.elasticsearch:
["source","yaml",subs="attributes,callouts"]
----
output.elasticsearch:
hosts: ["https://myEShost:9200"]
api_key: "ZCV7VnwBgnX0T19fN8Qe:KnR6yE41RrSowb0kQ0HWoA"
hosts: ["<YOUR_ES_HOST_URL>:9200"]
api_key: "ZCV7VnwBgnX0T19fN8Qe:KnR6yE41RrSowb0kQ0HWoA" <1>
----

*PKI certificate authentication:*

["source","yaml",subs="attributes,callouts"]
----
output.elasticsearch:
hosts: ["https://myEShost:9200"]
hosts: ["<YOUR_ES_HOST_URL>:9200"]
ssl.certificate: "/etc/pki/client/cert.pem"
ssl.key: "/etc/pki/client/cert.key"
----
Expand Down
8 changes: 4 additions & 4 deletions docs/en/observability/apm/https.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For example:
["source","yaml",subs="attributes,callouts"]
----------------------------------------------------------------------
output.elasticsearch:
hosts: ["https://myEShost:9200"]
hosts: ["<YOUR_ES_HOST_URL>:9200"]
username: "apm_writer" <1>
password: "{pwd}"
----------------------------------------------------------------------
Expand All @@ -33,7 +33,7 @@ For example:
["source","yaml",subs="attributes,callouts"]
----------------------------------------------------------------------
output.elasticsearch:
hosts: ["https://myEShost:9200"]
hosts: ["<YOUR_ES_HOST_URL>:9200"]
api_key: "KnR6yE41RrSowb0kQ0HWoA" <1>
----------------------------------------------------------------------
<1> This API key must have the privileges required to publish events to {es}.
Expand All @@ -49,7 +49,7 @@ For example:
["source","yaml",subs="attributes,callouts"]
----------------------------------------------------------------------
output.elasticsearch:
hosts: ["https://myEShost:9200"]
hosts: ["<YOUR_ES_HOST_URL>:9200"]
ssl.certificate: "/etc/pki/client/cert.pem" <1>
ssl.key: "/etc/pki/client/cert.key" <2>
----------------------------------------------------------------------
Expand All @@ -76,7 +76,7 @@ Here is an example configuration:
["source","yaml",subs="attributes,callouts"]
----------------------------------------------------------------------
output.elasticsearch:
hosts: ["https://myEShost:9200"]
hosts: ["<YOUR_ES_HOST_URL>:9200"]
ssl.certificate_authorities: <1>
- /etc/pki/my_root_ca.pem
- /etc/pki/my_other_ca.pem
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ monitoring:
enabled: true
cluster_uuid: PRODUCTION_ES_CLUSTER_UUID <1>
elasticsearch:
hosts: ["https://example.com:9200", "https://example2.com:9200"] <2>
hosts: ["<HOST_URL>:9200", "<HOST_URL>:9200"] <2>
api_key: id:api_key <3>
username: apm_system
password: somepassword
Expand All @@ -88,7 +88,7 @@ monitoring:
enabled: true
cluster_uuid: PRODUCTION_ES_CLUSTER_UUID
elasticsearch:
hosts: ["https://example.com:9200", "https://example2.com:9200"]
hosts: ["<HOST_URL>:9200", "<HOST_URL>:9200"]
username: ""
ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
ssl.certificate: "/etc/pki/client/cert.pem"
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/apm/otel-direct.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ For example, if you are instrumenting a Java app, define the following environme
[source,bash]
----
export OTEL_RESOURCE_ATTRIBUTES=service.name=checkoutService,service.version=1.1,deployment.environment=production
export OTEL_EXPORTER_OTLP_ENDPOINT=https://apm_server_url:8200
export OTEL_EXPORTER_OTLP_ENDPOINT=<YOUR_APM_SERVER_URL>:8200
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer an_apm_secret_token"
export OTEL_METRICS_EXPORTER="otlp" \
export OTEL_LOGS_EXPORTER="otlp" \ <1>
Expand Down
14 changes: 7 additions & 7 deletions docs/en/observability/apm/shared-ssl-logstash-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,26 +73,26 @@ Before running APM Server, you should validate the {ls} server's certificate. Yo

[source,shell]
------------------------------------------------------------------------------
curl -v --cacert ca.crt https://logs.mycompany.com:5044
curl -v --cacert ca.crt <YOUR_URL>:5044
------------------------------------------------------------------------------

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

[source,shell]
------------------------------------------------------------------------------
* Rebuilt URL to: https://logs.mycompany.com:5044/
* Rebuilt URL to: <YOUR_URL>:5044/
* Trying 192.168.99.100...
* Connected to logs.mycompany.com (192.168.99.100) port 5044 (#0)
* Connected to <YOUR_URL> (192.168.99.100) port 5044 (#0)
* TLS 1.2 connection using TLS_DHE_RSA_WITH_AES_256_CBC_SHA
* Server certificate: logs.mycompany.com
* Server certificate: mycompany.com
* Server certificate: <YOUR_URL>
* Server certificate: <YOUR_URL>
> GET / HTTP/1.1
> Host: logs.mycompany.com:5044
> Host: <YOUR_URL>:5044
> User-Agent: curl/7.43.0
> Accept: */*
>
* Empty reply from server
* Connection #0 to host logs.mycompany.com left intact
* Connection #0 to host <YOUR_URL> left intact
curl: (52) Empty reply from server
------------------------------------------------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ plugins {

elasticApm {
// Minimal configuration
serverUrl = "https://your.elastic.server"
serverUrl = "<YOUR_ELASTIC_SERVER>"

// Optional
serviceName = "your app name" <2>
Expand Down
6 changes: 3 additions & 3 deletions docs/en/observability/ci-cd-observability.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ passing the configuration details as environment variables:

[source,bash]
----
export OTEL_EXPORTER_OTLP_ENDPOINT="https://elastic-apm-server.example.com:8200"
export OTEL_EXPORTER_OTLP_ENDPOINT="<YOUR_APM_SERVER_URL>:8200"
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer an_apm_secret_token"
export OTEL_TRACES_EXPORTER="otlp"

Expand All @@ -374,7 +374,7 @@ command line argument “-Dmaven.ext.class.path=...”

[source,bash]
----
export OTEL_EXPORTER_OTLP_ENDPOINT="https://elastic-apm-server.example.com:8200"
export OTEL_EXPORTER_OTLP_ENDPOINT="<YOUR_APM_SERVER_URL>:8200"
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer an_apm_secret_token"
export OTEL_TRACES_EXPORTER="otlp"

Expand Down Expand Up @@ -520,7 +520,7 @@ through the `TRACEPARENT`.

[source,bash]
----
OTEL_EXPORTER_OTLP_ENDPOINT=https://elastic-apm-server.example.com:8200 \
OTEL_EXPORTER_OTLP_ENDPOINT=<YOUR_APM_SERVER_URL>:8200 \
OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer an_apm_secret_token" \
OTEL_SERVICE_NAME=pytest_otel \
pytest --otel-session-name='My_Test_cases'
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/logs-ecs-application.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ output.elasticsearch:
api_key: "id:api_key"
----

. 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`.
. 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`.
. From **Developer tools**, run the following command to create an API key that grants `manage` permissions for the `cluster` and the `filebeat-*` indices using:
+
[source,console]
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/logs-plaintext.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ output.elasticsearch:
api_key: "id:api_key"
----

. 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`.
. 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`.
. From **Developer tools**, run the following command to create an API key that grants `manage` permissions for the `cluster` and the `filebeat-*` indices using:
+
[source,console]
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/logs-stream.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ inputs:

Next, set the values for these fields:

- `hosts` – 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`.
- `hosts` – Copy the {es} endpoint from *Help menu (image:images/help-icon.png[]) → Connection details*. For example, `<YOUR_ELASTICSEARCH_ENDPOINT>:443`.
- `api-key` – Use an API key to grant the agent access to {es}. To create an API key for your agent, refer to the {fleet-guide}/grant-access-to-elasticsearch.html#create-api-key-standalone-agent[Create API keys for standalone agents] documentation.
+
NOTE: The API key format should be `<id>:<key>`. Make sure you selected *Beats* when you created your API key. Base64 encoded API keys are not currently supported in this configuration.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/logs-troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The host needs access to {kib}. Port `443` must be open and the deployment's {es
Run the following command, replacing the URL with your endpoint, and you should get an authentication error with more details on resolving your issue:

```shell
curl https://your-endpoint.elastic.cloud
curl <YOUR_ELASTICSEARCH_ENDPOINT>
```

[discrete]
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/monitor-java-app.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1709,7 +1709,7 @@ environment variables. The `.env` file should look like this:
[source,bash]
----
ELASTIC_APM_SERVICE_NAME=javalin-app
ELASTIC_APM_SERVER_URLS=https://APM_ENDPOINT_URL
ELASTIC_APM_SERVER_URLS=<YOUR_APM_ENDPOINT_URL>
ELASTIC_APM_SECRET_TOKEN=PqWTHGtHZS2i0ZuBol
----
+
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/synthetics-configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export default env => {
*/
project: {
id: 'my-project',
url: 'https://abc123',
url: '<YOUR_PROJECT_URL>',
space: 'custom-space',
},
};
Expand Down