Updated docs

Author: Docs User

html/branches.yaml

@@ -8,7 +8,7 @@ apm-agent-python:
 apm-server:
   APM Server Reference/docs/6.0: f969145ae1d8cd8b2758b2a40e09bafe1224508d
   APM Server Reference/docs/6.1: e14c89a7ef072aeae28785839c0be4a53ce4b75e
-  APM Server Reference/docs/master: cef42849d432e73c4d543a7efa6fff2c6c313b0e
+  APM Server Reference/docs/master: 75c0e67ead2e3d8958b675ed4502eceb62b8c93c
   Getting Started with Elastic APM/docs/guide/6.0: f969145ae1d8cd8b2758b2a40e09bafe1224508d
   Getting Started with Elastic APM/docs/guide/6.1: e14c89a7ef072aeae28785839c0be4a53ce4b75e
   Getting Started with Elastic APM/docs/guide/master: cef42849d432e73c4d543a7efa6fff2c6c313b0e

html/en/apm/server/master/error-api.html

@@ -672,15 +672,16 @@ <h2 class="page-title">Guide template</h2>
             "type": ["string", "null"]
         },
         "exception": {
-            "description": "A standard exception.",
+            "description": "Information about the originally thrown error.",
             "type": ["object", "null"],
             "properties": {
                 "code": {
                     "type": ["string", "number", "null"],
-                    "maxLength": 1024
+                    "maxLength": 1024,
+                    "description": "The error code set when the error happened, e.g. database error code."
                 },
                 "message": {
-                   "description": "The exception's error message.",
+                   "description": "The original error message.",
                    "type": "string"
                 },
                 "module": {
@@ -703,7 +704,8 @@ <h2 class="page-title">Guide template</h2>
                     "maxLength": 1024
                 },
                 "uncaught": {
-                    "type": ["boolean", "null"]
+                    "type": ["boolean", "null"],
+                    "description": "Indicator whether the error was caught somewhere in the code or not."
                 }
             },
             "required": ["message"]
@@ -715,26 +717,27 @@ <h2 class="page-title">Guide template</h2>
         },
         "log": {
             "type": ["object", "null"],
+            "description": "Additional information added when logging the error.",
             "properties": {
                 "level": {
-                    "description": "The record severity.",
+                    "description": "The severity of the record.",
                     "type": ["string", "null"],
                     "default": "error",
                     "enum": ["debug", "info", "warning", "error", "fatal", null],
                     "maxLength": 1024
                 },
                 "logger_name": {
-                    "description": "The name of the logger which created the record.",
+                    "description": "The name of the logger instance used.",
                     "type": ["string", "null"],
                     "default": "default",
                     "maxLength": 1024
                 },
                 "message": {
-                    "description": "The exception's error message.",
+                    "description": "The additionally logged error message.",
                     "type": "string"
                 },
                 "param_message": {
-                    "description": "A parametrized message. E.g. Could not connect to %s. The property message is still required, and should be equal to the param_message, but with placeholders replaced. In some situations the param_message is used to group errors together. The string is not interpreted, so feel free to use whichever placeholders makes sense in the client languange.",
+                    "description": "A parametrized message. E.g. 'Could not connect to %s'. The property message is still required, and should be equal to the param_message, but with placeholders replaced. In some situations the param_message is used to group errors together. The string is not interpreted, so feel free to use whichever placeholders makes sense in the client languange.",
                     "type": ["string", "null"],
                     "maxLength": 1024
 
@@ -794,7 +797,7 @@ <h2 class="page-title">Guide template</h2>
             "minItems": 0
         },
         "framework": {
-            "description": "Name and version of the used web framework",
+            "description": "Name and version of the web framework used",
             "type": ["object", "null"],
             "properties": {
                 "name": {
@@ -809,7 +812,7 @@ <h2 class="page-title">Guide template</h2>
             "required": ["name", "version"]
         },
         "language": {
-            "description": "Name and version of the used programming language",
+            "description": "Name and version of the programming language used",
             "type": ["object", "null"],
             "properties": {
                 "name": {
@@ -906,7 +909,7 @@ <h2 class="page-title">Guide template</h2>
             "type": ["object", "null"],
             "properties": {
                 "finished": {
-                    "description": "A boolean indicating the the response was finished",
+                    "description": "A boolean indicating whether the response was finished or not",
                     "type": ["boolean", "null"]
                 },
                 "headers": {
@@ -932,7 +935,7 @@ <h2 class="page-title">Guide template</h2>
         },
         "tags": {
             "type": ["object", "null"],
-            "description": "A flat mapping of tags with values.",
+            "description": "A flat mapping of user-defined tags with values.",
             "regexProperties": true,
             "patternProperties": {
                 "^[^.*\"]*$": {
@@ -1062,22 +1065,27 @@ <h2 class="page-title">Guide template</h2>
             "properties": {
                 "raw": {
                     "type": ["string", "null"],
+                    "description": "The raw, unparsed URL of the request, e.g https://example.com:443/search?q=elasticsearch#top.",
                     "maxLength": 1024
                 },
                 "protocol": {
                     "type": ["string", "null"],
+                    "description": "The protocol of the request, e.g. 'https:'.",
                     "maxLength": 1024
                 },
                 "hostname": {
                     "type": ["string", "null"],
+                    "description": "The hostname of the request, e.g. 'example.com'.",
                     "maxLength": 1024
                 },
                 "port": {
                     "type": ["string", "null"],
+                    "description": "The port of the request, e.g. '443'",
                     "maxLength": 1024
                 },
                 "pathname": {
                     "type": ["string", "null"],
+                    "description": "The path of the request, e.g. '/search'",
                     "maxLength": 1024
                 },
                 "search": {
@@ -1087,6 +1095,7 @@ <h2 class="page-title">Guide template</h2>
                 },
                 "hash": {
                     "type": ["string", "null"],
+                    "description": "The hash of the request URL, e.g. 'top'",
                     "maxLength": 1024
                 }
             }
@@ -1105,12 +1114,12 @@ <h2 class="page-title">Guide template</h2>
     "type": ["object", "null"],
     "properties": {
         "id": {
-            "description": "An id, identifying the logged in user, e.g. the primary key of the user",
+            "description": "Identifier of the logged in user, e.g. the primary key of the user",
             "type": ["string", "number", "null"],
             "maxLength": 1024
         },
         "email": {
-            "description": "The email address of the logged in user",
+            "description": "Email of the logged in user",
             "type": ["string", "null"],
             "maxLength": 1024
         },

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

@@ -613,7 +613,7 @@ <h2 class="page-title">Guide template</h2>
 
           <a href="exported-fields-apm-sourcemap.html">APM Sourcemap fields
                »
-            </a></span></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="exported-fields-apm-error"></a>APM Error 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></div></div></div><p>Error-specific data for APM</p><h3><a id="_literal_view_errors_literal"></a><code class="literal">view errors</code><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></h3><p>type: keyword</p><p>format: url</p><h3><a id="_literal_error_id_icon_literal"></a><code class="literal">error id icon</code><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></h3><p>type: keyword</p><p>format: url</p><h3><a id="_literal_error_id_literal"></a><code class="literal">error.id</code><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></h3><p>type: keyword</p><p>A UUID4 error ID.</p><h3><a id="_literal_error_culprit_literal"></a><code class="literal">error.culprit</code><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></h3><p>type: text</p><p>Function call which was the primary perpetrator of this event.</p><h3><a id="_literal_error_grouping_key_literal"></a><code class="literal">error.grouping_key</code><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></h3><p>type: keyword</p><p>format: url</p><p>GroupingKey of the logged error for use in grouping.</p><h2><a id="_exception_fields"></a>exception 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>Information about the originally thrown error.</p><h3><a id="_literal_error_exception_code_literal"></a><code class="literal">error.exception.code</code><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></h3><p>type: keyword</p><p>The error code set when the error happened, e.g. database error code.</p><h3><a id="_literal_error_exception_message_literal"></a><code class="literal">error.exception.message</code><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></h3><p>type: text</p><p>The original error message.</p><h3><a id="_literal_error_exception_module_literal"></a><code class="literal">error.exception.module</code><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></h3><p>type: keyword</p><p>The module namespace of the original error.</p><h3><a id="_literal_error_exception_type_literal"></a><code class="literal">error.exception.type</code><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></h3><p>type: keyword</p><h3><a id="_literal_error_exception_uncaught_literal"></a><code class="literal">error.exception.uncaught</code><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></h3><p>type: boolean</p><p>Indicator whether the error was caught somewhere in the code or not.</p><h2><a id="_log_fields"></a>log 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>Additional information added by logging the error.</p><h3><a id="_literal_error_log_level_literal"></a><code class="literal">error.log.level</code><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></h3><p>type: keyword</p><p>The severity of the record.</p><h3><a id="_literal_error_log_logger_name_literal"></a><code class="literal">error.log.logger_name</code><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></h3><p>type: keyword</p><p>The name of the used logger instance.</p><h3><a id="_literal_error_log_message_literal"></a><code class="literal">error.log.message</code><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></h3><p>type: text</p><p>The additionally logged error message.</p><h3><a id="_literal_error_log_param_message_literal"></a><code class="literal">error.log.param_message</code><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></h3><p>type: keyword</p><p>Equal to message, but with placeholders replaced.</p></div><div class="navfooter"><span class="prev"><a href="exported-fields-apm.html">
+            </a></span></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="exported-fields-apm-error"></a>APM Error 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></div></div></div><p>Error-specific data for APM</p><h3><a id="_literal_view_errors_literal"></a><code class="literal">view errors</code><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></h3><p>type: keyword</p><p>format: url</p><h3><a id="_literal_error_id_icon_literal"></a><code class="literal">error id icon</code><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></h3><p>type: keyword</p><p>format: url</p><h2><a id="_error_fields"></a>error 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>Data captured by an agent representing an event occurring in a monitored service.</p><h3><a id="_literal_error_id_literal"></a><code class="literal">error.id</code><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></h3><p>type: keyword</p><p>A UUID for the error.</p><h3><a id="_literal_error_culprit_literal"></a><code class="literal">error.culprit</code><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></h3><p>type: text</p><p>Function call which was the primary perpetrator of this event.</p><h3><a id="_literal_error_grouping_key_literal"></a><code class="literal">error.grouping_key</code><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></h3><p>type: keyword</p><p>format: url</p><p>GroupingKey of the logged error for use in grouping.</p><h2><a id="_exception_fields"></a>exception 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>Information about the originally thrown error.</p><h3><a id="_literal_error_exception_code_literal"></a><code class="literal">error.exception.code</code><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></h3><p>type: keyword</p><p>The error code set when the error happened, e.g. database error code.</p><h3><a id="_literal_error_exception_message_literal"></a><code class="literal">error.exception.message</code><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></h3><p>type: text</p><p>The original error message.</p><h3><a id="_literal_error_exception_module_literal"></a><code class="literal">error.exception.module</code><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></h3><p>type: keyword</p><p>The module namespace of the original error.</p><h3><a id="_literal_error_exception_type_literal"></a><code class="literal">error.exception.type</code><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></h3><p>type: keyword</p><h3><a id="_literal_error_exception_uncaught_literal"></a><code class="literal">error.exception.uncaught</code><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></h3><p>type: boolean</p><p>Indicator whether the error was caught somewhere in the code or not.</p><h2><a id="_log_fields"></a>log 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>Additional information added by logging the error.</p><h3><a id="_literal_error_log_level_literal"></a><code class="literal">error.log.level</code><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></h3><p>type: keyword</p><p>The severity of the record.</p><h3><a id="_literal_error_log_logger_name_literal"></a><code class="literal">error.log.logger_name</code><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></h3><p>type: keyword</p><p>The name of the logger instance used.</p><h3><a id="_literal_error_log_message_literal"></a><code class="literal">error.log.message</code><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></h3><p>type: text</p><p>The additionally logged error message.</p><h3><a id="_literal_error_log_param_message_literal"></a><code class="literal">error.log.param_message</code><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></h3><p>type: keyword</p><p>A parametrized message. E.g. <span class="emphasis"><em>Could not connect to %s</em></span>.  The property message is still required, and should be equal to the param_message, but with placeholders replaced.  In some situations the param_message is used to group errors together.</p></div><div class="navfooter"><span class="prev"><a href="exported-fields-apm.html">
               « 
               General APM fields fields</a>