Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tune docker package according to Beat's fields deprecation #2733

Merged
merged 6 commits into from
Feb 23, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/docker/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "1.3.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be a breaking change, so 2.0.0?

changes:
- description: Remove deprecated fields
type: enhancement
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Maybe use the type: breaking-change

link: http://github.com/elastic/integrations/pull/2733
- version: "1.2.0"
changes:
- description: Release package for 8.0.0
Expand Down
17 changes: 1 addition & 16 deletions packages/docker/data_stream/diskio/fields/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,6 @@
metric_type: gauge
description: |
Total number of queued requests
- name: reads
type: scaled_float
metric_type: gauge
description: |
Number of current reads per second
- name: write
type: group
fields:
Expand Down Expand Up @@ -80,11 +75,6 @@
metric_type: counter
description: |
Total number of queued requests
- name: writes
type: scaled_float
metric_type: gauge
description: |
Number of current writes per second
- name: summary
type: group
fields:
Expand Down Expand Up @@ -118,10 +108,5 @@
- name: queued
type: long
metric_type: counter
description: |
description: |-
Total number of queued requests
- name: total
type: scaled_float
metric_type: gauge
description: |
Number of reads and writes per second
5 changes: 1 addition & 4 deletions packages/docker/data_stream/diskio/sample_event.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
"service_time": 0,
"wait_time": 0
},
"reads": 0,
"summary": {
"bytes": 42414080,
"ops": 1824,
Expand All @@ -27,16 +26,14 @@
"service_time": 0,
"wait_time": 0
},
"total": 0,
"write": {
"bytes": 4096,
"ops": 1,
"queued": 0,
"rate": 0,
"service_time": 0,
"wait_time": 0
},
"writes": 0
}
}
},
"event": {
Expand Down
48 changes: 0 additions & 48 deletions packages/docker/data_stream/network/fields/fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,54 +11,6 @@
type: keyword
description: |
Network interface name.
- name: in
type: group
fields:
- name: bytes
type: long
format: bytes
metric_type: counter
description: |
Total number of incoming bytes.
- name: dropped
type: scaled_float
metric_type: counter
description: |
Total number of dropped incoming packets.
- name: errors
type: long
metric_type: counter
description: |
Total errors on incoming packets.
- name: packets
type: long
metric_type: counter
description: |
Total number of incoming packets.
- name: out
type: group
fields:
- name: bytes
type: long
format: bytes
metric_type: counter
description: |
Total number of outgoing bytes.
- name: dropped
type: scaled_float
metric_type: counter
description: |
Total number of dropped outgoing packets.
- name: errors
type: long
metric_type: counter
description: |
Total errors on outgoing packets.
- name: packets
type: long
metric_type: counter
description: |
Total number of outgoing packets.
- name: inbound
type: group
fields:
Expand Down
12 changes: 0 additions & 12 deletions packages/docker/data_stream/network/sample_event.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,25 +34,13 @@
}
},
"network": {
"in": {
"bytes": 0,
"dropped": 0,
"errors": 0,
"packets": 0
},
"inbound": {
"bytes": 23047,
"dropped": 0,
"errors": 0,
"packets": 241
},
"interface": "eth0",
"out": {
"bytes": 0,
"dropped": 0,
"errors": 0,
"packets": 0
},
"outbound": {
"bytes": 0,
"dropped": 0,
Expand Down
28 changes: 1 addition & 27 deletions packages/docker/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,21 +341,18 @@ The Docker `diskio` data stream collects disk I/O metrics.
| docker.diskio.read.rate | Number of current reads per second | long | | gauge |
| docker.diskio.read.service_time | Total time to service IO requests, in nanoseconds | long | | counter |
| docker.diskio.read.wait_time | Total time requests spent waiting in queues for service, in nanoseconds | long | | counter |
| docker.diskio.reads | Number of current reads per second | scaled_float | | gauge |
| docker.diskio.summary.bytes | Bytes read and written during the life of the container | long | byte | counter |
| docker.diskio.summary.ops | Number of I/O operations during the life of the container | long | | counter |
| docker.diskio.summary.queued | Total number of queued requests | long | | counter |
| docker.diskio.summary.rate | Number of current operations per second | long | | gauge |
| docker.diskio.summary.service_time | Total time to service IO requests, in nanoseconds | long | | counter |
| docker.diskio.summary.wait_time | Total time requests spent waiting in queues for service, in nanoseconds | long | | counter |
| docker.diskio.total | Number of reads and writes per second | scaled_float | | gauge |
| docker.diskio.write.bytes | Bytes written during the life of the container | long | byte | counter |
| docker.diskio.write.ops | Number of writes during the life of the container | long | | counter |
| docker.diskio.write.queued | Total number of queued requests | long | | counter |
| docker.diskio.write.rate | Number of current writes per second | long | | gauge |
| 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 |
| docker.diskio.writes | Number of current writes per second | scaled_float | | 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.module | Event module | constant_keyword | | |
Expand Down Expand Up @@ -398,7 +395,6 @@ An example event for `diskio` looks as following:
"service_time": 0,
"wait_time": 0
},
"reads": 0,
"summary": {
"bytes": 42414080,
"ops": 1824,
Expand All @@ -407,16 +403,14 @@ An example event for `diskio` looks as following:
"service_time": 0,
"wait_time": 0
},
"total": 0,
"write": {
"bytes": 4096,
"ops": 1,
"queued": 0,
"rate": 0,
"service_time": 0,
"wait_time": 0
},
"writes": 0
}
}
},
"event": {
Expand Down Expand Up @@ -930,19 +924,11 @@ The Docker `network` data stream collects network metrics.
| data_stream.namespace | Data stream namespace. | constant_keyword | |
| data_stream.type | Data stream type. | constant_keyword | |
| docker.container.labels.\* | Container labels | object | |
| docker.network.in.bytes | Total number of incoming bytes. | long | counter |
| docker.network.in.dropped | Total number of dropped incoming packets. | scaled_float | counter |
| docker.network.in.errors | Total errors on incoming packets. | long | counter |
| docker.network.in.packets | Total number of incoming packets. | long | counter |
| docker.network.inbound.bytes | Total number of incoming bytes. | long | counter |
| docker.network.inbound.dropped | Total number of dropped incoming packets. | long | counter |
| docker.network.inbound.errors | Total errors on incoming packets. | long | counter |
| docker.network.inbound.packets | Total number of incoming packets. | long | counter |
| docker.network.interface | Network interface name. | keyword | |
| docker.network.out.bytes | Total number of outgoing bytes. | long | counter |
| docker.network.out.dropped | Total number of dropped outgoing packets. | scaled_float | counter |
| docker.network.out.errors | Total errors on outgoing packets. | long | counter |
| docker.network.out.packets | Total number of outgoing packets. | long | counter |
| docker.network.outbound.bytes | Total number of outgoing bytes. | long | counter |
| docker.network.outbound.dropped | Total number of dropped outgoing packets. | long | counter |
| docker.network.outbound.errors | Total errors on outgoing packets. | long | counter |
Expand Down Expand Up @@ -1005,25 +991,13 @@ An example event for `network` looks as following:
}
},
"network": {
"in": {
"bytes": 0,
"dropped": 0,
"errors": 0,
"packets": 0
},
"inbound": {
"bytes": 23047,
"dropped": 0,
"errors": 0,
"packets": 241
},
"interface": "eth0",
"out": {
"bytes": 0,
"dropped": 0,
"errors": 0,
"packets": 0
},
"outbound": {
"bytes": 0,
"dropped": 0,
Expand Down
4 changes: 2 additions & 2 deletions packages/docker/kibana/visualization/docker-Network-IO.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"id": "1",
"params": {
"customLabel": "IN bytes",
"field": "docker.network.in.bytes"
"field": "docker.network.inbound.bytes"
},
"schema": "metric",
"type": "max"
Expand Down Expand Up @@ -69,7 +69,7 @@
"id": "4",
"params": {
"customLabel": "OUT bytes",
"field": "docker.network.out.bytes"
"field": "docker.network.outbound.bytes"
},
"schema": "metric",
"type": "max"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"id": "4",
"params": {
"customLabel": "DiskIO",
"field": "docker.diskio.total"
"field": "docker.diskio.summary.bytes"
},
"schema": "metric",
"type": "max"
Expand Down
4 changes: 2 additions & 2 deletions packages/docker/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: docker
title: Docker Metrics
version: 1.2.0
version: 1.3.0
release: ga
description: Collect metrics from Docker instances with Elastic Agent.
type: integration
Expand All @@ -20,7 +20,7 @@ categories:
- containers
- os_system
conditions:
kibana.version: ^7.14.0 || ^8.0.0
kibana.version: ^8.0.0
policy_templates:
- name: docker
title: Docker metrics
Expand Down