Skip to content

Commit c367798

Browse files
[ingest docs] Replace placeholder URLs (#2753)
Contributes to #1734, #1801 Replaces placeholder URLs with those reserved by the Internet Engineering Task Force (IETF) in RFC 2606 and RFC 6761 (e.g. `example.com`, `example.net`, `example.org`, `example.edu`, `.example`).
1 parent 3ee803f commit c367798

File tree

9 files changed

+30
-30
lines changed

9 files changed

+30
-30
lines changed

manage-data/ingest/transform-enrich/example-enrich-data-based-on-exact-values.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ The following index API request creates a source index and indexes a new documen
2121
```console
2222
PUT /users/_doc/1?refresh=wait_for
2323
{
24-
"email": "mardy.brown@asciidocsmith.com",
24+
"email": "mardy.brown@example.com",
2525
"first_name": "Mardy",
2626
"last_name": "Brown",
2727
"city": "New Orleans",
2828
"county": "Orleans",
2929
"state": "LA",
3030
"zip": 70116,
31-
"web": "mardy.asciidocsmith.com"
31+
"web": "mardy.example.com"
3232
}
3333
```
3434

@@ -83,7 +83,7 @@ Use the ingest pipeline to index a document. The incoming document should includ
8383
```console
8484
PUT /my-index-000001/_doc/my_id?pipeline=user_lookup
8585
{
86-
"email": "mardy.brown@asciidocsmith.com"
86+
"email": "mardy.brown@example.com"
8787
}
8888
```
8989

@@ -105,14 +105,14 @@ The API returns the following response:
105105
"_primary_term": 1,
106106
"_source": {
107107
"user": {
108-
"email": "mardy.brown@asciidocsmith.com",
108+
"email": "mardy.brown@example.com",
109109
"first_name": "Mardy",
110110
"last_name": "Brown",
111111
"zip": 70116,
112112
"city": "New Orleans",
113113
"state": "LA"
114114
},
115-
"email": "mardy.brown@asciidocsmith.com"
115+
"email": "mardy.brown@example.com"
116116
}
117117
}
118118
```

solutions/observability/apm/apm-server-binary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -676,7 +676,7 @@ Set up the agent with `<script>` tags or by using a bundler.
676676
Add a <script> tag to load the bundle and use the `elasticApm` global object to initialize the agent:
677677
678678
```html
679-
<script src="https://<your-cdn-host>.com/path/to/elastic-apm-rum.umd.min-<version>.js" crossorigin></script>
679+
<script src="<YOUR_URL>/path/to/elastic-apm-rum.umd.min-<VERSION>.js" crossorigin></script>
680680
<script>
681681
elasticApm.init({
682682
serviceName: '<instrumented-app>',
@@ -695,10 +695,10 @@ Loading the script asynchronously ensures the agent script will not block other
695695
var j = d.createElement(s),
696696
t = d.getElementsByTagName(s)[0]
697697
698-
j.src = 'https://<your-cdn-host>.com/path/to/elastic-apm-rum.umd.min-<version>.js'
698+
j.src = '<YOUR_URL>/path/to/elastic-apm-rum.umd.min-<VERSION>.js'
699699
j.onload = function() {elasticApm.init(c)}
700700
t.parentNode.insertBefore(j, t)
701-
})(document, 'script', {serviceName: '<instrumented-app>', serverUrl: '<apm-server-url>'})
701+
})(document, 'script', {serviceName: '<INSTRUMENTED_APP>', serverUrl: '<APM_SERVER_URL>'})
702702
</script>
703703
```
704704

solutions/observability/apm/apm-server-fleet-managed.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -723,7 +723,7 @@ Set up the agent with `<script>` tags or by using a bundler.
723723
Add a <script> tag to load the bundle and use the `elasticApm` global object to initialize the agent:
724724
725725
```html
726-
<script src="https://<your-cdn-host>.com/path/to/elastic-apm-rum.umd.min-<version>.js" crossorigin></script>
726+
<script src="<YOUR_URL>/path/to/elastic-apm-rum.umd.min-<VERSION>.js" crossorigin></script>
727727
<script>
728728
elasticApm.init({
729729
serviceName: '<instrumented-app>',
@@ -742,10 +742,10 @@ Loading the script asynchronously ensures the agent script will not block other
742742
var j = d.createElement(s),
743743
t = d.getElementsByTagName(s)[0]
744744
745-
j.src = 'https://<your-cdn-host>.com/path/to/elastic-apm-rum.umd.min-<version>.js'
745+
j.src = '<YOUR_URL>/path/to/elastic-apm-rum.umd.min-<VERSION>.js'
746746
j.onload = function() {elasticApm.init(c)}
747747
t.parentNode.insertBefore(j, t)
748-
})(document, 'script', {serviceName: '<instrumented-app>', serverUrl: '<apm-server-url>'})
748+
})(document, 'script', {serviceName: '<INSTRUMENTED_APP>', serverUrl: '<APM_SERVER_URL>'})
749749
</script>
750750
```
751751

solutions/observability/apm/configure-logstash-output.md

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

289289
```yaml
290290
output.logstash:
291-
hosts: ["logs.mycompany.com:5044"]
291+
hosts: ["<HOST_URL>:<PORT>"]
292292
ssl.certificate_authorities: ["/etc/ca.crt"]
293293
ssl.certificate: "/etc/client.crt"
294294
ssl.key: "/etc/client.key"
@@ -325,25 +325,25 @@ To use SSL mutual authentication:
325325
Before running APM Server, you should validate the {{ls}} server’s certificate. You can use `curl` to validate the certificate even though the protocol used to communicate with {{ls}} is not based on HTTP. For example:
326326

327327
```shell
328-
curl -v --cacert ca.crt https://logs.mycompany.com:5044
328+
curl -v --cacert ca.crt <HOST_URL>:<PORT>
329329
```
330330

331-
If the test is successful, you’ll receive an empty response error:
331+
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`:
332332

333333
```shell
334-
* Rebuilt URL to: https://logs.mycompany.com:5044/
334+
* Rebuilt URL to: https://logs.example.com:5044/
335335
* Trying 192.168.99.100...
336-
* Connected to logs.mycompany.com (192.168.99.100) port 5044 (#0)
336+
* Connected to logs.example.com (192.168.99.100) port 5044 (#0)
337337
* TLS 1.2 connection using TLS_DHE_RSA_WITH_AES_256_CBC_SHA
338-
* Server certificate: logs.mycompany.com
339-
* Server certificate: mycompany.com
338+
* Server certificate: logs.example.com
339+
* Server certificate: example.com
340340
> GET / HTTP/1.1
341-
> Host: logs.mycompany.com:5044
341+
> Host: logs.example.com:5044
342342
> User-Agent: curl/7.43.0
343343
> Accept: */*
344344
>
345345
* Empty reply from server
346-
* Connection #0 to host logs.mycompany.com left intact
346+
* Connection #0 to host logs.example.com left intact
347347
curl: (52) Empty reply from server
348348
```
349349

@@ -353,7 +353,7 @@ The following example uses the IP address rather than the hostname to validate t
353353
curl -v --cacert ca.crt https://192.168.99.100:5044
354354
```
355355

356-
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.
356+
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.
357357

358358
```shell
359359
* Rebuilt URL to: https://192.168.99.100:5044/

solutions/observability/apm/create-custom-links.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,5 +191,5 @@ This link opens more data on a specific `user.email`. It only appears on front-e
191191
| | |
192192
| --- | --- |
193193
| Label | `View user internally` |
194-
| Link | `https://internal-site.company.com/user/{{user.email}}` |
194+
| Link | `https://internal-site.example.com/user/{{user.email}}` |
195195
| Filters | `service.name:client` |

solutions/observability/apm/custom-filters.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Say you decide to [capture HTTP request bodies](/solutions/observability/apm/bui
6464

6565
```json
6666
{
67-
"email": "test@abc.com",
67+
"email": "test@example.com",
6868
"password": "hunter2"
6969
}
7070
```
@@ -206,7 +206,7 @@ POST _ingest/pipeline/apm_redacted_body_password/_simulate
206206
"http": {
207207
"request": {
208208
"body": {
209-
"original": """{"email": "test@abc.com", "password": "hunter2"}"""
209+
"original": """{"email": "test@example.com", "password": "hunter2"}"""
210210
}
211211
}
212212
}
@@ -249,7 +249,7 @@ The API response should be similar to this:
249249
"body" : {
250250
"original" : {
251251
"password" : "redacted",
252-
"email" : "test@abc.com"
252+
"email" : "test@example.com"
253253
}
254254
}
255255
}

solutions/observability/apm/elastic-apm-events-intake-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4428,7 +4428,7 @@ A request body example containing one event for all currently supported event ty
44284428
{"metadata":{"process":{"pid":1234,"title":"/usr/lib/jvm/java-10-openjdk-amd64/bin/java","ppid":1,"argv":["-v"]},"system":{"architecture":"amd64","detected_hostname":"8ec7ceb99074","configured_hostname":"host1","platform":"Linux","container":{"id":"8ec7ceb990749e79b37f6dc6cd3628633618d6ce412553a552a0fa6b69419ad4"},"kubernetes":{"namespace":"default","pod":{"uid":"b17f231da0ad128dc6c6c0b2e82f6f303d3893e3","name":"instrumented-java-service"},"node":{"name":"node-name"}}},"service":{"name":"1234_service-12a3","version":"4.3.0","node":{"configured_name":"8ec7ceb990749e79b37f6dc6cd3628633618d6ce412553a552a0fa6b69419ad4"},"environment":"production","language":{"name":"Java","version":"10.0.2"},"agent":{"version":"1.10.0","name":"java","ephemeral_id":"e71be9ac-93b0-44b9-a997-5638f6ccfc36"},"framework":{"name":"spring","version":"5.0.0"},"runtime":{"name":"Java","version":"10.0.2"}},"labels":{"group":"experimental","ab_testing":true,"segment":5}}}
44294429
{"error":{"id":"9876543210abcdeffedcba0123456789","timestamp":1571657444929001,"trace_id":"0123456789abcdeffedcba0123456789","parent_id":"9632587410abcdef","transaction_id":"1234567890987654","transaction":{"sampled":true,"type":"request"},"culprit":"opbeans.controllers.DTInterceptor.preHandle(DTInterceptor.java:73)","log":{"message":"Request method 'POST' not supported","param_message":"Request method 'POST' /events/:event not supported","logger_name":"http404","level":"error","stacktrace":[{"abs_path":"/tmp/Socket.java","filename":"Socket.java","classname":"Request::Socket","function":"connect","vars":{"key":"value"},"pre_context":["line1","line2"],"context_line":"line3","library_frame":true,"lineno":3,"module":"java.net","colno":4,"post_context":["line4","line5"]},{"filename":"SimpleBufferingClientHttpRequest.java","lineno":102,"function":"executeInternal","abs_path":"/tmp/SimpleBufferingClientHttpRequest.java","vars":{"key":"value"}}]},"exception":{"message":"Theusernamerootisunknown","type":"java.net.UnknownHostException","handled":true,"module":"org.springframework.http.client","code":42,"handled":false,"attributes":{"foo":"bar"},"cause":[{"type":"InternalDbError","message":"something wrong writing a file","cause":[{"type":"VeryInternalDbError","message":"disk spinning way too fast"},{"type":"ConnectionError","message":"on top of it,internet doesn't work"}]}],"stacktrace":[{"abs_path":"/tmp/AbstractPlainSocketImpl.java","filename":"AbstractPlainSocketImpl.java","function":"connect","vars":{"key":"value"},"pre_context":["line1","line2"],"context_line":"3","library_frame":true,"lineno":3,"module":"java.net","colno":4,"post_context":["line4","line5"]},{"filename":"AbstractClientHttpRequest.java","lineno":102,"function":"execute","vars":{"key":"value"}}]},"context":{"request":{"socket":{"remote_address":"12.53.12.1","encrypted":true},"http_version":"1.1","method":"POST","url":{"protocol":"https:","full":"https://www.example.com/p/a/t/h?query=string#hash","hostname":"www.example.com","port":8080,"pathname":"/p/a/t/h","search":"?query=string","hash":"#hash","raw":"/p/a/t/h?query=string#hash"},"headers":{"Forwarded": "for=192.168.0.1", "host":"opbeans-java:3000","content-length":"0","cookie":["c1=v1","c2=v2"],"Elastic-Apm-Traceparent":"00-8c21b4b556467a0b17ae5da959b5f388-31301f1fb2998121-01"},"cookies":{"c1":"v1","c2":"v2"},"env":{"SERVER_SOFTWARE":"nginx","GATEWAY_INTERFACE":"CGI/1.1"},"body":"HelloWorld"},"response":{"status_code":200,"headers":{"content-type":"application/json"},"headers_sent":true,"finished":true},"user":{"id":99,"username":"foo","email":"[email protected]"},"tags":{"organization_uuid":"9f0e9d64-c185-4d21-a6f4-4673ed561ec8"},"custom":{"my_key":1,"some_other_value":"foobar","and_objects":{"foo":["bar","baz"]}},"service":{"name":"service1","node":{"configured_name":"node-xyz"},"language":{"version":"1.2"},"framework":{"version":"1","name":"Node"}}}}}
44304430
{"span":{"timestamp":1571657444929001,"type":"external","subtype":"http","id":"1234567890aaaade","transaction_id":"1234567890987654","trace_id":"abcdef0123456789abcdef9876543210","parent_id":"abcdef0123456789","action":"connect","sync":true,"name":"GET users-authenticated", "duration":3.781912,"stacktrace":[{"filename":"DispatcherServlet.java","lineno":547},{"function":"render","abs_path":"/tmp/AbstractView.java","filename":"AbstractView.java","lineno":547,"library_frame":true,"vars":{"key":"value"},"module":"org.springframework.web.servlet.view","colno":4,"context_line":"line3"}],"context":{"db":{"instance":"customers","statement":"SELECT * FROM product_types WHERE user_id = ?","type":"sql","user":"postgres","link":"other.db.com"},"http":{"url":"http://localhost:8000","status_code":302,"method":"GET","response":{"status_code":200,"transfer_size":300.12,"encoded_body_size":356,"decoded_body_size":401,"headers":{"content-type":"application/json"}}},"service":{"name":"opbeans-java-1","agent":{"version":"1.10.0-SNAPSHOT","name":"java","ephemeral_id":"e71be9ac-93b0-44b9-a997-5638f6ccfc36"}}}}}
4431-
{"transaction":{"timestamp":1571657444929001,"name":"ResourceHttpRequestHandler","type":"http","id":"4340a8e0df1906ecbfa9","trace_id":"0acd456789abcdef0123456789abcdef","parent_id":"abcdefabcdef01234567","span_count":{"started":17,"dropped":0},"duration":32.592981,"result":"HTTP2xx","sampled":true,"context":{"service":{"name":"experimental-java","agent":{"version":"1.10.0-SNAPSHOT","ephemeral_id":"e71be9ac-93b0-44b9-a997-5638f6ccfc36"}},"request":{"socket":{"remote_address":"12.53.12.1:8080","encrypted":true},"http_version":"1.1","method":"POST","url":{"protocol":"https:","full":"https://www.example.com/p/a/t/h?query=string#hash","hostname":"www.example.com","port":"8080","pathname":"/p/a/t/h","search":"?query=string","hash":"#hash","raw":"/p/a/t/h?query=string#hash"},"headers":{"user-agent":["Mozilla/5.0(Macintosh;IntelMacOSX10_10_5)AppleWebKit/537.36(KHTML,likeGecko)Chrome/51.0.2704.103Safari/537.36","MozillaChromeEdge"],"content-type":"text/html","cookie":"c1=v1,c2=v2","Elastic-Apm-Traceparent":["00-33a0bd4cceff0370a7c57d807032688e-69feaabc5b88d7e8-01"]},"cookies":{"c1":"v1","c2":"v2"},"env":{"SERVER_SOFTWARE":"nginx","GATEWAY_INTERFACE":"CGI/1.1"},"body":{"string":"helloworld","additional":{"foo":{},"bar":123,"req":"additionalinformation"}}},"response":{"status_code":200,"transfer_size":300,"encoded_body_size":356.90,"decoded_body_size":401.90,"headers":{"content-type":"application/json"},"headers_sent":true,"finished":true}, "user":{"id":"99","username":"foo","email":"[email protected]"},"tags":{"organization_uuid":"9f0e9d64-c185-4d21-a6f4-4673ed561ec8","tag5":null},"custom":{"my_key":1,"some_other_value":"foobar","and_objects":{"foo":["bar","baz"]},"(":"notavalidregexandthatisfine"}}}}
4431+
{"transaction":{"timestamp":1571657444929001,"name":"ResourceHttpRequestHandler","type":"http","id":"4340a8e0df1906ecbfa9","trace_id":"0acd456789abcdef0123456789abcdef","parent_id":"abcdefabcdef01234567","span_count":{"started":17,"dropped":0},"duration":32.592981,"result":"HTTP2xx","sampled":true,"context":{"service":{"name":"experimental-java","agent":{"version":"1.10.0-SNAPSHOT","ephemeral_id":"e71be9ac-93b0-44b9-a997-5638f6ccfc36"}},"request":{"socket":{"remote_address":"12.53.12.1:8080","encrypted":true},"http_version":"1.1","method":"POST","url":{"protocol":"https:","full":"https://www.example.com/p/a/t/h?query=string#hash","hostname":"www.example.com","port":"8080","pathname":"/p/a/t/h","search":"?query=string","hash":"#hash","raw":"/p/a/t/h?query=string#hash"},"headers":{"user-agent":["Mozilla/5.0(Macintosh;IntelMacOSX10_10_5)AppleWebKit/537.36(KHTML,likeGecko)Chrome/51.0.2704.103Safari/537.36","MozillaChromeEdge"],"content-type":"text/html","cookie":"c1=v1,c2=v2","Elastic-Apm-Traceparent":["00-33a0bd4cceff0370a7c57d807032688e-69feaabc5b88d7e8-01"]},"cookies":{"c1":"v1","c2":"v2"},"env":{"SERVER_SOFTWARE":"nginx","GATEWAY_INTERFACE":"CGI/1.1"},"body":{"string":"helloworld","additional":{"foo":{},"bar":123,"req":"additionalinformation"}}},"response":{"status_code":200,"transfer_size":300,"encoded_body_size":356.90,"decoded_body_size":401.90,"headers":{"content-type":"application/json"},"headers_sent":true,"finished":true}, "user":{"id":"99","username":"foo","email":"[email protected]"},"tags":{"organization_uuid":"9f0e9d64-c185-4d21-a6f4-4673ed561ec8","tag5":null},"custom":{"my_key":1,"some_other_value":"foobar","and_objects":{"foo":["bar","baz"]},"(":"notavalidregexandthatisfine"}}}}
44324432
{"metricset":{"samples":{"transaction.breakdown.count":{"value":12},"transaction.duration.sum.us":{"value":12},"transaction.duration.count":{"value":2},"transaction.self_time.sum.us":{"value":10},"transaction.self_time.count":{"value":2},"span.self_time.count":{"value":1},"span.self_time.sum.us":{"value":633.288},"byte_counter":{"value":1},"short_counter":{"value":227},"integer_gauge":{"value":42767},"long_gauge":{"value":3147483648},"float_gauge":{"value":9.16},"double_gauge":{"value":3.141592653589793},"dotted.float.gauge":{"value":6.12},"negative.d.o.t.t.e.d":{"value":-1022}},"tags":{"code":200,"success":true},"transaction":{"type":"request","name":"GET/"},"span":{"type":"db","subtype":"mysql"},"timestamp":1571657444929001}}
44334433
```
44344434

solutions/observability/apm/use-internal-collection-to-send-monitoring-data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Use internal collectors to send {{beats}} monitoring data directly to your monit
4343
enabled: true
4444
cluster_uuid: PRODUCTION_ES_CLUSTER_UUID <1>
4545
elasticsearch:
46-
hosts: ["https://example.com:9200", "https://example2.com:9200"] <2>
46+
hosts: ["<HOST_URL_1>:<PORT_1>", "<HOST_URL_2>:<PORT_2>"] <2>
4747
api_key: id:api_key <3>
4848
username: apm_system
4949
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"

solutions/observability/synthetics/configure-lightweight-monitors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ $$$monitor-http-proxy_url$$$
403403
**Example**:
404404

405405
```yaml
406-
http://proxy.mydomain.com:3128
406+
http://proxy.example.com:3128
407407
```
408408

409409
$$$monitor-http-username$$$
@@ -496,7 +496,7 @@ check.request:
496496
headers:
497497
'Content-Type': 'application/x-www-form-urlencoded'
498498
# urlencode the body:
499-
body: "name=first&email=someemail%40someemailprovider.com"
499+
body: "name=first&email=someemail%40example.com"
500500
```
501501

502502
**`response`**

0 commit comments

Comments
 (0)