[Zookeeper] Add metric type mapping for server datastream (#7885)

* Add metric type mapping for server datastream * Updated PR link in the changelog
elastic · Sep 26, 2023 · e39a2f3 · e39a2f3
1 parent fbd59c9
commit e39a2f3
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 56 deletions.
diff --git a/packages/zookeeper/changelog.yml b/packages/zookeeper/changelog.yml
@@ -1,4 +1,9 @@
 # newer versions go on top
+- version: "1.8.2"
+  changes:
+    - description: Added metric_type mapping for server datastream.
+      type: enhancement
+      link: https://github.com/elastic/integrations/pull/7885
 - version: "1.8.1"
   changes:
     - description: Added metric_type mapping for mntr datastream.

diff --git a/packages/zookeeper/data_stream/server/fields/fields.yml b/packages/zookeeper/data_stream/server/fields/fields.yml
@@ -4,33 +4,41 @@
     - name: connections
       type: long
       description: Number of clients currently connected to the server
+      metric_type: gauge
     - name: latency
       type: group
       fields:
         - name: avg
           type: long
+          metric_type: gauge
           description: Average amount of time taken for the server to respond to a client request
         - name: max
           type: long
+          metric_type: gauge
           description: Maximum amount of time taken for the server to respond to a client request
         - name: min
           type: long
+          metric_type: gauge
           description: Minimum amount of time taken for the server to respond to a client request
     - name: mode
       type: keyword
       description: Mode of the server. In an ensemble, this may either be leader or follower. Otherwise, it is standalone
     - name: node_count
       type: long
       description: Total number of nodes
+      metric_type: gauge
     - name: outstanding
       type: long
+      metric_type: gauge
       description: Number of requests queued at the server. This exceeds zero when the server receives more requests than it is able to process
     - name: received
       type: long
       description: Number of requests received by the server
+      metric_type: counter
     - name: sent
       type: long
       description: Number of requests sent by the server
+      metric_type: counter
     - name: version_date
       type: date
       description: Date of the Zookeeper release currently in use
@@ -39,6 +47,7 @@
       description: Unique value of the Zookeeper transaction ID. The zxid consists of an epoch and a counter. It is established by the leader and is used to determine the temporal ordering of changes
     - name: count
       type: long
+      metric_type: counter
       description: Total transactions of the leader in epoch
     - name: epoch
       type: long

diff --git a/packages/zookeeper/docs/README.md b/packages/zookeeper/docs/README.md
@@ -294,59 +294,59 @@ An example event for `server` looks as following:
 
 **Exported fields**
 
-| Field | Description | Type |
-|---|---|---|
-| @timestamp | Event timestamp. | date |
-| 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 |
-| cloud.availability_zone | Availability zone in which this host is running. | keyword |
-| cloud.image.id | Image ID for the cloud instance. | keyword |
-| cloud.instance.id | Instance ID of the host machine. | keyword |
-| cloud.instance.name | Instance name of the host machine. | keyword |
-| cloud.machine.type | Machine type of the host machine. | keyword |
-| cloud.project.id | Name of the project in Google Cloud. | keyword |
-| cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword |
-| cloud.region | Region in which this host is running. | keyword |
-| container.id | Unique container id. | keyword |
-| container.image.name | Name of the image the container was built on. | keyword |
-| container.labels | Image labels. | object |
-| container.name | Container name. | keyword |
-| data_stream.dataset | Data stream dataset. | constant_keyword |
-| data_stream.namespace | Data stream namespace. | constant_keyword |
-| data_stream.type | Data stream type. | constant_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.module | Event module | constant_keyword |
-| host.architecture | Operating system architecture. | keyword |
-| host.containerized | If the host is a container. | boolean |
-| 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 |
-| host.hostname | Hostname of the host. It normally contains what the `hostname` command returns on the host machine. | keyword |
-| 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 |
-| host.ip | Host ip addresses. | ip |
-| host.mac | Host mac addresses. | keyword |
-| 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 |
-| host.os.build | OS build information. | keyword |
-| host.os.codename | OS codename, if any. | keyword |
-| host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword |
-| host.os.kernel | Operating system kernel version as a raw string. | keyword |
-| host.os.name | Operating system name, without the version. | keyword |
-| host.os.name.text | Multi-field of `host.os.name`. | text |
-| host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword |
-| host.os.version | Operating system version as a raw string. | keyword |
-| 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 |
-| 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 |
-| 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 |
-| service.version | Version of the service the data was collected from. This allows to look at a data set only for a specific version of a service. | keyword |
-| zookeeper.server.connections | Number of clients currently connected to the server | long |
-| zookeeper.server.count | Total transactions of the leader in epoch | long |
-| zookeeper.server.epoch | Epoch value of the Zookeeper transaction ID. An epoch signifies the period in which a server is a leader | long |
-| zookeeper.server.latency.avg | Average amount of time taken for the server to respond to a client request | long |
-| zookeeper.server.latency.max | Maximum amount of time taken for the server to respond to a client request | long |
-| zookeeper.server.latency.min | Minimum amount of time taken for the server to respond to a client request | long |
-| zookeeper.server.mode | Mode of the server. In an ensemble, this may either be leader or follower. Otherwise, it is standalone | keyword |
-| zookeeper.server.node_count | Total number of nodes | long |
-| zookeeper.server.outstanding | Number of requests queued at the server. This exceeds zero when the server receives more requests than it is able to process | long |
-| zookeeper.server.received | Number of requests received by the server | long |
-| zookeeper.server.sent | Number of requests sent by the server | long |
-| zookeeper.server.version_date | Date of the Zookeeper release currently in use | date |
-| zookeeper.server.zxid | Unique value of the Zookeeper transaction ID. The zxid consists of an epoch and a counter. It is established by the leader and is used to determine the temporal ordering of changes | keyword |
+| Field | Description | Type | Metric Type |
+|---|---|---|---|
+| @timestamp | Event timestamp. | date |  |
+| 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 |  |
+| cloud.availability_zone | Availability zone in which this host is running. | keyword |  |
+| cloud.image.id | Image ID for the cloud instance. | keyword |  |
+| cloud.instance.id | Instance ID of the host machine. | keyword |  |
+| cloud.instance.name | Instance name of the host machine. | keyword |  |
+| cloud.machine.type | Machine type of the host machine. | keyword |  |
+| cloud.project.id | Name of the project in Google Cloud. | keyword |  |
+| cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword |  |
+| cloud.region | Region in which this host is running. | keyword |  |
+| container.id | Unique container id. | keyword |  |
+| container.image.name | Name of the image the container was built on. | keyword |  |
+| container.labels | Image labels. | object |  |
+| container.name | Container name. | keyword |  |
+| data_stream.dataset | Data stream dataset. | constant_keyword |  |
+| data_stream.namespace | Data stream namespace. | constant_keyword |  |
+| data_stream.type | Data stream type. | constant_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.module | Event module | constant_keyword |  |
+| host.architecture | Operating system architecture. | keyword |  |
+| host.containerized | If the host is a container. | boolean |  |
+| 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 |  |
+| host.hostname | Hostname of the host. It normally contains what the `hostname` command returns on the host machine. | keyword |  |
+| 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 |  |
+| host.ip | Host ip addresses. | ip |  |
+| host.mac | Host mac addresses. | keyword |  |
+| 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 |  |
+| host.os.build | OS build information. | keyword |  |
+| host.os.codename | OS codename, if any. | keyword |  |
+| host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword |  |
+| host.os.kernel | Operating system kernel version as a raw string. | keyword |  |
+| host.os.name | Operating system name, without the version. | keyword |  |
+| host.os.name.text | Multi-field of `host.os.name`. | text |  |
+| host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword |  |
+| host.os.version | Operating system version as a raw string. | keyword |  |
+| 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 |  |
+| 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 |  |
+| 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 |  |
+| service.version | Version of the service the data was collected from. This allows to look at a data set only for a specific version of a service. | keyword |  |
+| zookeeper.server.connections | Number of clients currently connected to the server | long | gauge |
+| zookeeper.server.count | Total transactions of the leader in epoch | long | counter |
+| zookeeper.server.epoch | Epoch value of the Zookeeper transaction ID. An epoch signifies the period in which a server is a leader | long |  |
+| zookeeper.server.latency.avg | Average amount of time taken for the server to respond to a client request | long | gauge |
+| zookeeper.server.latency.max | Maximum amount of time taken for the server to respond to a client request | long | gauge |
+| zookeeper.server.latency.min | Minimum amount of time taken for the server to respond to a client request | long | gauge |
+| zookeeper.server.mode | Mode of the server. In an ensemble, this may either be leader or follower. Otherwise, it is standalone | keyword |  |
+| zookeeper.server.node_count | Total number of nodes | long | gauge |
+| zookeeper.server.outstanding | Number of requests queued at the server. This exceeds zero when the server receives more requests than it is able to process | long | gauge |
+| zookeeper.server.received | Number of requests received by the server | long | counter |
+| zookeeper.server.sent | Number of requests sent by the server | long | counter |
+| zookeeper.server.version_date | Date of the Zookeeper release currently in use | date |  |
+| zookeeper.server.zxid | Unique value of the Zookeeper transaction ID. The zxid consists of an epoch and a counter. It is established by the leader and is used to determine the temporal ordering of changes | keyword |  |
 
diff --git a/packages/zookeeper/manifest.yml b/packages/zookeeper/manifest.yml
@@ -1,6 +1,6 @@
 name: zookeeper
 title: ZooKeeper Metrics
-version: "1.8.1"
+version: "1.8.2"
 description: Collect metrics from ZooKeeper service with Elastic Agent.
 type: integration
 icons: