Stage 2 changes for RFC 0002 - service.environment (#1541)

* add service.environment

* adjusting description

* adding artifacts

* adding beta marker

* changelog entry

CHANGELOG.next.md

@@ -13,6 +13,7 @@ Thanks, you're awesome :-) -->
 #### Added
 
 * Added `service.address` field. #1537
+* Added `service.environment` as a beta field. #1541
 
 ### Tooling and Artifact Changes
 

docs/field-details.asciidoc

@@ -7331,6 +7331,26 @@ example: `172.26.0.2:5432`
 
 // ===============================================================
 
+|
+[[field-service-environment]]
+<<field-service-environment, service.environment>>
+
+| beta:[ This field is beta and subject to change. ]
+
+Identifies the environment where the service is running.
+
+If the same service runs in different environments (production, staging, QA, development, etc.), the environment can identify other instances of the same service. Can also group services and applications from the same environment.
+
+type: keyword
+
+
+
+example: `production`
+
+| extended
+
+// ===============================================================
+
 |
 [[field-service-ephemeral-id]]
 <<field-service-ephemeral-id, service.ephemeral_id>>

experimental/generated/beats/fields.ecs.yml

@@ -7879,6 +7879,17 @@
         path (sockets).'
       example: 172.26.0.2:5432
       default_field: false
+    - name: environment
+      level: extended
+      type: keyword
+      ignore_above: 1024
+      description: 'Identifies the environment where the service is running.
+
+        If the same service runs in different environments (production, staging, QA,
+        development, etc.), the environment can identify other instances of the same
+        service. Can also group services and applications from the same environment.'
+      example: production
+      default_field: false
     - name: ephemeral_id
       level: extended
       type: keyword

experimental/generated/csv/fields.csv

@@ -946,6 +946,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
 8.0.0-dev+exp,true,server,server.user.name.text,match_only_text,core,,albert,Short name or login of the user.
 8.0.0-dev+exp,true,server,server.user.roles,keyword,extended,array,"[""kibana_admin"", ""reporting_user""]",Array of user roles at the time of the event.
 8.0.0-dev+exp,true,service,service.address,keyword,extended,,172.26.0.2:5432,Address of this service.
+8.0.0-dev+exp,true,service,service.environment,keyword,extended,,production,Environment of the service.
 8.0.0-dev+exp,true,service,service.ephemeral_id,keyword,extended,,8a4f500f,Ephemeral identifier of this service.
 8.0.0-dev+exp,true,service,service.id,keyword,core,,d37e5ebfe0ae6c4972dbe9f0174a1637bb8247f6,Unique identifier of the running service.
 8.0.0-dev+exp,true,service,service.name,keyword,core,,elasticsearch-metrics,Name of the service.

experimental/generated/ecs/ecs_flat.yml

@@ -11843,6 +11843,22 @@ service.address:
   normalize: []
   short: Address of this service.
   type: keyword
+service.environment:
+  beta: This field is beta and subject to change.
+  dashed_name: service-environment
+  description: 'Identifies the environment where the service is running.
+
+    If the same service runs in different environments (production, staging, QA, development,
+    etc.), the environment can identify other instances of the same service. Can also
+    group services and applications from the same environment.'
+  example: production
+  flat_name: service.environment
+  ignore_above: 1024
+  level: extended
+  name: environment
+  normalize: []
+  short: Environment of the service.
+  type: keyword
 service.ephemeral_id:
   dashed_name: service-ephemeral-id
   description: 'Ephemeral identifier of this service (if one exists).

experimental/generated/ecs/ecs_nested.yml

@@ -13894,6 +13894,22 @@ service:
       normalize: []
       short: Address of this service.
       type: keyword
+    service.environment:
+      beta: This field is beta and subject to change.
+      dashed_name: service-environment
+      description: 'Identifies the environment where the service is running.
+
+        If the same service runs in different environments (production, staging, QA,
+        development, etc.), the environment can identify other instances of the same
+        service. Can also group services and applications from the same environment.'
+      example: production
+      flat_name: service.environment
+      ignore_above: 1024
+      level: extended
+      name: environment
+      normalize: []
+      short: Environment of the service.
+      type: keyword
     service.ephemeral_id:
       dashed_name: service-ephemeral-id
       description: 'Ephemeral identifier of this service (if one exists).

experimental/generated/elasticsearch/7/template.json

@@ -4233,6 +4233,10 @@
             "ignore_above": 1024,
             "type": "keyword"
           },
+          "environment": {
+            "ignore_above": 1024,
+            "type": "keyword"
+          },
           "ephemeral_id": {
             "ignore_above": 1024,
             "type": "keyword"

experimental/generated/elasticsearch/component/service.json

@@ -12,6 +12,10 @@
               "ignore_above": 1024,
               "type": "keyword"
             },
+            "environment": {
+              "ignore_above": 1024,
+              "type": "keyword"
+            },
             "ephemeral_id": {
               "ignore_above": 1024,
               "type": "keyword"

generated/beats/fields.ecs.yml

@@ -5469,6 +5469,17 @@
         path (sockets).'
       example: 172.26.0.2:5432
       default_field: false
+    - name: environment
+      level: extended
+      type: keyword
+      ignore_above: 1024
+      description: 'Identifies the environment where the service is running.
+
+        If the same service runs in different environments (production, staging, QA,
+        development, etc.), the environment can identify other instances of the same
+        service. Can also group services and applications from the same environment.'
+      example: production
+      default_field: false
     - name: ephemeral_id
       level: extended
       type: keyword

generated/csv/fields.csv

@@ -622,6 +622,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description
 8.0.0-dev,true,server,server.user.name.text,match_only_text,core,,albert,Short name or login of the user.
 8.0.0-dev,true,server,server.user.roles,keyword,extended,array,"[""kibana_admin"", ""reporting_user""]",Array of user roles at the time of the event.
 8.0.0-dev,true,service,service.address,keyword,extended,,172.26.0.2:5432,Address of this service.
+8.0.0-dev,true,service,service.environment,keyword,extended,,production,Environment of the service.
 8.0.0-dev,true,service,service.ephemeral_id,keyword,extended,,8a4f500f,Ephemeral identifier of this service.
 8.0.0-dev,true,service,service.id,keyword,core,,d37e5ebfe0ae6c4972dbe9f0174a1637bb8247f6,Unique identifier of the running service.
 8.0.0-dev,true,service,service.name,keyword,core,,elasticsearch-metrics,Name of the service.

generated/ecs/ecs_flat.yml

@@ -7993,6 +7993,22 @@ service.address:
   normalize: []
   short: Address of this service.
   type: keyword
+service.environment:
+  beta: This field is beta and subject to change.
+  dashed_name: service-environment
+  description: 'Identifies the environment where the service is running.
+
+    If the same service runs in different environments (production, staging, QA, development,
+    etc.), the environment can identify other instances of the same service. Can also
+    group services and applications from the same environment.'
+  example: production
+  flat_name: service.environment
+  ignore_above: 1024
+  level: extended
+  name: environment
+  normalize: []
+  short: Environment of the service.
+  type: keyword
 service.ephemeral_id:
   dashed_name: service-ephemeral-id
   description: 'Ephemeral identifier of this service (if one exists).

generated/ecs/ecs_nested.yml

@@ -9683,6 +9683,22 @@ service:
       normalize: []
       short: Address of this service.
       type: keyword
+    service.environment:
+      beta: This field is beta and subject to change.
+      dashed_name: service-environment
+      description: 'Identifies the environment where the service is running.
+
+        If the same service runs in different environments (production, staging, QA,
+        development, etc.), the environment can identify other instances of the same
+        service. Can also group services and applications from the same environment.'
+      example: production
+      flat_name: service.environment
+      ignore_above: 1024
+      level: extended
+      name: environment
+      normalize: []
+      short: Environment of the service.
+      type: keyword
     service.ephemeral_id:
       dashed_name: service-ephemeral-id
       description: 'Ephemeral identifier of this service (if one exists).

generated/elasticsearch/6/template.json

@@ -2877,6 +2877,10 @@
               "ignore_above": 1024,
               "type": "keyword"
             },
+            "environment": {
+              "ignore_above": 1024,
+              "type": "keyword"
+            },
             "ephemeral_id": {
               "ignore_above": 1024,
               "type": "keyword"

generated/elasticsearch/7/template.json

@@ -2837,6 +2837,10 @@
             "ignore_above": 1024,
             "type": "keyword"
           },
+          "environment": {
+            "ignore_above": 1024,
+            "type": "keyword"
+          },
           "ephemeral_id": {
             "ignore_above": 1024,
             "type": "keyword"

generated/elasticsearch/component/service.json

@@ -12,6 +12,10 @@
               "ignore_above": 1024,
               "type": "keyword"
             },
+            "environment": {
+              "ignore_above": 1024,
+              "type": "keyword"
+            },
             "ephemeral_id": {
               "ignore_above": 1024,
               "type": "keyword"

schemas/service.yml

@@ -11,6 +11,21 @@
   type: group
   fields:
 
+    - name: environment
+      level: extended
+      type: keyword
+      short: Environment of the service.
+      beta: This field is beta and subject to change.
+      description: >
+        Identifies the environment where the service is running.
+
+        If the same service runs in different environments
+        (production, staging, QA, development, etc.), the environment
+        can identify other instances of the same service. Can also
+        group services and applications from the same environment.
+
+      example: production
+
     - name: id
       level: core
       type: keyword
@@ -110,7 +125,7 @@
       level: extended
       type: keyword
       short: Address of this service.
-      description: > 
+      description: >
         Address where data about this service was collected from.
 
         This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets).