[Azure][Storage_account] Add dimension to the storage account datastr…

…eam (#7356) * [Azure][Storage_account] Add dimension to the storage account datastream and update Kibana version.
elastic · Oct 3, 2023 · 39190a9 · 39190a9
1 parent 32ebef3
commit 39190a9
Show file tree

Hide file tree

Showing 8 changed files with 69 additions and 13 deletions.
diff --git a/packages/azure_metrics/changelog.yml b/packages/azure_metrics/changelog.yml
@@ -1,3 +1,8 @@
+- version: "1.1.0"
+  changes:
+    - description: Add dimensions to the storage account datastream
+      type: enhancement
+      link: https://github.com/elastic/integrations/pull/7356
 - version: "1.0.43"
   changes:
     - description: Migrate File Storage Overview dashboard to lens.

diff --git a/packages/azure_metrics/data_stream/storage_account/fields/agent.yml b/packages/azure_metrics/data_stream/storage_account/fields/agent.yml
@@ -45,6 +45,7 @@
     - name: region
       level: extended
       type: keyword
+      dimension: true
       ignore_above: 1024
       description: Region in which this host is running.
       example: us-east-1
@@ -194,5 +195,4 @@
       type: keyword
       example: "stretch"
       description: >
-        OS codename, if any.
-
+        OS codename, if any.
diff --git a/packages/azure_metrics/data_stream/storage_account/fields/ecs.yml b/packages/azure_metrics/data_stream/storage_account/fields/ecs.yml
@@ -15,3 +15,6 @@
   external: ecs
 - name: host
   external: ecs
+- name: agent.id
+  external: ecs
+  dimension: true
diff --git a/packages/azure_metrics/data_stream/storage_account/fields/package-fields.yml b/packages/azure_metrics/data_stream/storage_account/fields/package-fields.yml
@@ -4,6 +4,7 @@
   fields:
     - name: timegrain
       type: keyword
+      dimension: true
       description: >
         The Azure metric timegrain
 
@@ -25,6 +26,7 @@
 
         - name: id
           type: keyword
+          dimension: true
           description: >
             The id of the resource
 
@@ -42,6 +44,7 @@
 
     - name: namespace
       type: keyword
+      dimension: true
       description: >
         The namespace selected
 
@@ -55,12 +58,41 @@
       description: >
         The application ID
 
-    - name: dimensions.*
-      type: object
-      object_type: keyword
-      object_type_mapping_type: "*"
-      description: >
-        Azure metric dimensions.
+    - name: dimensions
+      type: group
+      fields:
+        - name: response_type
+          type: keyword
+          dimension: true
+          description: Transaction response type like Success, ClientOtherError, etc.
+        - name: api_name
+          type: keyword
+          dimension: true
+          description: The name of operation.
+        - name: geo_type
+          type: keyword
+          dimension: true
+          description: Transaction from Primary or Secondary cluster. The available values include Primary and Secondary.
+        - name: authentication
+          type: keyword
+          dimension: true
+          description: Authentication type used in transactions like OAuth.
+        - name: blob_type
+          type: keyword
+          dimension: true
+          description: Specifies the type of a blob.
+        - name: tier
+          type: keyword
+          dimension: true
+          description: Specifies access tier.
+        - name: file_share
+          type: keyword
+          dimension: true
+          description: Specifies file share.
+        - name: transaction_type
+          type: keyword
+          dimension: true
+          description: Type of transaction. The available values include User and System.
 
     - name: metrics.*.*
       type: object

diff --git a/packages/azure_metrics/data_stream/storage_account/manifest.yml b/packages/azure_metrics/data_stream/storage_account/manifest.yml
@@ -31,4 +31,4 @@ streams:
         required: false
         show_user: true
     title: Storage Account
-    description: Collect Storage Account metrics
+    description: Collect Storage Account metrics
diff --git a/packages/azure_metrics/docs/README.md b/packages/azure_metrics/docs/README.md
@@ -287,8 +287,16 @@ so the `period` for `storage_account` should be `300s` or multiples of `300s`.
 | 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.\* | Azure metric dimensions. | object |
+| 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 |

diff --git a/packages/azure_metrics/docs/storage_account.md b/packages/azure_metrics/docs/storage_account.md
@@ -73,8 +73,16 @@ Authentication: we are handling authentication on our side (creating/renewing th
 | 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.\* | Azure metric dimensions. | object |
+| 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 |

diff --git a/packages/azure_metrics/manifest.yml b/packages/azure_metrics/manifest.yml
@@ -1,6 +1,6 @@
 name: azure_metrics
 title: Azure Resource Metrics
-version: 1.0.43
+version: 1.1.0
 release: ga
 description: Collect metrics from Azure resources with Elastic Agent.
 type: integration
@@ -20,7 +20,7 @@ categories:
   - observability
   - azure
 conditions:
-  kibana.version: "^8.9.0"
+  kibana.version: "^8.10.2"
 vars:
   - name: client_id
     type: text