Troubleshooting Caliper SDK

This topic lists common issues you might run into and how to fix them. Many issues can be fixed using Caliper Admin. Refer to Caliper Admin for installation instructions and more information.

The q2 command is not recognized

Your virtual environment might not be built or activated.

  1. Run Caliper Admin.

  2. Select Code, then select Build Virtual Environment.

  3. Enter the name for your virtual environment.

Installation or uninstallation fails with a 404 error

Example error message: "https://ingress-private.service.dev.aws.consul/sdk/STACKNAME/hq/Q2API.ashx/ExecuteStoredProcedure" not found (404) when running q2 install/q2 uninstall

You might be using the wrong stack, or your stack might have an issue that resetting will fix.

  1. Run Caliper Admin.

  2. Select Status to check your current stack. If you are using the correct stack, you can switch to a different stack and then back to reset it.

  3. Run Caliper Admin again and select Set Stack.

  4. Select the desired stack.

    1. If the status indicates that you are using the correct stack, select a different stack, then run Caliper Admin again and repeat this step to set it back to the correct stack.

  5. Run the specified script to set environment variables.

Errors are returned during installation or API calls

Example error messages:

  • “HqResponseError: HQ Request returned with error message: ‘None’”

  • “Could not execute stored procedure “sdk_GetCaliperAPICustomEndpoints”

  • Invalid object name “Q2_ApiStoredProc” when running q2 install/q2 uninstall

You might not have set up your database. Run q2 setup_db in the terminal to set it up. You need to run this only once for your stack.

SSO does not load in the sandbox environment

Your extension’s URL might not be pointing to the correct path. This commonly occurs when multiple developers are working on your extension in the same sandbox.

  1. Run q2 update_installed in the terminal.

  2. Select your extension.

  3. Verify the URL is pointing to the correct path. Update it if it’s not correct.

Errors when transitioning from remote to local development

If you are transitioning from remote to local development and extensions are already installed in the database, you must update those extensions.

Run q2 run to obtain the log line service URL, then run q2 update_installed and set the URL to what you obtained.