Skip to content

Commit 89641ac

Browse files
authored
[RabbitMQ] Update metrictype for fields of rabbitmq queue datastream. (#5670)
* Add metrictype for fields for rabbitmq queue datastream.
1 parent 5e3ce4c commit 89641ac

File tree

4 files changed

+81
-63
lines changed

4 files changed

+81
-63
lines changed

packages/rabbitmq/changelog.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
- version: "1.8.7"
2+
changes:
3+
- description: Added metrictype for the fields of queue datastream.
4+
type: enhancement
5+
link: https://github.com/elastic/integrations/pull/5670
16
- version: "1.8.6"
27
changes:
38
- description: Add metric_type for the fields of node datastream.

packages/rabbitmq/data_stream/queue/fields/fields.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,55 +25,68 @@
2525
The state of the queue. Normally 'running', but may be `"{syncing, MsgCount}"` if the queue is synchronising. Queues which are located on cluster nodes that are currently down will be shown with a status of 'down'.
2626
- name: arguments.max_priority
2727
type: long
28+
metric_type: gauge
2829
description: |
2930
Maximum number of priority levels for the queue to support.
3031
- name: consumers.count
3132
type: long
33+
metric_type: gauge
3234
description: |
3335
Number of consumers.
3436
- name: consumers.utilisation.pct
3537
type: long
3638
format: percent
39+
metric_type: gauge
3740
description: |
3841
Fraction of the time (between 0.0 and 1.0) that the queue is able to immediately deliver messages to consumers. This can be less than 1.0 if consumers are limited by network congestion or prefetch count.
3942
- name: messages.total.count
4043
type: long
44+
metric_type: gauge
4145
description: |
4246
Sum of ready and unacknowledged messages (queue depth).
4347
- name: messages.total.details.rate
4448
type: float
49+
metric_type: gauge
4550
description: |
4651
How much the queue depth has changed per second in the most recent sampling interval.
4752
- name: messages.ready.count
4853
type: long
54+
metric_type: gauge
4955
description: |
5056
Number of messages ready to be delivered to clients.
5157
- name: messages.ready.details.rate
5258
type: float
59+
metric_type: gauge
5360
description: |
5461
How much the count of messages ready has changed per second in the most recent sampling interval.
5562
- name: messages.unacknowledged.count
5663
type: long
64+
metric_type: gauge
5765
description: |
5866
Number of messages delivered to clients but not yet acknowledged.
5967
- name: messages.unacknowledged.details.rate
6068
type: float
69+
metric_type: gauge
6170
description: |
6271
How much the count of unacknowledged messages has changed per second in the most recent sampling interval.
6372
- name: messages.persistent.count
6473
type: long
74+
metric_type: gauge
6575
description: |
6676
Total number of persistent messages in the queue (will always be 0 for transient queues).
6777
- name: memory.bytes
6878
type: long
6979
format: bytes
80+
metric_type: gauge
7081
description: |
7182
Bytes of memory consumed by the Erlang process associated with the queue, including stack, heap and internal structures.
7283
- name: disk.reads.count
7384
type: long
85+
metric_type: counter
7486
description: |
7587
Total number of times messages have been read from disk by this queue since it started.
7688
- name: disk.writes.count
7789
type: long
90+
metric_type: counter
7891
description: |
7992
Total number of times messages have been written to disk by this queue since it started.

packages/rabbitmq/docs/README.md

Lines changed: 61 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -591,64 +591,64 @@ An example event for `queue` looks as following:
591591

592592
**Exported fields**
593593

594-
| Field | Description | Type |
595-
|---|---|---|
596-
| @timestamp | Event timestamp. | date |
597-
| agent.id | | keyword |
598-
| cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword |
599-
| cloud.availability_zone | Availability zone in which this host is running. | keyword |
600-
| cloud.image.id | Image ID for the cloud instance. | keyword |
601-
| cloud.instance.id | Instance ID of the host machine. | keyword |
602-
| cloud.instance.name | Instance name of the host machine. | keyword |
603-
| cloud.machine.type | Machine type of the host machine. | keyword |
604-
| cloud.project.id | Name of the project in Google Cloud. | keyword |
605-
| cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword |
606-
| cloud.region | Region in which this host is running. | keyword |
607-
| container.id | Unique container id. | keyword |
608-
| container.image.name | Name of the image the container was built on. | keyword |
609-
| container.labels | Image labels. | object |
610-
| container.name | Container name. | keyword |
611-
| data_stream.dataset | Data stream dataset. | constant_keyword |
612-
| data_stream.namespace | Data stream namespace. | constant_keyword |
613-
| data_stream.type | Data stream type. | constant_keyword |
614-
| 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 |
615-
| event.dataset | Event dataset | constant_keyword |
616-
| event.module | Event module | constant_keyword |
617-
| host.architecture | Operating system architecture. | keyword |
618-
| host.containerized | If the host is a container. | boolean |
619-
| host.domain | Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider. | keyword |
620-
| host.hostname | Hostname of the host. It normally contains what the `hostname` command returns on the host machine. | keyword |
621-
| host.id | Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of `beat.name`. | keyword |
622-
| host.ip | Host ip addresses. | ip |
623-
| host.mac | Host mac addresses. | keyword |
624-
| host.name | Name of the host. It can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. | keyword |
625-
| host.os.build | OS build information. | keyword |
626-
| host.os.codename | OS codename, if any. | keyword |
627-
| host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword |
628-
| host.os.kernel | Operating system kernel version as a raw string. | keyword |
629-
| host.os.name | Operating system name, without the version. | keyword |
630-
| host.os.name.text | Multi-field of `host.os.name`. | text |
631-
| host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword |
632-
| host.os.version | Operating system version as a raw string. | keyword |
633-
| host.type | Type of host. For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment. | keyword |
634-
| rabbitmq.queue.arguments.max_priority | Maximum number of priority levels for the queue to support. | long |
635-
| rabbitmq.queue.auto_delete | Whether the queue will be deleted automatically when no longer used. | boolean |
636-
| rabbitmq.queue.consumers.count | Number of consumers. | long |
637-
| rabbitmq.queue.consumers.utilisation.pct | Fraction of the time (between 0.0 and 1.0) that the queue is able to immediately deliver messages to consumers. This can be less than 1.0 if consumers are limited by network congestion or prefetch count. | long |
638-
| rabbitmq.queue.disk.reads.count | Total number of times messages have been read from disk by this queue since it started. | long |
639-
| rabbitmq.queue.disk.writes.count | Total number of times messages have been written to disk by this queue since it started. | long |
640-
| rabbitmq.queue.durable | Whether or not the queue survives server restarts. | boolean |
641-
| rabbitmq.queue.exclusive | Whether the queue is exclusive (i.e. has owner_pid). | boolean |
642-
| rabbitmq.queue.memory.bytes | Bytes of memory consumed by the Erlang process associated with the queue, including stack, heap and internal structures. | long |
643-
| rabbitmq.queue.messages.persistent.count | Total number of persistent messages in the queue (will always be 0 for transient queues). | long |
644-
| rabbitmq.queue.messages.ready.count | Number of messages ready to be delivered to clients. | long |
645-
| rabbitmq.queue.messages.ready.details.rate | How much the count of messages ready has changed per second in the most recent sampling interval. | float |
646-
| rabbitmq.queue.messages.total.count | Sum of ready and unacknowledged messages (queue depth). | long |
647-
| rabbitmq.queue.messages.total.details.rate | How much the queue depth has changed per second in the most recent sampling interval. | float |
648-
| rabbitmq.queue.messages.unacknowledged.count | Number of messages delivered to clients but not yet acknowledged. | long |
649-
| rabbitmq.queue.messages.unacknowledged.details.rate | How much the count of unacknowledged messages has changed per second in the most recent sampling interval. | float |
650-
| rabbitmq.queue.name | The name of the queue with non-ASCII characters escaped as in C. | keyword |
651-
| rabbitmq.queue.state | The state of the queue. Normally 'running', but may be `"\{syncing, MsgCount\}"` if the queue is synchronising. Queues which are located on cluster nodes that are currently down will be shown with a status of 'down'. | keyword |
652-
| rabbitmq.vhost | Virtual host name with non-ASCII characters escaped as in C. | keyword |
653-
| service.address | 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). | keyword |
654-
| service.type | The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, `service.type` would be `elasticsearch`. | keyword |
594+
| Field | Description | Type | Metric Type |
595+
|---|---|---|---|
596+
| @timestamp | Event timestamp. | date | |
597+
| agent.id | | keyword | |
598+
| cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword | |
599+
| cloud.availability_zone | Availability zone in which this host is running. | keyword | |
600+
| cloud.image.id | Image ID for the cloud instance. | keyword | |
601+
| cloud.instance.id | Instance ID of the host machine. | keyword | |
602+
| cloud.instance.name | Instance name of the host machine. | keyword | |
603+
| cloud.machine.type | Machine type of the host machine. | keyword | |
604+
| cloud.project.id | Name of the project in Google Cloud. | keyword | |
605+
| cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword | |
606+
| cloud.region | Region in which this host is running. | keyword | |
607+
| container.id | Unique container id. | keyword | |
608+
| container.image.name | Name of the image the container was built on. | keyword | |
609+
| container.labels | Image labels. | object | |
610+
| container.name | Container name. | keyword | |
611+
| data_stream.dataset | Data stream dataset. | constant_keyword | |
612+
| data_stream.namespace | Data stream namespace. | constant_keyword | |
613+
| data_stream.type | Data stream type. | constant_keyword | |
614+
| 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 | |
615+
| event.dataset | Event dataset | constant_keyword | |
616+
| event.module | Event module | constant_keyword | |
617+
| host.architecture | Operating system architecture. | keyword | |
618+
| host.containerized | If the host is a container. | boolean | |
619+
| host.domain | Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider. | keyword | |
620+
| host.hostname | Hostname of the host. It normally contains what the `hostname` command returns on the host machine. | keyword | |
621+
| host.id | Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of `beat.name`. | keyword | |
622+
| host.ip | Host ip addresses. | ip | |
623+
| host.mac | Host mac addresses. | keyword | |
624+
| host.name | Name of the host. It can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. | keyword | |
625+
| host.os.build | OS build information. | keyword | |
626+
| host.os.codename | OS codename, if any. | keyword | |
627+
| host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword | |
628+
| host.os.kernel | Operating system kernel version as a raw string. | keyword | |
629+
| host.os.name | Operating system name, without the version. | keyword | |
630+
| host.os.name.text | Multi-field of `host.os.name`. | text | |
631+
| host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword | |
632+
| host.os.version | Operating system version as a raw string. | keyword | |
633+
| host.type | Type of host. For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment. | keyword | |
634+
| rabbitmq.queue.arguments.max_priority | Maximum number of priority levels for the queue to support. | long | gauge |
635+
| rabbitmq.queue.auto_delete | Whether the queue will be deleted automatically when no longer used. | boolean | |
636+
| rabbitmq.queue.consumers.count | Number of consumers. | long | gauge |
637+
| rabbitmq.queue.consumers.utilisation.pct | Fraction of the time (between 0.0 and 1.0) that the queue is able to immediately deliver messages to consumers. This can be less than 1.0 if consumers are limited by network congestion or prefetch count. | long | gauge |
638+
| rabbitmq.queue.disk.reads.count | Total number of times messages have been read from disk by this queue since it started. | long | counter |
639+
| rabbitmq.queue.disk.writes.count | Total number of times messages have been written to disk by this queue since it started. | long | counter |
640+
| rabbitmq.queue.durable | Whether or not the queue survives server restarts. | boolean | |
641+
| rabbitmq.queue.exclusive | Whether the queue is exclusive (i.e. has owner_pid). | boolean | |
642+
| rabbitmq.queue.memory.bytes | Bytes of memory consumed by the Erlang process associated with the queue, including stack, heap and internal structures. | long | gauge |
643+
| rabbitmq.queue.messages.persistent.count | Total number of persistent messages in the queue (will always be 0 for transient queues). | long | gauge |
644+
| rabbitmq.queue.messages.ready.count | Number of messages ready to be delivered to clients. | long | gauge |
645+
| rabbitmq.queue.messages.ready.details.rate | How much the count of messages ready has changed per second in the most recent sampling interval. | float | gauge |
646+
| rabbitmq.queue.messages.total.count | Sum of ready and unacknowledged messages (queue depth). | long | gauge |
647+
| rabbitmq.queue.messages.total.details.rate | How much the queue depth has changed per second in the most recent sampling interval. | float | gauge |
648+
| rabbitmq.queue.messages.unacknowledged.count | Number of messages delivered to clients but not yet acknowledged. | long | gauge |
649+
| rabbitmq.queue.messages.unacknowledged.details.rate | How much the count of unacknowledged messages has changed per second in the most recent sampling interval. | float | gauge |
650+
| rabbitmq.queue.name | The name of the queue with non-ASCII characters escaped as in C. | keyword | |
651+
| rabbitmq.queue.state | The state of the queue. Normally 'running', but may be `"\{syncing, MsgCount\}"` if the queue is synchronising. Queues which are located on cluster nodes that are currently down will be shown with a status of 'down'. | keyword | |
652+
| rabbitmq.vhost | Virtual host name with non-ASCII characters escaped as in C. | keyword | |
653+
| service.address | 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). | keyword | |
654+
| service.type | The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, `service.type` would be `elasticsearch`. | keyword | |

packages/rabbitmq/manifest.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
format_version: 1.0.0
22
name: rabbitmq
3-
title: RabbitMQ Logs
4-
version: 1.8.6
3+
title: RabbitMQ Logs and Metrics
4+
version: 1.8.7
55
license: basic
66
description: Collect and parse logs from RabbitMQ servers with Elastic Agent.
77
type: integration

0 commit comments

Comments
 (0)