Skip to content

Commit

Permalink
Use ecs definition of the 'event.dataset' field for all datastreams
Browse files Browse the repository at this point in the history
Signed-off-by: Tetiana Kravchenko <[email protected]>
  • Loading branch information
tetianakravchenko committed Nov 12, 2024
1 parent 723bc8a commit e7051df
Show file tree
Hide file tree
Showing 22 changed files with 28 additions and 56 deletions.
2 changes: 1 addition & 1 deletion packages/docker/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# newer versions go on top
- version: 2.12.0
changes:
- description: Use ecs definition of the 'event.dataset' field for container_logs.
- description: Use ecs definition of the 'event.dataset' field.
type: enhancement
link: https://github.com/elastic/integrations/pull/11672
- version: 2.11.0
Expand Down
4 changes: 0 additions & 4 deletions packages/docker/data_stream/container/fields/base-fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,3 @@
type: constant_keyword
description: Event module
value: docker
- name: event.dataset
type: constant_keyword
description: Event dataset
value: docker.container
2 changes: 2 additions & 0 deletions packages/docker/data_stream/container/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@
- external: ecs
name: cloud.instance.id
dimension: true
- external: ecs
name: event.dataset
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ paths:
{{#each paths}}
- {{this}}
{{/each}}
data_stream:
dataset: {{data_stream.dataset}}
{{#if condition}}
condition: {{ condition }}
{{/if}}
Expand Down
8 changes: 0 additions & 8 deletions packages/docker/data_stream/container_logs/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,6 @@ streams:
multi: false
required: false
show_user: true
- name: data_stream.dataset
type: text
required: true
default: docker.container_logs
title: Dataset name
show_user: false
description: >
Set the name for your dataset. Changing the dataset will send the data to a different index. For more info look at [data_stream field](https://www.elastic.co/guide/en/ecs/master/ecs-data_stream.html).
- name: additionalParsersConfig
type: yaml
title: Additional parsers configuration
Expand Down
4 changes: 0 additions & 4 deletions packages/docker/data_stream/cpu/fields/base-fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,3 @@
type: constant_keyword
description: Event module
value: docker
- name: event.dataset
type: constant_keyword
description: Event dataset
value: docker.cpu
2 changes: 2 additions & 0 deletions packages/docker/data_stream/cpu/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,5 @@
- external: ecs
name: cloud.instance.id
dimension: true
- external: ecs
name: event.dataset
4 changes: 0 additions & 4 deletions packages/docker/data_stream/diskio/fields/base-fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,3 @@
type: constant_keyword
description: Event module
value: docker
- name: event.dataset
type: constant_keyword
description: Event dataset
value: docker.diskio
2 changes: 2 additions & 0 deletions packages/docker/data_stream/diskio/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,5 @@
- external: ecs
name: cloud.instance.id
dimension: true
- external: ecs
name: event.dataset
4 changes: 0 additions & 4 deletions packages/docker/data_stream/event/fields/base-fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,3 @@
type: constant_keyword
description: Event module
value: docker
- name: event.dataset
type: constant_keyword
description: Event dataset
value: docker.event
2 changes: 2 additions & 0 deletions packages/docker/data_stream/event/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,5 @@
name: host.os.version
- external: ecs
name: host.type
- external: ecs
name: event.dataset
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,3 @@
type: constant_keyword
description: Event module
value: docker
- name: event.dataset
type: constant_keyword
description: Event dataset
value: docker.healthcheck
2 changes: 2 additions & 0 deletions packages/docker/data_stream/healthcheck/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@
- external: ecs
name: cloud.instance.id
dimension: true
- external: ecs
name: event.dataset
4 changes: 0 additions & 4 deletions packages/docker/data_stream/image/fields/base-fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,3 @@
type: constant_keyword
description: Event module
value: docker
- name: event.dataset
type: constant_keyword
description: Event dataset
value: docker.image
2 changes: 2 additions & 0 deletions packages/docker/data_stream/image/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,5 @@
- external: ecs
name: cloud.instance.id
dimension: true
- external: ecs
name: event.dataset
4 changes: 0 additions & 4 deletions packages/docker/data_stream/info/fields/base-fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,3 @@
type: constant_keyword
description: Event module
value: docker
- name: event.dataset
type: constant_keyword
description: Event dataset
value: docker.info
2 changes: 2 additions & 0 deletions packages/docker/data_stream/info/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,5 @@
- external: ecs
name: cloud.instance.id
dimension: true
- external: ecs
name: event.dataset
4 changes: 0 additions & 4 deletions packages/docker/data_stream/memory/fields/base-fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,3 @@
type: constant_keyword
description: Event module
value: docker
- name: event.dataset
type: constant_keyword
description: Event dataset
value: docker.memory
2 changes: 2 additions & 0 deletions packages/docker/data_stream/memory/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,5 @@
- external: ecs
name: cloud.instance.id
dimension: true
- external: ecs
name: event.dataset
4 changes: 0 additions & 4 deletions packages/docker/data_stream/network/fields/base-fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,3 @@
type: constant_keyword
description: Event module
value: docker
- name: event.dataset
type: constant_keyword
description: Event dataset
value: docker.network
2 changes: 2 additions & 0 deletions packages/docker/data_stream/network/fields/ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,5 @@
- external: ecs
name: cloud.instance.id
dimension: true
- external: ecs
name: event.dataset
18 changes: 9 additions & 9 deletions packages/docker/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ running Docker containers.
| docker.container.status | Container status. | keyword | |
| docker.container.tags | Image tags. | keyword | |
| ecs.version | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword | |
| event.dataset | Event dataset | constant_keyword | |
| event.dataset | Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. | keyword | |
| event.module | Event module | constant_keyword | |
| host | A host is defined as a general computing instance. ECS host.\* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes. | group | |
| host.architecture | Operating system architecture. | keyword | |
Expand Down Expand Up @@ -209,7 +209,7 @@ The Docker `cpu` data stream collects runtime CPU metrics.
| docker.cpu.user.pct | Percentage of time in user space. | scaled_float | percent | gauge |
| docker.cpu.user.ticks | CPU ticks in user space. | long | | counter |
| ecs.version | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword | | |
| event.dataset | Event dataset | constant_keyword | | |
| event.dataset | Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. | keyword | | |
| event.module | Event module | constant_keyword | | |
| host | A host is defined as a general computing instance. ECS host.\* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes. | group | | |
| host.architecture | Operating system architecture. | keyword | | |
Expand Down Expand Up @@ -400,7 +400,7 @@ The Docker `diskio` data stream collects disk I/O metrics.
| docker.diskio.write.service_time | Total time to service IO requests, in nanoseconds | long | | counter |
| docker.diskio.write.wait_time | Total time requests spent waiting in queues for service, in nanoseconds | long | | counter |
| ecs.version | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword | | |
| event.dataset | Event dataset | constant_keyword | | |
| event.dataset | Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. | keyword | | |
| event.module | Event module | constant_keyword | | |
| host | A host is defined as a general computing instance. ECS host.\* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes. | group | | |
| host.architecture | Operating system architecture. | keyword | | |
Expand Down Expand Up @@ -502,7 +502,7 @@ The Docker `event` data stream collects docker events
| docker.event.status | Event status | keyword |
| docker.event.type | The type of object emitting the event | keyword |
| ecs.version | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword |
| event.dataset | Event dataset | constant_keyword |
| event.dataset | Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. | keyword |
| event.module | Event module | constant_keyword |
| host | A host is defined as a general computing instance. ECS host.\* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes. | group |
| host.architecture | Operating system architecture. | keyword |
Expand Down Expand Up @@ -590,7 +590,7 @@ docker `HEALTHCHECK` instruction has been used to build the docker image.
| docker.healthcheck.failingstreak | concurent failed check | integer | counter |
| docker.healthcheck.status | Healthcheck status code | keyword | |
| ecs.version | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword | |
| event.dataset | Event dataset | constant_keyword | |
| event.dataset | Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. | keyword | |
| event.module | Event module | constant_keyword | |
| host | A host is defined as a general computing instance. ECS host.\* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes. | group | |
| host.architecture | Operating system architecture. | keyword | |
Expand Down Expand Up @@ -704,7 +704,7 @@ The Docker `image` data stream collects metrics on docker images
| docker.image.size.virtual | Size of the image. | long | gauge |
| docker.image.tags | Image tags. | keyword | |
| ecs.version | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword | |
| event.dataset | Event dataset | constant_keyword | |
| event.dataset | Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. | keyword | |
| event.module | Event module | constant_keyword | |
| host | A host is defined as a general computing instance. ECS host.\* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes. | group | |
| host.architecture | Operating system architecture. | keyword | |
Expand Down Expand Up @@ -801,7 +801,7 @@ https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-s
| docker.info.id | Unique Docker host identifier. | keyword | |
| docker.info.images | Total number of existing images. | long | counter |
| ecs.version | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword | |
| event.dataset | Event dataset | constant_keyword | |
| event.dataset | Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. | keyword | |
| event.module | Event module | constant_keyword | |
| host | A host is defined as a general computing instance. ECS host.\* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes. | group | |
| host.architecture | Operating system architecture. | keyword | |
Expand Down Expand Up @@ -890,7 +890,7 @@ The Docker `memory` data stream collects memory metrics from docker.
| docker.memory.usage.pct | Memory usage percentage. | scaled_float | percent | gauge |
| docker.memory.usage.total | Total memory usage. | long | byte | gauge |
| ecs.version | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword | | |
| event.dataset | Event dataset | constant_keyword | | |
| event.dataset | Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. | keyword | | |
| event.module | Event module | constant_keyword | | |
| host | A host is defined as a general computing instance. ECS host.\* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes. | group | | |
| host.architecture | Operating system architecture. | keyword | | |
Expand Down Expand Up @@ -1025,7 +1025,7 @@ The Docker `network` data stream collects network metrics.
| docker.network.outbound.errors | Total errors on outgoing packets. | long | counter |
| docker.network.outbound.packets | Total number of outgoing packets. | long | counter |
| ecs.version | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword | |
| event.dataset | Event dataset | constant_keyword | |
| event.dataset | Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. | keyword | |
| event.module | Event module | constant_keyword | |
| host | A host is defined as a general computing instance. ECS host.\* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes. | group | |
| host.architecture | Operating system architecture. | keyword | |
Expand Down

0 comments on commit e7051df

Please sign in to comment.