[Azure Storage Account] Add metric_type metadata to the storage_accou…

…nt datastream (#7488) * [Azure Storage Account] Add metric_type metadata to the storage_account datastream.
elastic · Oct 3, 2023 · 7142b33 · 7142b33
1 parent 39190a9
commit 7142b33
Show file tree

Hide file tree

Showing 5 changed files with 136 additions and 131 deletions.
diff --git a/packages/azure_metrics/changelog.yml b/packages/azure_metrics/changelog.yml
@@ -1,3 +1,8 @@
+- version: "1.1.1"
+  changes:
+    - description: Add metric_type metadata to the `storage_account` datastream
+      type: enhancement
+      link: https://github.com/elastic/integrations/pull/7488
 - version: "1.1.0"
   changes:
     - description: Add dimensions to the storage account datastream

diff --git a/packages/azure_metrics/data_stream/storage_account/fields/fields.yml b/packages/azure_metrics/data_stream/storage_account/fields/fields.yml
@@ -1,7 +1,7 @@
 - name: azure.storage_account.*.*
   type: object
   object_type: float
+  metric_type: gauge
   object_type_mapping_type: "*"
   description: >
-    storage account
-
+    storage account
diff --git a/packages/azure_metrics/docs/README.md b/packages/azure_metrics/docs/README.md
@@ -284,70 +284,70 @@ so the `period` for `storage_account` should be `300s` or multiples of `300s`.
 
 **Exported fields**
 
-| Field | Description | Type |
-|---|---|---|
-| @timestamp | Event timestamp. | date |
-| agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword |
-| azure.application_id | The application ID | keyword |
-| azure.dimensions.api_name | The name of operation. | keyword |
-| azure.dimensions.authentication | Authentication type used in transactions like OAuth. | keyword |
-| azure.dimensions.blob_type | Specifies the type of a blob. | keyword |
-| azure.dimensions.file_share | Specifies file share. | keyword |
-| azure.dimensions.geo_type | Transaction from Primary or Secondary cluster. The available values include Primary and Secondary. | keyword |
-| azure.dimensions.response_type | Transaction response type like Success, ClientOtherError, etc. | keyword |
-| azure.dimensions.tier | Specifies access tier. | keyword |
-| azure.dimensions.transaction_type | Type of transaction. The available values include User and System. | keyword |
-| azure.metrics.\*.\* | Metrics returned. | object |
-| azure.namespace | The namespace selected | keyword |
-| azure.resource.group | The resource group | keyword |
-| azure.resource.id | The id of the resource | keyword |
-| azure.resource.name | The name of the resource | keyword |
-| azure.resource.tags.\* | Azure resource tags. | object |
-| azure.resource.type | The type of the resource | keyword |
-| azure.storage_account.\*.\* | storage account | object |
-| azure.subscription_id | The subscription ID | keyword |
-| azure.timegrain | The Azure metric timegrain | keyword |
-| 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 |
-| container.runtime | Runtime managing this container. | keyword |
-| data_stream.dataset | Data stream dataset name. | constant_keyword |
-| data_stream.namespace | Data stream namespace. | constant_keyword |
-| data_stream.type | Data stream type. | constant_keyword |
-| dataset.name | Dataset name. | constant_keyword |
-| dataset.namespace | Dataset namespace. | constant_keyword |
-| dataset.type | Dataset 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 |
-| 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 |
-| 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 | Service address | 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 |
+| Field | Description | Type | Metric Type |
+|---|---|---|---|
+| @timestamp | Event timestamp. | date |  |
+| agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword |  |
+| azure.application_id | The application ID | keyword |  |
+| azure.dimensions.api_name | The name of operation. | keyword |  |
+| azure.dimensions.authentication | Authentication type used in transactions like OAuth. | keyword |  |
+| azure.dimensions.blob_type | Specifies the type of a blob. | keyword |  |
+| azure.dimensions.file_share | Specifies file share. | keyword |  |
+| azure.dimensions.geo_type | Transaction from Primary or Secondary cluster. The available values include Primary and Secondary. | keyword |  |
+| azure.dimensions.response_type | Transaction response type like Success, ClientOtherError, etc. | keyword |  |
+| azure.dimensions.tier | Specifies access tier. | keyword |  |
+| azure.dimensions.transaction_type | Type of transaction. The available values include User and System. | keyword |  |
+| azure.metrics.\*.\* | Metrics returned. | object |  |
+| azure.namespace | The namespace selected | keyword |  |
+| azure.resource.group | The resource group | keyword |  |
+| azure.resource.id | The id of the resource | keyword |  |
+| azure.resource.name | The name of the resource | keyword |  |
+| azure.resource.tags.\* | Azure resource tags. | object |  |
+| azure.resource.type | The type of the resource | keyword |  |
+| azure.storage_account.\*.\* | storage account | object | gauge |
+| azure.subscription_id | The subscription ID | keyword |  |
+| azure.timegrain | The Azure metric timegrain | keyword |  |
+| 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 |  |
+| container.runtime | Runtime managing this container. | keyword |  |
+| data_stream.dataset | Data stream dataset name. | constant_keyword |  |
+| data_stream.namespace | Data stream namespace. | constant_keyword |  |
+| data_stream.type | Data stream type. | constant_keyword |  |
+| dataset.name | Dataset name. | constant_keyword |  |
+| dataset.namespace | Dataset namespace. | constant_keyword |  |
+| dataset.type | Dataset 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 |  |
+| 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 |  |
+| 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 | Service address | 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 |  |
 
 
 `container_instance`