LATEST VERSION: 1.12 - CHANGELOG
RabbitMQ for PCF v1.11

Troubleshooting Instances

This topic provides basic instructions for app developers troubleshooting On-Demand RabbitMQ® for PCF.

Errors

You may see an error when using the Cloud Foundry Command-Line Interface (cf CLI) to perform basic operations on a RabbitMQ for PCF service instance:

  • cf create
  • cf update
  • cf bind
  • cf unbind
  • cf delete

Parse a Cloud Foundry (CF) Error Message

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 Pivotal Support when filing a ticket.

The task-id field maps to the BOSH task id. For further information on a failed BOSH task, use the bosh task TASK-ID command in v1 of the BOSH CLI. For v2, use bosh2 task TASK-ID.

The 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.

Retrieve Service Instance Information

  1. Log into the space containing the instance or failed instance.

    $ cf login
    

  2. If you do not know the name of the service instance, run cf services to see a listing of all service instances in the space. The service instances are listed in the name column.

    $ cf services
    Getting services in org my-org / space my-space as user@example.com...
    OK
    name          service            plan    bound apps    last operation
    my-instance   ondemand-rabbitmq  Solo                  create succeeded
    

  3. Run cf service SERVICE-INSTANCE-NAME to retrieve more information about a specific instance.

  4. Run cf service SERVICE-INSTANCE-NAME --guid to retrieve the GUID of the instance, which is useful for debugging.

Retrieve RabbitMQ Instance Credentials

If you want to access the Management Dashboard or the RabbitMQ server for troubleshooting, you can create a new service-key to retrieve RabbitMQ instance credentials. Pivotal recommends that you use this key for troubleshooting only, and that you delete the key after troubleshooting. To retrieve the credentials, do the following:

  1. Create a service-key for your RabbitMQ instance using the command cf create-service-key INSTANCE-NAME SERVICE-KEY-NAME.

  2. Retrieve the credentials using the command cf service-key INSTANCE-NAME SERVICE-KEY-NAME.

For example:

$ cf create-service-key my-rmq-instance my-key
Creating service key my-key for service instance my-rmq-instance as admin...
OK
$ cf service-key my-rmq-instance my-key
Getting key my-key for service instance my-rmq-instance as admin...
{
 "host": "10.0.8.4",
 "password": "",
 "port": 6379
}

Knowledge Base (Community)

Find the answer to your question and browse product discussions and solutions by searching the Pivotal Knowledge Base.

File a Support Ticket

You can file a support ticket here. Be sure to provide the error message from cf service YOUR-SERVICE-INSTANCE.

To help expedite troubleshooting, if possible also 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.

Delete RabbitMQ Instances

On-Demand Broker provides a BOSH command to delete all the On-Demand Broker deployed instances. To delete the instances, do the following procedure:

  1. Run the following command to delete all instances of the On-Demand Broker:

    WARNING: This command deletes deployment instances serially. It is very destructive and cannot be undone.

    bosh run-errand delete-sub-deployments

Create a pull request or raise an issue on the source for this page in GitHub