Skip to content

Commit a549f5c

Browse files
devamanvdevamanv
authored
[rubrik] Update docs and enable tsdb for sla domains and unmanaged objects (elastic#13006)
1 parent 0641271 commit a549f5c

File tree

16 files changed

+69
-62
lines changed

16 files changed

+69
-62
lines changed

‎packages/rubrik/_dev/build/docs/README.md

+17-10
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,33 @@
11
# Rubrik RSC Metrics Integration
22

3-
This integration periodically fetches metrics from [Rubrik GraphQL API](https://www.rubrik.com/resources/api-integration). It collects a wide range of metrics including virtual machines, filesets, volumes, node statistics, and drives performance.
3+
The Rubrik integration allows you to monitor your Rubrik Security Cloud (RSC) and Rubrik Cloud Data Management (CDM) environments. Rubrik provides a data security and protection platform that delivers backup, recovery, and threat detection across hybrid and multi-cloud environments.
44

5-
These metrics help you understand how to properly manage your Rubrik infrastructure.
5+
Use the Rubrik integration to collect metrics and logs related to snapshots, backups, SLA domains, storage usage, protection status, and RSC-managed clusters. The integration helps monitor a wide range of protected objects such as virtual machines, databases, filesets, and physical hosts. Then visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference metrics and logs when troubleshooting an issue.
66

7-
## Compatibility
7+
For example, you could use the data from this integration to detect SLA non-compliance, track the number of protected or unprotected objects, monitor backup job status, or investigate storage trends across clusters. You can also troubleshoot failed backup jobs, identify under-protected assets, and proactively respond to anomalies across your Rubrik-managed infrastructure.
88

9-
The integration uses the [HTTP JSON input](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-httpjson.html) to collect metrics from Rubrik APIs.
9+
## Compatibility
10+
This integration has been tested with:
11+
- Rubrik Security Cloud(RSC)
12+
- Rubrik CDM 6.0x API
13+
- Rubrik CDM 9.1x API
1014

1115
## Requirements
1216

1317
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
1418
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
1519

16-
## Configuration
20+
## Setup
1721

1822
To configure this integration in Elastic, you need the following information:
1923

20-
- Hostname
21-
- Client ID
22-
- Client Secret
23-
- Token URL
24+
- **Hostname** is the account name of your Rubrik domain.
25+
- **Client ID** is the client ID of the service account.
26+
- **Client Secret** is the client secret of the service account.
27+
- **Cluster UUID** is the ID of the registered Rubrik cluster.
28+
- **Cluster IP** is the Rubrik cluster IP or a resolvable host name.
29+
30+
NOTE: Cluster IP and Cluster UUID are required to access the Rubrik REST APIs.
2431

2532
For more details on these settings, refer to the [Rubrik official documentation](https://docs.rubrik.com/en-us/saas/saas/adding_a_service_account.html).
2633

@@ -31,7 +38,7 @@ For more details on these settings, refer to the [Rubrik official documentation]
3138
3. Click on "Rubrik RSC Metrics" integration from the search results
3239
4. Click on the **Add Rubrik RSC Metrics Integration** button to add the integration
3340

34-
## Metrics
41+
## Metrics Reference
3542

3643
### Managed Volumes
3744

‎packages/rubrik/changelog.yml

+8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
# newer versions go on top
2+
- version: "0.9.0"
3+
changes:
4+
- description: |
5+
Enable TSDB for SLA Domains and Unmanaged objects.
6+
Update docs.
7+
Move common config at the top level and remove the token_url field.
8+
type: enhancement
9+
link: https://github.com/elastic/integrations/pull/13006
210
- version: "0.8.0"
311
changes:
412
- description: |

‎packages/rubrik/data_stream/drives/agent/stream/cel.yml.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ interval: {{interval}}
33
auth.oauth2:
44
client.id: {{client_id}}
55
client.secret: {{client_secret}}
6-
token_url: {{token_url}}
6+
token_url: https://{{hostname}}.my.rubrik.com/api/client_token
77

88
resource.url: https://{{hostname}}.my.rubrik.com/api/graphql
99
{{#if ssl}}

‎packages/rubrik/data_stream/filesets/agent/stream/cel.yml.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ interval: {{interval}}
33
auth.oauth2:
44
client.id: {{client_id}}
55
client.secret: {{client_secret}}
6-
token_url: {{token_url}}
6+
token_url: https://{{hostname}}.my.rubrik.com/api/client_token
77

88
resource.url: https://{{hostname}}.my.rubrik.com/api/graphql
99
{{#if ssl}}

‎packages/rubrik/data_stream/global_cluster_performance/agent/stream/cel.yml.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ interval: {{interval}}
33
auth.oauth2:
44
client.id: {{client_id}}
55
client.secret: {{client_secret}}
6-
token_url: {{token_url}}
6+
token_url: https://{{hostname}}.my.rubrik.com/api/client_token
77

88
resource.url: https://{{hostname}}.my.rubrik.com/api/graphql
99
{{#if ssl}}

‎packages/rubrik/data_stream/managed_volumes/agent/stream/cel.yml.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ interval: {{interval}}
33
auth.oauth2:
44
client.id: {{client_id}}
55
client.secret: {{client_secret}}
6-
token_url: {{token_url}}
6+
token_url: https://{{hostname}}.my.rubrik.com/api/client_token
77

88
resource.url: https://{{hostname}}.my.rubrik.com/api/graphql
99
{{#if ssl}}

‎packages/rubrik/data_stream/monitoring_jobs/agent/stream/cel.yml.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ interval: {{interval}}
33
auth.oauth2:
44
client.id: {{client_id}}
55
client.secret: {{client_secret}}
6-
token_url: {{token_url}}
6+
token_url: https://{{hostname}}.my.rubrik.com/api/client_token
77

88
resource.url: https://{{hostname}}.my.rubrik.com/api/graphql
99
{{#if ssl}}

‎packages/rubrik/data_stream/mssql_databases/agent/stream/cel.yml.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ interval: {{interval}}
33
auth.oauth2:
44
client.id: {{client_id}}
55
client.secret: {{client_secret}}
6-
token_url: {{token_url}}
6+
token_url: https://{{hostname}}.my.rubrik.com/api/client_token
77

88
resource.url: https://{{hostname}}.my.rubrik.com/api/graphql
99
{{#if ssl}}

‎packages/rubrik/data_stream/node_statistics/agent/stream/cel.yml.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ interval: {{interval}}
33
auth.oauth2:
44
client.id: {{client_id}}
55
client.secret: {{client_secret}}
6-
token_url: {{token_url}}
6+
token_url: https://{{hostname}}.my.rubrik.com/api/client_token
77

88
resource.url: https://{{hostname}}.my.rubrik.com/api/graphql
99
{{#if ssl}}

‎packages/rubrik/data_stream/physical_hosts/agent/stream/cel.yml.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ interval: {{interval}}
33
auth.oauth2:
44
client.id: {{client_id}}
55
client.secret: {{client_secret}}
6-
token_url: {{token_url}}
6+
token_url: https://{{hostname}}.my.rubrik.com/api/client_token
77

88
resource.url: https://{{hostname}}.my.rubrik.com/api/graphql
99
{{#if ssl}}

‎packages/rubrik/data_stream/sla_domains/manifest.yml

+3-14
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,6 @@ streams:
77
enabled: true
88
template_path: cel.yml.hbs
99
vars:
10-
- name: cluster_ip
11-
type: text
12-
title: Cluster IP
13-
description: IP of the cluster.
14-
multi: false
15-
required: true
16-
show_user: true
17-
- name: cluster_uuid
18-
type: text
19-
title: Cluster UUID
20-
multi: false
21-
required: true
22-
show_user: true
23-
description: The UUID of the Rubrik cluster
2410
- name: resource_timeout
2511
type: text
2612
title: Resource Timeout
@@ -61,3 +47,6 @@ streams:
6147
type: bool
6248
multi: false
6349
default: false
50+
51+
elasticsearch:
52+
index_mode: time_series

‎packages/rubrik/data_stream/tasks/agent/stream/cel.yml.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ interval: {{interval}}
33
auth.oauth2:
44
client.id: {{client_id}}
55
client.secret: {{client_secret}}
6-
token_url: {{token_url}}
6+
token_url: https://{{hostname}}.my.rubrik.com/api/client_token
77

88
resource.url: https://{{hostname}}.my.rubrik.com/api/graphql
99
{{#if ssl}}

‎packages/rubrik/data_stream/unmanaged_objects/manifest.yml

+3-14
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,6 @@ streams:
77
enabled: true
88
template_path: cel.yml.hbs
99
vars:
10-
- name: cluster_ip
11-
type: text
12-
title: Cluster IP
13-
description: IP of the cluster.
14-
multi: false
15-
required: true
16-
show_user: true
17-
- name: cluster_uuid
18-
type: text
19-
title: Cluster UUID
20-
multi: false
21-
required: true
22-
show_user: true
23-
description: The UUID of the Rubrik cluster
2410
- name: resource_timeout
2511
type: text
2612
title: Resource Timeout
@@ -61,3 +47,6 @@ streams:
6147
type: bool
6248
multi: false
6349
default: false
50+
51+
elasticsearch:
52+
index_mode: time_series

‎packages/rubrik/data_stream/virtual_machines/agent/stream/cel.yml.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ interval: {{interval}}
33
auth.oauth2:
44
client.id: {{client_id}}
55
client.secret: {{client_secret}}
6-
token_url: {{token_url}}
6+
token_url: https://{{hostname}}.my.rubrik.com/api/client_token
77

88
resource.url: https://{{hostname}}.my.rubrik.com/api/graphql
99
{{#if ssl}}

‎packages/rubrik/docs/README.md

+17-10
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,33 @@
11
# Rubrik RSC Metrics Integration
22

3-
This integration periodically fetches metrics from [Rubrik GraphQL API](https://www.rubrik.com/resources/api-integration). It collects a wide range of metrics including virtual machines, filesets, volumes, node statistics, and drives performance.
3+
The Rubrik integration allows you to monitor your Rubrik Security Cloud (RSC) and Rubrik Cloud Data Management (CDM) environments. Rubrik provides a data security and protection platform that delivers backup, recovery, and threat detection across hybrid and multi-cloud environments.
44

5-
These metrics help you understand how to properly manage your Rubrik infrastructure.
5+
Use the Rubrik integration to collect metrics and logs related to snapshots, backups, SLA domains, storage usage, protection status, and RSC-managed clusters. The integration helps monitor a wide range of protected objects such as virtual machines, databases, filesets, and physical hosts. Then visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference metrics and logs when troubleshooting an issue.
66

7-
## Compatibility
7+
For example, you could use the data from this integration to detect SLA non-compliance, track the number of protected or unprotected objects, monitor backup job status, or investigate storage trends across clusters. You can also troubleshoot failed backup jobs, identify under-protected assets, and proactively respond to anomalies across your Rubrik-managed infrastructure.
88

9-
The integration uses the [HTTP JSON input](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-httpjson.html) to collect metrics from Rubrik APIs.
9+
## Compatibility
10+
This integration has been tested with:
11+
- Rubrik Security Cloud(RSC)
12+
- Rubrik CDM 6.0x API
13+
- Rubrik CDM 9.1x API
1014

1115
## Requirements
1216

1317
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
1418
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
1519

16-
## Configuration
20+
## Setup
1721

1822
To configure this integration in Elastic, you need the following information:
1923

20-
- Hostname
21-
- Client ID
22-
- Client Secret
23-
- Token URL
24+
- **Hostname** is the account name of your Rubrik domain.
25+
- **Client ID** is the client ID of the service account.
26+
- **Client Secret** is the client secret of the service account.
27+
- **Cluster UUID** is the ID of the registered Rubrik cluster.
28+
- **Cluster IP** is the Rubrik cluster IP or a resolvable host name.
29+
30+
NOTE: Cluster IP and Cluster UUID are required to access the Rubrik REST APIs.
2431

2532
For more details on these settings, refer to the [Rubrik official documentation](https://docs.rubrik.com/en-us/saas/saas/adding_a_service_account.html).
2633

@@ -31,7 +38,7 @@ For more details on these settings, refer to the [Rubrik official documentation]
3138
3. Click on "Rubrik RSC Metrics" integration from the search results
3239
4. Click on the **Add Rubrik RSC Metrics Integration** button to add the integration
3340

34-
## Metrics
41+
## Metrics Reference
3542

3643
### Managed Volumes
3744

‎packages/rubrik/manifest.yml

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
format_version: 3.0.2
22
name: rubrik
33
title: "Rubrik RSC Metrics"
4-
version: 0.8.0
4+
version: 0.9.0
55
source:
66
license: "Elastic-2.0"
77
description: "Collect Metrics from Rubrik RSC with Elastic Agent."
@@ -44,13 +44,20 @@ vars:
4444
required: true
4545
show_user: true
4646
secret: true
47-
- name: token_url
47+
- name: cluster_ip
4848
type: text
49-
title: Token URL
50-
description: Token URL of Rubrik.
49+
title: Cluster IP
50+
description: IP of the cluster.
5151
multi: false
5252
required: true
5353
show_user: true
54+
- name: cluster_uuid
55+
type: text
56+
title: Cluster UUID
57+
multi: false
58+
required: true
59+
show_user: true
60+
description: The UUID of the Rubrik cluster
5461
- name: ssl
5562
type: yaml
5663
title: Resource SSL Configuration

0 commit comments

Comments
 (0)