Rename new field to azure.resourcegroup.name to align with otel

elastic · Mar 4, 2024 · 0e08561 · 0e08561
1 parent 9c7cd50
commit 0e08561
Show file tree

Hide file tree

Showing 20 changed files with 185 additions and 112 deletions.
diff --git a/auditbeat/docs/fields.asciidoc b/auditbeat/docs/fields.asciidoc
@@ -15,6 +15,7 @@ This document describes the fields that are exported by Auditbeat. They are
 grouped in the following categories:
 
 * <<exported-fields-auditd>>
+* <<exported-fields-azure>>
 * <<exported-fields-beat-common>>
 * <<exported-fields-cloud>>
 * <<exported-fields-common>>
@@ -2414,6 +2415,24 @@ type: geo_point
 
 --
 
+[[exported-fields-azure]]
+== Azure Cloud provider metadata fields
+
+Metadata from azure cloud providers added by the add_cloud_metadata processor.
+
+
+
+
+*`azure.resourcegroup.name`*::
++
+--
+Name of resourceGroup the azure cloud instance belongs to.
+
+
+type: keyword
+
+--
+
 [[exported-fields-beat-common]]
 == Beat fields
 
@@ -2496,17 +2515,6 @@ example: ami-abcd1234
 
 --
 
-
-*`cloud.resource_group.name`*::
-+
---
-Name of resourceGroup the cloud instance belongs to.
-
-
-type: keyword
-
---
-
 *`meta.cloud.provider`*::
 +
 --

diff --git a/auditbeat/include/fields.go b/auditbeat/include/fields.go
diff --git a/filebeat/docs/fields.asciidoc b/filebeat/docs/fields.asciidoc
@@ -21,6 +21,7 @@ grouped in the following categories:
 * <<exported-fields-aws-cloudwatch>>
 * <<exported-fields-awsfargate>>
 * <<exported-fields-azure>>
+* <<exported-fields-azure>>
 * <<exported-fields-barracuda>>
 * <<exported-fields-beat-common>>
 * <<exported-fields-bluecoat>>
@@ -2126,6 +2127,24 @@ Fields from Amazon ECS Fargate logs.
 Fields for Amazon Fargate container logs.
 
 
+[[exported-fields-azure]]
+== Azure Cloud provider metadata fields
+
+Metadata from azure cloud providers added by the add_cloud_metadata processor.
+
+
+
+
+*`azure.resourcegroup.name`*::
++
+--
+Name of resourceGroup the azure cloud instance belongs to.
+
+
+type: keyword
+
+--
+
 [[exported-fields-azure]]
 == Azure fields
 
@@ -27699,17 +27718,6 @@ example: ami-abcd1234
 
 --
 
-
-*`cloud.resource_group.name`*::
-+
---
-Name of resourceGroup the cloud instance belongs to.
-
-
-type: keyword
-
---
-
 *`meta.cloud.provider`*::
 +
 --

diff --git a/filebeat/include/fields.go b/filebeat/include/fields.go
diff --git a/heartbeat/docs/fields.asciidoc b/heartbeat/docs/fields.asciidoc
@@ -14,6 +14,7 @@ This file is generated! See _meta/fields.yml and scripts/generate_fields_docs.py
 This document describes the fields that are exported by Heartbeat. They are
 grouped in the following categories:
 
+* <<exported-fields-azure>>
 * <<exported-fields-beat-common>>
 * <<exported-fields-browser>>
 * <<exported-fields-cloud>>
@@ -36,6 +37,24 @@ grouped in the following categories:
 * <<exported-fields-tls>>
 
 --
+[[exported-fields-azure]]
+== Azure Cloud provider metadata fields
+
+Metadata from azure cloud providers added by the add_cloud_metadata processor.
+
+
+
+
+*`azure.resourcegroup.name`*::
++
+--
+Name of resourceGroup the azure cloud instance belongs to.
+
+
+type: keyword
+
+--
+
 [[exported-fields-beat-common]]
 == Beat fields
 
@@ -258,17 +277,6 @@ example: ami-abcd1234
 
 --
 
-
-*`cloud.resource_group.name`*::
-+
---
-Name of resourceGroup the cloud instance belongs to.
-
-
-type: keyword
-
---
-
 *`meta.cloud.provider`*::
 +
 --

diff --git a/heartbeat/include/fields.go b/heartbeat/include/fields.go
diff --git a/libbeat/processors/add_cloud_metadata/_meta/fields.yml b/libbeat/processors/add_cloud_metadata/_meta/fields.yml
@@ -9,14 +9,6 @@
       example: ami-abcd1234
       description: >
         Image ID for the cloud instance.
-    - name: cloud.resource_group
-      default_field: true
-      type: group
-      fields:
-        - name: name
-          type: keyword
-          description: >
-            Name of resourceGroup the cloud instance belongs to.
     # Alias for old fields
     - name: meta.cloud.provider
       default_field: true
@@ -59,5 +51,17 @@
       type: alias
       path: cloud.region
       migration: true
-
+- key: azure
+  title: Azure Cloud provider metadata
+  description: >
+    Metadata from azure cloud providers added by the add_cloud_metadata processor.
+  fields:
+    - name: azure.resourcegroup
+      default_field: true
+      type: group
+      fields:
+        - name: name
+          type: keyword
+          description: >
+            Name of resourceGroup the azure cloud instance belongs to.
     
diff --git a/libbeat/processors/add_cloud_metadata/docs/add_cloud_metadata.asciidoc b/libbeat/processors/add_cloud_metadata/docs/add_cloud_metadata.asciidoc
@@ -159,13 +159,15 @@ _Azure Virtual Machine_
 [source,json]
 -------------------------------------------------------------------------------
 {
+  "azure": {
+    "resourcegroup.name": "/subscriptions/641ebacb-7743-41e7-b4fa-af1167351a61/resourcegroups/testgroup/providers/Microsoft.ContainerService/managedClusters/testcluster"
+  },
   "cloud": {
     "provider": "azure",
     "instance.id": "04ab04c3-63de-4709-a9f9-9ab8c0411d5e",
     "instance.name": "test-az-vm",
     "machine.type": "Standard_D3_v2",
-    "region": "eastus2",
-    "resource_group.name": "/subscriptions/641ebacb-7743-41e7-b4fa-af1167351a61/resourcegroups/testgroup/providers/Microsoft.ContainerService/managedClusters/testcluster"
+    "region": "eastus2"
   }
 }
 -------------------------------------------------------------------------------

diff --git a/libbeat/processors/add_cloud_metadata/provider_azure_vm.go b/libbeat/processors/add_cloud_metadata/provider_azure_vm.go
@@ -69,7 +69,7 @@ var azureVMMetadataFetcher = provider{
 		azHeaders := map[string]string{"Metadata": "true"}
 		azHttpSchema := func(m map[string]interface{}) mapstr.M {
 			m["serviceName"] = "Virtual Machines"
-			out, _ := s.Schema{
+			cloud, _ := s.Schema{
 				"account": s.Object{
 					"id": c.Str("subscriptionId"),
 				},
@@ -84,11 +84,14 @@ var azureVMMetadataFetcher = provider{
 					"name": c.Str("serviceName"),
 				},
 				"region": c.Str("location"),
-				"resource_group": s.Object{
+			}.Apply(m)
+
+			azure, _ := s.Schema{
+				"resourcegroup": s.Object{
 					"name": c.Str("resourceGroupName"),
 				},
 			}.Apply(m)
-			return mapstr.M{"cloud": out}
+			return mapstr.M{"cloud": cloud, "azure": azure}
 		}
 
 		azGenSchema := func(m map[string]interface{}) mapstr.M {
@@ -186,7 +189,7 @@ func (az *azureMetadataFetcher) fetchAzureClusterMeta(
 ) {
 	logger := logp.NewLogger("add_cloud_metadata")
 	subscriptionId, _ := az.httpMeta.GetValue("cloud.account.id")
-	resourceGroupName, _ := az.httpMeta.GetValue("cloud.resource_group.name")
+	resourceGroupName, _ := az.httpMeta.GetValue("azure.resourcegroup.name")
 	strResourceGroupName := ""
 	if val, ok := resourceGroupName.(string); ok {
 		strResourceGroupName = val

diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -21,6 +21,7 @@ grouped in the following categories:
 * <<exported-fields-aws>>
 * <<exported-fields-awsfargate>>
 * <<exported-fields-azure>>
+* <<exported-fields-azure>>
 * <<exported-fields-beat-common>>
 * <<exported-fields-beat>>
 * <<exported-fields-ceph>>
@@ -5609,6 +5610,24 @@ type: long
 
 --
 
+[[exported-fields-azure]]
+== Azure Cloud provider metadata fields
+
+Metadata from azure cloud providers added by the add_cloud_metadata processor.
+
+
+
+
+*`azure.resourcegroup.name`*::
++
+--
+Name of resourceGroup the azure cloud instance belongs to.
+
+
+type: keyword
+
+--
+
 [[exported-fields-azure]]
 == Azure fields
 
@@ -10095,17 +10114,6 @@ example: ami-abcd1234
 
 --
 
-
-*`cloud.resource_group.name`*::
-+
---
-Name of resourceGroup the cloud instance belongs to.
-
-
-type: keyword
-
---
-
 *`meta.cloud.provider`*::
 +
 --

diff --git a/metricbeat/include/fields/fields.go b/metricbeat/include/fields/fields.go
diff --git a/packetbeat/docs/fields.asciidoc b/packetbeat/docs/fields.asciidoc
@@ -15,6 +15,7 @@ This document describes the fields that are exported by Packetbeat. They are
 grouped in the following categories:
 
 * <<exported-fields-amqp>>
+* <<exported-fields-azure>>
 * <<exported-fields-beat-common>>
 * <<exported-fields-cassandra>>
 * <<exported-fields-cloud>>
@@ -441,6 +442,24 @@ type: keyword
 Creating application id.
 
 
+type: keyword
+
+--
+
+[[exported-fields-azure]]
+== Azure Cloud provider metadata fields
+
+Metadata from azure cloud providers added by the add_cloud_metadata processor.
+
+
+
+
+*`azure.resourcegroup.name`*::
++
+--
+Name of resourceGroup the azure cloud instance belongs to.
+
+
 type: keyword
 
 --
@@ -1284,17 +1303,6 @@ example: ami-abcd1234
 
 --
 
-
-*`cloud.resource_group.name`*::
-+
---
-Name of resourceGroup the cloud instance belongs to.
-
-
-type: keyword
-
---
-
 *`meta.cloud.provider`*::
 +
 --

diff --git a/packetbeat/include/fields.go b/packetbeat/include/fields.go
diff --git a/winlogbeat/docs/fields.asciidoc b/winlogbeat/docs/fields.asciidoc
@@ -14,6 +14,7 @@ This file is generated! See _meta/fields.yml and scripts/generate_fields_docs.py
 This document describes the fields that are exported by Winlogbeat. They are
 grouped in the following categories:
 
+* <<exported-fields-azure>>
 * <<exported-fields-beat-common>>
 * <<exported-fields-cloud>>
 * <<exported-fields-docker-processor>>
@@ -29,6 +30,24 @@ grouped in the following categories:
 * <<exported-fields-winlog>>
 
 --
+[[exported-fields-azure]]
+== Azure Cloud provider metadata fields
+
+Metadata from azure cloud providers added by the add_cloud_metadata processor.
+
+
+
+
+*`azure.resourcegroup.name`*::
++
+--
+Name of resourceGroup the azure cloud instance belongs to.
+
+
+type: keyword
+
+--
+
 [[exported-fields-beat-common]]
 == Beat fields
 
@@ -111,17 +130,6 @@ example: ami-abcd1234
 
 --
 
-
-*`cloud.resource_group.name`*::
-+
---
-Name of resourceGroup the cloud instance belongs to.
-
-
-type: keyword
-
---
-
 *`meta.cloud.provider`*::
 +
 --

diff --git a/winlogbeat/include/fields.go b/winlogbeat/include/fields.go