Skip to content

Commit 8b00809

Browse files
author
Docs User
committed
Updated docs
1 parent f2ea01d commit 8b00809

12 files changed

+7022
-6879
lines changed

‎html/branches.yaml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,31 +43,31 @@ apm-server:
4343
APM Overview/docs/guide/6.4: 2c112e1ee1907993e56094cd8185ad23c1d74321
4444
APM Overview/docs/guide/6.5: 3e348a2829202cfda809015795b7f874f86a653f
4545
APM Overview/docs/guide/6.6: d0067eb4cdde38b763c285ee942c880eb3400896
46-
APM Overview/docs/guide/master: d6cfefccde2e998a2e8709e4bb1178ccf7fe32ee
47-
APM Overview/docs/master: d6cfefccde2e998a2e8709e4bb1178ccf7fe32ee
46+
APM Overview/docs/guide/master: 4d73d4f866e83600b43c9068e28fbe15d875dd9f
47+
APM Overview/docs/master: 4d73d4f866e83600b43c9068e28fbe15d875dd9f
4848
APM Server Reference/CHANGELOG.asciidoc/6.0: ae191ba5dd9c07cd567cf3f55e7e1433902fb9fc
4949
APM Server Reference/CHANGELOG.asciidoc/6.1: e5bfd57830cfe07435a1ad057fc61116e6357a06
5050
APM Server Reference/CHANGELOG.asciidoc/6.2: 9cdb11b74e761c7b5b0a6faae0195f591f57f106
5151
APM Server Reference/CHANGELOG.asciidoc/6.3: b485c1fe12dcfd9197f3541789aedb2887c14482
5252
APM Server Reference/CHANGELOG.asciidoc/6.4: 2c112e1ee1907993e56094cd8185ad23c1d74321
5353
APM Server Reference/CHANGELOG.asciidoc/6.5: 3e348a2829202cfda809015795b7f874f86a653f
5454
APM Server Reference/CHANGELOG.asciidoc/6.6: d0067eb4cdde38b763c285ee942c880eb3400896
55-
APM Server Reference/CHANGELOG.asciidoc/master: d6cfefccde2e998a2e8709e4bb1178ccf7fe32ee
55+
APM Server Reference/CHANGELOG.asciidoc/master: 4d73d4f866e83600b43c9068e28fbe15d875dd9f
5656
APM Server Reference/changelogs/6.1: e5bfd57830cfe07435a1ad057fc61116e6357a06
5757
APM Server Reference/changelogs/6.2: 9cdb11b74e761c7b5b0a6faae0195f591f57f106
5858
APM Server Reference/changelogs/6.3: b485c1fe12dcfd9197f3541789aedb2887c14482
5959
APM Server Reference/changelogs/6.4: 2c112e1ee1907993e56094cd8185ad23c1d74321
6060
APM Server Reference/changelogs/6.5: 3e348a2829202cfda809015795b7f874f86a653f
6161
APM Server Reference/changelogs/6.6: d0067eb4cdde38b763c285ee942c880eb3400896
62-
APM Server Reference/changelogs/master: d6cfefccde2e998a2e8709e4bb1178ccf7fe32ee
62+
APM Server Reference/changelogs/master: 4d73d4f866e83600b43c9068e28fbe15d875dd9f
6363
APM Server Reference/docs/6.0: ae191ba5dd9c07cd567cf3f55e7e1433902fb9fc
6464
APM Server Reference/docs/6.1: e5bfd57830cfe07435a1ad057fc61116e6357a06
6565
APM Server Reference/docs/6.2: 9cdb11b74e761c7b5b0a6faae0195f591f57f106
6666
APM Server Reference/docs/6.3: b485c1fe12dcfd9197f3541789aedb2887c14482
6767
APM Server Reference/docs/6.4: 2c112e1ee1907993e56094cd8185ad23c1d74321
6868
APM Server Reference/docs/6.5: 3e348a2829202cfda809015795b7f874f86a653f
6969
APM Server Reference/docs/6.6: d0067eb4cdde38b763c285ee942c880eb3400896
70-
APM Server Reference/docs/master: d6cfefccde2e998a2e8709e4bb1178ccf7fe32ee
70+
APM Server Reference/docs/master: 4d73d4f866e83600b43c9068e28fbe15d875dd9f
7171
azure-marketplace:
7272
Deploying with Azure Marketplace and Resource Manager (ARM) template/docs/6.3: 8fe06fb96d2031e7ee16cdd2c65a2f697e2549a6
7373
Deploying with Azure Marketplace and Resource Manager (ARM) template/docs/6.4: f2f92ae83a316796797cabbf00b50ccdce5ab3cb
@@ -1101,7 +1101,7 @@ logstash:
11011101
Logstash Reference/docs/6.1: a127e7ac7dadfa919003fd21fcc24316e96405a1
11021102
Logstash Reference/docs/6.2: 891e88edb9c47e5912c69fccb8f480cda7fc34b9
11031103
Logstash Reference/docs/6.3: 07ddd85e47efad04ab19b5c399eb942593e6c6c9
1104-
Logstash Reference/docs/6.4: bbf92053115ae06c1227350724cae5659e0006b8
1104+
Logstash Reference/docs/6.4: 269d10a924753f8d623f610e99d01e73b36ea856
11051105
Logstash Reference/docs/6.5: f290dfbd51ed1a79e96022a4b59dbeba1a367736
11061106
Logstash Reference/docs/6.6: 17f177dd4326aafa279b2e654cb736521503df58
11071107
Logstash Reference/docs/6.x: a3c9c71f61041fe9ec277370bbedac32a9607464
@@ -1127,8 +1127,8 @@ logstash-docs:
11271127
Logstash Reference/docs/6.0: d0b35f4397b537c5ad71999c17f922eb6cb84383
11281128
Logstash Reference/docs/6.1: b645260c95005ac18b0566a19352bca3b73fbc1b
11291129
Logstash Reference/docs/6.2: 189584805c285569fdfe404c2deba30fc56bb7f2
1130-
Logstash Reference/docs/6.3: a821083254b615d62449e1170f10e5268059a215
1131-
Logstash Reference/docs/6.4: 5b382820a1b90eb4132d482392ba195c05cbaf5e
1130+
Logstash Reference/docs/6.3: 321e4f695681431fda47e0628fd3bf13cd3e32e9
1131+
Logstash Reference/docs/6.4: ce200bd2a6264e631d90058fb4775c513fbd626e
11321132
Logstash Reference/docs/6.5: 8d762c7e4f94cb9e50d772c99f67d631c3613f84
11331133
Logstash Reference/docs/6.6: 6c9d943cc0bb996ca6cae432ec01dfabf0a6f16a
11341134
Logstash Reference/docs/6.x: 6c9d943cc0bb996ca6cae432ec01dfabf0a6f16a

‎html/en/apm/server/master/error-indices.html‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -715,6 +715,9 @@ <h2 class="page-title">Guide template</h2>
715715
"name": "elastic-node",
716716
"version": "3.14.0"
717717
},
718+
"container": {
719+
"id": "container-id"
720+
},
718721
"context": {
719722
"custom": {
720723
"and_objects": {
@@ -927,6 +930,16 @@ <h2 class="page-title">Guide template</h2>
927930
"platform": "darwin"
928931
}
929932
},
933+
"kubernetes": {
934+
"namespace": "namespace1",
935+
"node": {
936+
"name": "node-name"
937+
},
938+
"pod": {
939+
"name": "pod-name",
940+
"uid": "pod-uid"
941+
}
942+
},
930943
"process": {
931944
"args": [
932945
"node",
@@ -971,6 +984,9 @@ <h2 class="page-title">Guide template</h2>
971984
"name": "elastic-node",
972985
"version": "3.14.0"
973986
},
987+
"container": {
988+
"id": "container-id"
989+
},
974990
"error": {
975991
"exception": {
976992
"message": "Cannot read property 'baz' no defined"
@@ -986,6 +1002,16 @@ <h2 class="page-title">Guide template</h2>
9861002
"platform": "darwin"
9871003
}
9881004
},
1005+
"kubernetes": {
1006+
"namespace": "namespace1",
1007+
"node": {
1008+
"name": "node-name"
1009+
},
1010+
"pod": {
1011+
"name": "pod-name",
1012+
"uid": "pod-uid"
1013+
}
1014+
},
9891015
"process": {
9901016
"args": [
9911017
"node",
@@ -1031,6 +1057,9 @@ <h2 class="page-title">Guide template</h2>
10311057
"name": "elastic-node",
10321058
"version": "3.14.0"
10331059
},
1060+
"container": {
1061+
"id": "container-id"
1062+
},
10341063
"error": {
10351064
"exception": {
10361065
"type": "DbError"
@@ -1046,6 +1075,16 @@ <h2 class="page-title">Guide template</h2>
10461075
"platform": "darwin"
10471076
}
10481077
},
1078+
"kubernetes": {
1079+
"namespace": "namespace1",
1080+
"node": {
1081+
"name": "node-name"
1082+
},
1083+
"pod": {
1084+
"name": "pod-name",
1085+
"uid": "pod-uid"
1086+
}
1087+
},
10491088
"process": {
10501089
"args": [
10511090
"node",
@@ -1091,6 +1130,9 @@ <h2 class="page-title">Guide template</h2>
10911130
"name": "elastic-node",
10921131
"version": "3.14.0"
10931132
},
1133+
"container": {
1134+
"id": "container-id"
1135+
},
10941136
"error": {
10951137
"grouping_key": "d6b3f958dfea98dc9ed2b57d5f0c48bb",
10961138
"id": "abcdef0123456789",
@@ -1107,6 +1149,16 @@ <h2 class="page-title">Guide template</h2>
11071149
"platform": "darwin"
11081150
}
11091151
},
1152+
"kubernetes": {
1153+
"namespace": "namespace1",
1154+
"node": {
1155+
"name": "node-name"
1156+
},
1157+
"pod": {
1158+
"name": "pod-name",
1159+
"uid": "pod-uid"
1160+
}
1161+
},
11101162
"parent": {
11111163
"id": "9632587410abcdef"
11121164
},

‎html/en/apm/server/master/example-intake-events.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ <h2 class="page-title">Guide template</h2>
707707

708708
<a href="sourcemap-api.html">Sourcemap Upload API
709709
 »
710-
</a></span></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="example-intake-events"></a>Example Request Body<a href="https://github.com/elastic/apm-server/edit/master/docs/example-intake-events.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h2></div></div></div><p>See a request body example containing one event for all currently supported event types.</p><div class="pre_wrapper"><pre class="programlisting prettyprint lang-json">{"metadata": {"process": {"pid": 1234}, "service": {"name": "1234_service-12a3", "language": {"name": "ecmascript"}, "agent": {"version": "3.14.0", "name": "elastic-node"}, "framework": {"name": "emac"}}}}
710+
</a></span></div><div class="section"><div class="titlepage"><div><div><h2 class="title"><a id="example-intake-events"></a>Example Request Body<a href="https://github.com/elastic/apm-server/edit/master/docs/example-intake-events.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h2></div></div></div><p>See a request body example containing one event for all currently supported event types.</p><div class="pre_wrapper"><pre class="programlisting prettyprint lang-json">{"metadata": {"process": {"pid": 1234}, "system": {"container": {"id": "container-id"}, "kubernetes": {"namespace": "namespace1", "pod": {"uid": "pod-uid", "name": "pod-name"}, "node": {"name": "node-name"}}}, "service": {"name": "1234_service-12a3", "language": {"name": "ecmascript"}, "agent": {"version": "3.14.0", "name": "elastic-node"}, "framework": {"name": "emac"}}}}
711711
{"error": {"id": "abcdef0123456789", "timestamp": 1533827045999000, "log": {"level": "custom log level","message": "Cannot read property 'baz' of undefined"}}}
712712
{"span": {"id": "0123456a89012345", "trace_id": "0123456789abcdef0123456789abcdef", "parent_id": "ab23456a89012345", "transaction_id": "ab23456a89012345", "parent": 1, "name": "GET /api/types", "type": "request", "start": 1.845, "duration": 3.5642981, "stacktrace": [], "context": {}}}
713713
{"transaction": {"trace_id": "01234567890123456789abcdefabcdef", "id": "abcdef1478523690", "type": "request", "duration": 32.592981, "timestamp": 1535655207154000, "result": "200", "context": null, "spans": null, "sampled": null, "span_count": {"started": 0}}}

‎html/en/apm/server/master/exported-fields-apm.html‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -773,7 +773,17 @@ <h2 class="page-title">Guide template</h2>
773773
<span class="strong strong"><strong><code class="literal">agent.name</code></strong></span>
774774
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">Name of the agent used.</p></dd><dt><span class="term">
775775
<span class="strong strong"><strong><code class="literal">agent.version</code></strong></span>
776-
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">Version of the agent used.</p></dd></dl></div><h2><a id="_host_fields"></a>host fields<a href="https://github.com/elastic/apm-server/edit/master/docs/fields.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h2><p>Optional host fields.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
776+
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">Version of the agent used.</p></dd></dl></div><h2><a id="_container_fields"></a>container fields<a href="https://github.com/elastic/apm-server/edit/master/docs/fields.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h2><p>Container fields are used for meta information about the specific container that is the source of information. These fields help correlate data based containers from any runtime.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
777+
<span class="strong strong"><strong><code class="literal">container.id</code></strong></span>
778+
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">Unique container id.</p></dd></dl></div><h2><a id="_kubernetes_fields"></a>kubernetes fields<a href="https://github.com/elastic/apm-server/edit/master/docs/fields.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h2><p>Kubernetes metadata added by the kubernetes processor</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
779+
<span class="strong strong"><strong><code class="literal">kubernetes.namespace</code></strong></span>
780+
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">Kubernetes namespace</p></dd><dt><span class="term">
781+
<span class="strong strong"><strong><code class="literal">kubernetes.node.name</code></strong></span>
782+
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">Kubernetes node name</p></dd><dt><span class="term">
783+
<span class="strong strong"><strong><code class="literal">kubernetes.pod.name</code></strong></span>
784+
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">Kubernetes pod name</p></dd><dt><span class="term">
785+
<span class="strong strong"><strong><code class="literal">kubernetes.pod.uid</code></strong></span>
786+
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">Kubernetes Pod UID</p></dd></dl></div><h2><a id="_host_fields"></a>host fields<a href="https://github.com/elastic/apm-server/edit/master/docs/fields.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h2><p>Optional host fields.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
777787
<span class="strong strong"><strong><code class="literal">host.architecture</code></strong></span>
778788
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">The architecture of the host the event was recorded on.</p></dd><dt><span class="term">
779789
<span class="strong strong"><strong><code class="literal">host.hostname</code></strong></span>

‎html/en/apm/server/master/exported-fields-ecs.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -785,7 +785,7 @@ <h2 class="page-title">Guide template</h2>
785785
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">example: t2.medium</p><p class="simpara">Machine type of the host machine.</p></dd><dt><span class="term">
786786
<span class="strong strong"><strong><code class="literal">cloud.account.id</code></strong></span>
787787
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">example: 666777888999</p><p class="simpara">The cloud account or organization id used to identify different entities in a multi-tenant environment.
788-
Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.</p></dd></dl></div><h2><a id="_container_fields"></a>container fields<a href="https://github.com/elastic/apm-server/edit/master/docs/fields.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h2><p>Container fields are used for meta information about the specific container that is the source of information. These fields help correlate data based containers from any runtime.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
788+
Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.</p></dd></dl></div><h2><a id="_container_fields_2"></a>container fields<a href="https://github.com/elastic/apm-server/edit/master/docs/fields.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h2><p>Container fields are used for meta information about the specific container that is the source of information. These fields help correlate data based containers from any runtime.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
789789
<span class="strong strong"><strong><code class="literal">container.runtime</code></strong></span>
790790
</span></dt><dd><p class="simpara">type: keyword</p><p class="simpara">example: docker</p><p class="simpara">Runtime managing this container.</p></dd><dt><span class="term">
791791
<span class="strong strong"><strong><code class="literal">container.id</code></strong></span>

‎html/en/apm/server/master/metadata-api.html‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -869,6 +869,48 @@ <h2 class="page-title">Guide template</h2>
869869
"description": "Name of the system platform the agent is running on.",
870870
"type": ["string", "null"],
871871
"maxLength": 1024
872+
},
873+
"container": {
874+
"properties": {
875+
"id" : {
876+
"description": "Container ID",
877+
"type": ["string"],
878+
"maxLength": 1024
879+
}
880+
},
881+
"required": ["id"]
882+
},
883+
"kubernetes": {
884+
"properties": {
885+
"namespace": {
886+
"description": "Kubernetes namespace",
887+
"type": ["string", "null"],
888+
"maxLength": 1024
889+
},
890+
"pod":{
891+
"properties": {
892+
"name": {
893+
"description": "Kubernetes pod name",
894+
"type": ["string", "null"],
895+
"maxLength": 1024
896+
},
897+
"uid": {
898+
"description": "Kubernetes pod uid",
899+
"type": ["string", "null"],
900+
"maxLength": 1024
901+
}
902+
}
903+
},
904+
"node":{
905+
"properties": {
906+
"name": {
907+
"description": "Kubernetes node name",
908+
"type": ["string", "null"],
909+
"maxLength": 1024
910+
}
911+
}
912+
}
913+
}
872914
}
873915
}
874916
}</pre></div><h5><a id="metadata-user-schema"></a>User Schema<a href="https://github.com/elastic/apm-server/edit/master/docs/metadata-api.asciidoc" class="edit_me" title="Edit this page on GitHub" rel="nofollow">edit</a></h5><div class="pre_wrapper"><pre class="programlisting prettyprint lang-json">{

0 commit comments

Comments
 (0)