Update docs with the sample event and field names

elastic · Mar 1, 2025 · 0fbed55 · 0fbed55
1 parent 5e111ba
commit 0fbed55
Show file tree

Hide file tree

Showing 2 changed files with 117 additions and 3 deletions.
diff --git a/packages/rubrik/_dev/build/docs/README.md b/packages/rubrik/_dev/build/docs/README.md
@@ -155,12 +155,24 @@ Please refer to the following [document](https://www.elastic.co/guide/en/ecs/cur
 
 ### Unmanaged Objects
 
-The `unmanaged_objects` dataset provides metrics related to the performance of the Rubrik cluster nodes.
+The `unmanaged_objects` dataset provides unmanaged object snapshot and storage metrics.
 
 **ECS Field Reference**
 
 Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
 
 {{fields "unmanaged_objects"}}
 
-{{event "unmanaged_objects"}}
+{{event "unmanaged_objects"}}
+
+### SLA Domains
+
+The `sla_domains` dataset captures key metrics and configurations of Service Level Agreement (SLA) policy domains in a Rubrik environment, including details on the number of protected objects, such as virtual machines, databases, filesets, and hosts.
+
+**ECS Field Reference**
+
+Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
+
+{{fields "sla_domains"}}
+
+{{event "sla_domains"}}
diff --git a/packages/rubrik/docs/README.md b/packages/rubrik/docs/README.md
@@ -1172,7 +1172,7 @@ An example event for `node_statistics` looks as following:
 
 ### Unmanaged Objects
 
-The `unmanaged_objects` dataset provides metrics related to the performance of the Rubrik cluster nodes.
+The `unmanaged_objects` dataset provides unmanaged object snapshot and storage metrics.
 
 **ECS Field Reference**
 
@@ -1277,4 +1277,106 @@ An example event for `unmanaged_objects` looks as following:
         "rubrik.unmanaged_objects"
     ]
 }
+```
+
+### SLA Domains
+
+The `sla_domains` dataset captures key metrics and configurations of Service Level Agreement (SLA) policy domains in a Rubrik environment, including details on the number of protected objects, such as virtual machines, databases, filesets, and hosts.
+
+**ECS Field Reference**
+
+Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
+
+**Exported fields**
+
+| Field | Description | Type | Metric Type |
+|---|---|---|---|
+| @timestamp | Event timestamp. | date |  |
+| data_stream.dataset | Data stream dataset. | constant_keyword |  |
+| data_stream.namespace | Data stream namespace. | constant_keyword |  |
+| data_stream.type | Data stream type. | constant_keyword |  |
+| rubrik.sla_domains.dbs.count | Number of databases. | long | gauge |
+| rubrik.sla_domains.filesets.count | Number of filesets. | long | gauge |
+| rubrik.sla_domains.id | The ID of the SLA domain. | keyword |  |
+| rubrik.sla_domains.linux_hosts.count | Number of physical Linux hosts. | long | gauge |
+| rubrik.sla_domains.name | The name of the SLA domain. | keyword |  |
+| rubrik.sla_domains.vms.count | Number of virtual machines. | long | gauge |
+| rubrik.sla_domains.windows_hosts.count | Number of physical Winux hosts. | long | gauge |
+
+
+An example event for `sla_domains` looks as following:
+
+```json
+{
+    "agent": {
+        "name": "docker-fleet-agent",
+        "id": "04f90ee5-976b-4bc4-8ad6-5ed776487c8d",
+        "ephemeral_id": "3c4f4447-00a4-4594-823d-8868a0d6a7e0",
+        "type": "filebeat",
+        "version": "8.13.1"
+    },
+    "rubrik": {
+        "sla_domains": {
+            "dbs": {
+                "count": 1
+            },
+            "filesets": {
+                "count": 1
+            },
+            "id": "6fc7ca5c-5926-4a85-b236-a43a9935dff9",
+            "linux_hosts": {
+                "count": 1
+            },
+            "name": "cluster-1",
+            "vms": {
+                "count": 0
+            },
+            "windows_hosts": {
+                "count": 0
+            }
+        }
+    },
+    "@timestamp": "2025-02-19T14:46:25.854Z",
+    "ecs": {
+        "version": "8.16.0"
+    },
+    "data_stream": {
+        "namespace": "default",
+        "type": "metrics",
+        "dataset": "rubrik.sla_domains"
+    },
+    "host": {
+        "hostname": "docker-fleet-agent",
+        "os": {
+            "kernel": "6.10.14-linuxkit",
+            "codename": "focal",
+            "name": "Ubuntu",
+            "type": "linux",
+            "family": "debian",
+            "version": "20.04.6 LTS (Focal Fossa)",
+            "platform": "ubuntu"
+        },
+        "containerized": false,
+        "ip": [
+            "172.18.0.7"
+        ],
+        "name": "docker-fleet-agent",
+        "id": "0c943706945f4061b59521bb029d64e5",
+        "mac": [
+            "02-42-AC-12-00-07"
+        ],
+        "architecture": "arch64"
+    },
+    "elastic_agent": {
+        "id": "04f90ee5-976b-4bc4-8ad6-5ed776487c8d",
+        "version": "8.13.1",
+        "snapshot": false
+    },
+    "event": {
+        "agent_id_status": "verified",
+        "ingested": "2025-02-19T14:46:35Z",
+        "kind": "metric",
+        "dataset": "rubrik.sla_domains"
+    }
+}
 ```