[7.x] intake: add cloud.service.name to metadata (#4626)

CONTRIBUTING.md

@@ -97,3 +97,9 @@ and merged with "Create a merge commit".
 Straightforward backports may be merged without review.
 
 [Backport](https://github.com/sqren/backport) is recommended for automating the backport process.
+
+### Examples
+
+This is a collection of example PRs for additions occuring somewhat frequently.
+
+* [Adding a new field to the Intake API and index it in Elasticsearch](https://github.com/elastic/apm-server/pull/4626#issue-555484976)

apmpackage/apm/0.1.0/data_stream/app_metrics/fields/fields.yml

@@ -1,3 +1,9 @@
+- name: cloud.service.name
+  level: extended
+  type: keyword
+  description: |
+    Cloud service name, intended to distinguish services running on different platforms within a provider.
+  ignore_above: 1024
 - name: experimental
   type: object
   description: Additional experimental data sent by the agents.

apmpackage/apm/0.1.0/data_stream/error_logs/fields/fields.yml

@@ -1,3 +1,9 @@
+- name: cloud.service.name
+  level: extended
+  type: keyword
+  description: |
+    Cloud service name, intended to distinguish services running on different platforms within a provider.
+  ignore_above: 1024
 - name: error.culprit
   type: keyword
   description: Function call which was the primary perpetrator of this event.

apmpackage/apm/0.1.0/data_stream/internal_metrics/fields/fields.yml

@@ -1,3 +1,9 @@
+- name: cloud.service.name
+  level: extended
+  type: keyword
+  description: |
+    Cloud service name, intended to distinguish services running on different platforms within a provider.
+  ignore_above: 1024
 - name: experimental
   type: object
   description: Additional experimental data sent by the agents.

apmpackage/apm/0.1.0/data_stream/profile_metrics/fields/fields.yml

@@ -1,3 +1,9 @@
+- name: cloud.service.name
+  level: extended
+  type: keyword
+  description: |
+    Cloud service name, intended to distinguish services running on different platforms within a provider.
+  ignore_above: 1024
 - name: experimental
   type: object
   description: Additional experimental data sent by the agents.

apmpackage/apm/0.1.0/data_stream/traces/fields/fields.yml

@@ -2,6 +2,12 @@
   type: keyword
   description: |
     The ID(s)s of the child event(s).
+- name: cloud.service.name
+  level: extended
+  type: keyword
+  description: |
+    Cloud service name, intended to distinguish services running on different platforms within a provider.
+  ignore_above: 1024
 - name: experimental
   type: object
   description: Additional experimental data sent by the agents.

apmpackage/apm/0.1.0/docs/README.md

@@ -88,6 +88,7 @@ Traces are written to `traces-apm.*` indices.
 |cloud.project.name|Cloud project name|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |cloud.provider|Cloud provider name|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |cloud.region|Cloud region name|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
+|cloud.service.name|Cloud service name, intended to distinguish services running on different platforms within a provider.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png)  |
 |container.id|Unique container id.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |destination.address|Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket.  You should always store the raw address in the `.address` field. Then it should be duplicated to `.ip` or `.domain`, depending on which one it is.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |destination.ip|IP addess of the destination. Can be one of multiple IPv4 or IPv6 addresses.|ip|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
@@ -441,6 +442,7 @@ Metrics are written to `metrics-apm.*`, `metrics-apm.internal.*` and `metrics-ap
 |cloud.project.name|Cloud project name|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |cloud.provider|Cloud provider name|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |cloud.region|Cloud region name|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
+|cloud.service.name|Cloud service name, intended to distinguish services running on different platforms within a provider.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png)  |
 |container.id|Unique container id.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |destination.address|Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket.  You should always store the raw address in the `.address` field. Then it should be duplicated to `.ip` or `.domain`, depending on which one it is.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |destination.ip|IP addess of the destination. Can be one of multiple IPv4 or IPv6 addresses.|ip|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
@@ -593,6 +595,7 @@ Logs are written to `logs-apm.error.*` indices.
 |cloud.project.name|Cloud project name|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |cloud.provider|Cloud provider name|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |cloud.region|Cloud region name|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
+|cloud.service.name|Cloud service name, intended to distinguish services running on different platforms within a provider.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png)  |
 |container.id|Unique container id.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |destination.address|Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket.  You should always store the raw address in the `.address` field. Then it should be duplicated to `.ip` or `.domain`, depending on which one it is.|keyword|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |
 |destination.ip|IP addess of the destination. Can be one of multiple IPv4 or IPv6 addresses.|ip|  ![](https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png)  |

beater/test_approved_es_documents/TestPublishIntegrationErrors.approved.json

@@ -28,7 +28,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -381,7 +384,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -496,7 +502,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -607,7 +616,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -724,7 +736,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"

beater/test_approved_es_documents/TestPublishIntegrationSpans.approved.json

@@ -29,7 +29,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -155,7 +158,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -282,7 +288,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -413,7 +422,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -541,7 +553,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -751,7 +766,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"

beater/test_approved_es_documents/TestPublishIntegrationTransactions.approved.json

@@ -24,7 +24,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -153,7 +156,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -373,7 +379,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"
@@ -525,7 +534,10 @@
                     "name": "project_name"
                 },
                 "provider": "cloud_provider",
-                "region": "cloud_region"
+                "region": "cloud_region",
+                "service": {
+                    "name": "lambda"
+                }
             },
             "container": {
                 "id": "container-id"

docs/fields.asciidoc

@@ -1200,6 +1200,17 @@ example: us-east1
 
 --
 
+
+*`cloud.service.name`*::
++
+--
+Cloud service name, intended to distinguish services running on different platforms within a provider.
+
+
+type: keyword
+
+--
+
 [float]
 === error
 
@@ -2202,6 +2213,17 @@ example: us-east1
 --
 
 
+*`cloud.service.name`*::
++
+--
+Cloud service name, intended to distinguish services running on different platforms within a provider.
+
+
+type: keyword
+
+--
+
+
 *`profile.id`*::
 +
 --
@@ -3410,6 +3432,17 @@ example: us-east1
 --
 
 
+*`cloud.service.name`*::
++
+--
+Cloud service name, intended to distinguish services running on different platforms within a provider.
+
+
+type: keyword
+
+--
+
+
 *`event.outcome`*::
 +
 --
@@ -4905,6 +4938,17 @@ example: us-east1
 --
 
 
+*`cloud.service.name`*::
++
+--
+Cloud service name, intended to distinguish services running on different platforms within a provider.
+
+
+type: keyword
+
+--
+
+
 *`event.outcome`*::
 +
 --
@@ -5945,6 +5989,17 @@ example: us-east1
 --
 
 
+*`cloud.service.name`*::
++
+--
+Cloud service name, intended to distinguish services running on different platforms within a provider.
+
+
+type: keyword
+
+--
+
+
 *`event.outcome`*::
 +
 --

docs/spec/v2/metadata.json

@@ -121,6 +121,23 @@
             "string"
           ],
           "maxLength": 1024
+        },
+        "service": {
+          "description": "Service that is monitored on cloud",
+          "type": [
+            "null",
+            "object"
+          ],
+          "properties": {
+            "name": {
+              "description": "Name of the cloud service, intended to distinguish services running on different platforms within a provider, eg AWS EC2 vs Lambda, GCP GCE vs App Engine, Azure VM vs App Server.",
+              "type": [
+                "null",
+                "string"
+              ],
+              "maxLength": 1024
+            }
+          }
         }
       },
       "required": [