Skip to content

Commit c96d88c

Browse files
committed
RS: Added call home client info to RS 7.22 release notes and REST API reference
1 parent bc3c5cb commit c96d88c

File tree

4 files changed

+53
-2
lines changed

4 files changed

+53
-2
lines changed

content/operate/rs/references/rest-api/objects/services_configuration/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Optional cluster services settings
1616
| Name | Type/Value | Description |
1717
|------|------------|-------------|
1818
| alert_mgr | [alert_mgr]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/alert_mgr" >}}) object | Whether to enable/disable the alert manager processes |
19+
| call_home_agent | [call_home_agent]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/call_home_agent" >}}) object | Whether to enable/disable the call_home_agent process, which sends daily usage statistics to Redis |
1920
| cm_server | [cm_server]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/cm_server" >}}) object | Whether to enable/disable the CM server |
2021
| crdb_coordinator | [crdb_coordinator]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/crdb_coordinator" >}}) object | Whether to enable/disable the CRDB coordinator process |
2122
| crdb_worker | [crdb_worker]({{< relref "/operate/rs/references/rest-api/objects/services_configuration/crdb_worker" >}}) object | Whether to enable/disable the CRDB worker processes |
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
Title: Call home agent object
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- operate
7+
- rs
8+
description: Documents the call_home_agent object used with Redis Enterprise Software REST API calls.
9+
linkTitle: call_home_agent
10+
weight: $weight
11+
---
12+
13+
| Name | Type/Value | Description |
14+
|------|------------|-------------|
15+
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the call_home_agent process, which sends daily usage statistics to Redis |

content/operate/rs/release-notes/rs-7-22-releases/_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ categories:
66
- operate
77
- rs
88
compatibleOSSVersion: Redis 7.4.0
9-
description: Diagnostic logging service. Revamp database API. Migration status API. Usage reports in support packages. Two-dimensional rack awareness. New version for actions API. Additional REST API enhancements.
9+
description: Diagnostic logging service. Call home client to send daily usage statistics to Redis. Revamp database API. Migration status API. Usage reports in support packages. Two-dimensional rack awareness. New version for actions API. Additional REST API enhancements.
1010
hideListLinks: true
1111
linkTitle: 7.22.x releases
1212
toc: 'true'
@@ -21,6 +21,8 @@ This version offers:
2121

2222
- Diagnostic logging service
2323

24+
- Call home client to send daily usage statistics to Redis
25+
2426
- Revamp database API
2527

2628
- Migration status API

content/operate/rs/release-notes/rs-7-22-releases/rs-7-22-0-28.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ categories:
66
- operate
77
- rs
88
compatibleOSSVersion: Redis 7.4.0
9-
description: Diagnostic logging service. Revamp database API. Migration status API. Usage reports in support packages. Two-dimensional rack awareness. New version for actions API. Additional REST API enhancements.
9+
description: Diagnostic logging service. Call home client to send daily usage statistics to Redis. Revamp database API. Migration status API. Usage reports in support packages. Two-dimensional rack awareness. New version for actions API. Additional REST API enhancements.
1010
linkTitle: 7.22.0-28 (April 2025)
1111
weight: 90
1212
---
@@ -19,6 +19,8 @@ This version offers:
1919

2020
- Diagnostic logging service
2121

22+
- Call home client to send daily usage statistics to Redis
23+
2224
- Revamp database API
2325

2426
- Migration status API
@@ -47,6 +49,37 @@ This version offers:
4749

4850
- JSON response format for easy integration with external logging tools.
4951

52+
- Call home client:
53+
54+
- The call home client sends daily usage statistics to Redis for operational insights. Reports include memory usage, shard information, enabled features, and other operational metrics.
55+
56+
- The cluster collects usage data hourly by default.
57+
58+
- We recommend contacting [Redis support](https://redis.io/support/) before making changes to call home behavior.
59+
60+
- To change the data collection schedule, [update job scheduler settings]({{<relref "/operate/rs/references/rest-api/requests/job_scheduler#put-job-scheduler">}}) for `bdb_usage_report_job_settings` with a REST API request:
61+
62+
```sh
63+
PUT /v1/job_scheduler
64+
{
65+
"bdb_usage_report_job_settings": {
66+
"enabled": < true | false >,
67+
"cron_expression": "*/60 * * * *"
68+
}
69+
}
70+
```
71+
72+
- To stop the call home client from sending daily usage statistics to Redis, [update cluster services configuration
73+
]({{<relref "/operate/rs/references/rest-api/requests/cluster/services_configuration#put-cluster-services_config">}}) for `call_home_agent` with a REST API request:
74+
75+
```sh
76+
PUT /v1/cluster/services_configuration
77+
{ "call_home_agent": {
78+
"operating_mode": "disabled"
79+
}
80+
}
81+
```
82+
5083
- [Revamp database REST API requests]({{<relref "operate/rs/references/rest-api/requests/bdbs/actions/revamp">}}):
5184

5285
- Updates topology-related configurations of an active database and optimises the shards placement for the new configuration. Example configuration parameters include `memory_size`, `shards_count`, `avoid_nodes`, `shards_placement`, `bigstore_ram_size`, and `replication`.

0 commit comments

Comments
 (0)