Page last updated:
This topic provides basic instructions for app developers troubleshooting on-demand Redis for Pivotal Platform.
Start here if you are responding to a specific error or error messages.
The following errors occur in multiple services:
Apps Fail to Connect to the Service Instance
|Symptom||Apps fail to connect to the Redis service instance.|
The Redis on-demand service broker now binds apps to service instances using BOSH DNS. Service bindings return the DNS address instead of the IP address. If an operator enables the BOSH HotSwaps feature, any apps with service bindings that do not use BOSH DNS will fail to connect to the Redis service instance.
For more information, see Enable BOSH HotSwaps to Reduce Downtime.
For more information about service bindings, see Service Bindings in the Cloud Foundry documentation.
Convert service instance bindings to use BOSH DNS. To do so, unbind, rebind, and restage all apps that were bound to a service instance using an IP address as follows:
No Metrics from Log Cache
|Symptom||You receive no metrics when running the
|Cause||This might be because the Firehose is disabled in the PAS tile.|
|Solution||Ask your operator to ensure that the V2 Firehose checkbox is enabled, and the Enable Log Cache syslog ingestion checkbox is disabled in the PAS tile. For more information about configuring these checkboxes, see Enable Syslog Forwarding.|
The following troubleshooting errors are specific to Redis for Pivotal Cloud Foundry:
- Maximum Number of Clients Reached
- Maxmemory Limit Reached
- Error When Running the Save Command
- Unknown Command Error
Certain errors are returned to the Redis
client instead of being recorded in the logs. The Redis protocol represents
errors as simple strings beginning with a
Maximum Number of Clients Reached
You receive the following error:
-ERR max number of clients reached
|Cause||This is usually caused by apps opening multiple client connections to Redis.|
|Solution||Share or pool Redis connections within an app. Redis for PCF configures Redis to accept 10000 client connections. This can be confirmed by running the `INFO` command using the Redis CLI.|
Maxmemory Limit Reached
You receive the following error:
-OOM command not allowed when used memory > 'maxmemory'.
|Cause||This occurs when the Redis server has reached its
Consider changing your maxmemory-policy.
You can update this using the
Error When Running the Save Command
You receive the following error message when running
|Cause||This might occur when the Redis server’s disk is full.|
|Solution||A more informative message might be logged in the syslog. For more information, see Syslog Errors.|
Unknown Command Error
You receive the following error message when running `redis-cli COMMAND` or issuing a command using another Redis client:
-ERR unknown command
|Cause||For security reasons, certain commands such as
|Solution||Talk to your operator about the availability of the command.|
See the following sections for troubleshooting techniques when using the Cloud Foundry Command-Line Interface (cf CLI) to perform basic operations on a Redis for Pivotal Platform service instance.
Basic cf CLI operations include
See the table below for Cloud Foundry Command Line Interface (cf CLI) commands commonly used while debugging:
|To view the…||Command|
|API endpoint, org, and space||
|Service offerings available in the targeted org and space||
|Apps deployed to the targeted org and space||
|Service instances deployed to the targeted org and space||
|GUID for a given service instance||
|Service instance or application logs||
Failed operations (create, update, bind, unbind, delete) result in an error message.
You can retrieve the error message later by running the cf CLI command
cf service INSTANCE-NAME.
$ cf service myservice Service instance: myservice Service: super-db Bound apps: Tags: Plan: dedicated-vm Description: Dedicated Instance Documentation url: Dashboard: Last Operation Status: create failed Message: Instance provisioning failed: There was a problem completing your request. Please contact your operations team providing the following information: service: redis-acceptance, service-instance-guid: ae9e232c-0bd5-4684-af27-1b08b0c70089, broker-request-id: 63da3a35-24aa-4183-aec6-db8294506bac, task-id: 442, operation: create Started: 2017-03-13T10:16:55Z Updated: 2017-03-13T10:17:58Z
Use the information in the
Message field to debug further.
Provide this information to Support when filing a ticket.
task-id field maps to the BOSH task ID.
For more information on a failed BOSH task, use the
bosh task TASK-ID.
broker-request-guid maps to the portion of the On-Demand Broker log
containing the failed step.
Access the broker log through your syslog aggregator, or access BOSH logs for
the broker by typing
bosh logs broker 0.
If you have more than one broker instance, repeat this process for each instance.
To retrieve information about the service instance that you can use for debugging:
Log into the space containing the instance or failed instance.
$ cf login
If you do not know the name of the service instance, you can view a listing of all service instances in the space by running:
The service instances are listed in the
$ cf services Getting services in org my-org / space my-space as email@example.com... OK name service plan bound apps last operation my-instance p.redis on-demand-cache create succeeded
Retrieve more information about a specific service instance by running:
cf service SERVICE-INSTANCE-NAME
Retrieve the GUID of the service instance by running:
cf service SERVICE-INSTANCE-NAME --guid
This is useful for debugging.
If the Log Cache CLI plugin is enabled, you can retrieve logs for the service instance by running:
cf tail SERVICE-INSTANCE-NAME/APP-NAME
For more information, see Log Cache CLI plugin.
If you want to access the Redis server for troubleshooting, you can find a Redis service instance password by creating a new service key.
Pivotal recommends that you use this key for troubleshooting only, and that you
delete the key after troubleshooting by running the command
cf delete-service-key SERVICE-INSTANCE KEY-NAME.
For instructions on how to retrieve the password, see Retrieve the Password for a Redis Service Instance.
Redis for Pivotal Platform service instances can become temporarily inaccessible during upgrades and VM or network failures.
Find the answer to your question and browse product discussions and solutions by searching the VMware Tanzu Knowledge Base.
You can file a support ticket here.
Be sure to provide the error message from
cf service YOUR-SERVICE-INSTANCE.
To expedite troubleshooting, if possible, provide your service broker logs, service instance logs, and BOSH task output. Your cloud operator should be able to obtain these from your error message.