Call home client

The call home client sends your Redis Enterprise Software cluster's daily usage statistics to Redis.

The call home client collects data hourly and sends daily usage statistics to Redis with a POST request to https://usage.redis.io/callHome. Reports include memory usage, shard details, enabled features, and other operational metrics. To prevent increased load when multiple clusters are running, the daily report is sent at a random time.

These reports provide insights into license consumption, which helps Redis to ensure performance metrics align with contractual agreements, optimize service delivery, and offer proactive customer support.

We recommend contacting Redis support before making changes to call home behavior.

Collected data

The following example shows the data collected hourly for each database:

{
  "support_package": true,
  "customer_name": "string",
  "license_hash": "string",
  "usage_data": [
    {
      "date": "2025-03-25T11:42:13.984Z",
      "cluster_UUID": "string",
      "cluster_name": "string",
      "api_version": "string",
      "software_version": "string",
      "bdb_uid": "string",
      "type": "string",
      "shard_type": "string",
      "dominant_shard_criteria": "string",
      "provisioned_memory": 0,
      "used_memory": 0,
      "master_shards_count": 0,
      "no_eviction": true,
      "persistence": true,
      "backup": true,
      "using_redis_search": true,
      "ops_sec": 0,
      "replication": true,
      "active_active": true
    }
  ]
}

Change data collection schedule

The cluster collects usage data hourly by default.

To change the data collection schedule, update job scheduler settings for bdb_usage_report_job_settings with a REST API request:

PUT /v1/job_scheduler
{
  "bdb_usage_report_job_settings": {
    "enabled": true,
    "cron_expression": "*/60 * * * *"
  }
}

Replace cron_expression's value with a cron expression that defines the new data collection schedule.

Turn off call home client

To stop the call home client from sending daily usage statistics to Redis, update cluster services configuration for call_home_agent with a REST API request:

PUT /v1/cluster/services_configuration
{ 
  "call_home_agent": { 
    "operating_mode": "disabled"
  } 
}