Skip to main content

Errors + Troubleshooting

MetriCal logs various error codes during operation or upon exiting. This page catalogs them, along with descriptions (🔍) and troubleshooting (🔧) steps.

Error Codes in Logs

During operation, error codes may be printed to the log (stderr) as informational warnings or as errors that caused MetriCal to fail and exit.

Licensing

Licensing-specific error codes and troubleshooting tips are listed below.

license-001

🔍 Verifying the license online failed. MetriCal couldn't verify the signature or decode the contents of the licensing server's response.

🔧 Ensure no network proxy is modifying HTTP content or headers.

license-002

🔍 Verifying the local license-cache file failed. MetriCal couldn't verify the signature or decode the contents of the local license-cache file.

🔧 Ensure a valid license-cache file exists and has not been edited or corrupted. See the licensing setup instructions to enable offline licensing.

license-003

🔍 License is in an invalid state. The provided license is either suspended/banned (e.g. subscription expired/lapsed) or was not found (e.g. was revoked or typoed).

🔧 Contact us at support@tangramvision.com for help.

license-004

🔍 The local license-cache file could not be read from disk.

🔧 Ensure a license-cache file exists and is readable. See the licensing setup instructions to enable offline licensing.

license-005

🔍 The local license-cache file could not be parsed.

🔧 Ensure a valid license-cache file exists and has not been edited or corrupted. See the licensing setup instructions to enable offline licensing.

license-006

🔍 No default application config path could be found in order to locate or write the license-cache file. This is likely an issue with Docker configuration causing the HOME environment variable to be unset inside the container.

🔧 Please review and follow the licensing setup instructions to enable offline licensing. If the issue persists, contact support@tangramvision.com.

license-007

🔍 The local license-cache file could not be written to disk. Offline operation is not possible without a license-cache file.

🔧 Ensure that the metrical-license-cache volume is being successfully mounted into the Docker container. Please review and follow the licensing setup instructions to enable offline licensing. If the issue persists, contact support@tangramvision.com.

license-008

🔍 The local license-cache file could not be serialized to disk. Offline operation is not possible without a license-cache file.

🔧 Please contact us at support@tangramvision.

license-009

🔍 The local license-cache file is expired.

🔧 Run MetriCal with internet access to refresh the license. You must run a mode/sub-command (other than help) in order to refresh the license.

license-010

🔍 Checking the license online failed. This error code encompasses a variety of possible errors including: DNS issues, no network connection, network request timeout, licensing server errors or downtime, or network proxies editing network packet contents or headers.

🔧 Please check your network connection — ensure that the internet is reachable, DNS resolves successfully, and no network proxies are active that modify traffic. Check the licensing service is up at https://status.keygen.sh/. To ensure future resilience to network-related issues, follow the licensing setup instructions to enable offline licensing. If the issue persists, contact support@tangramvision.com.

license-011

🔍 The provided license key does not match the key in the license-cache file.

🔧 If you maintain different license-cache files (e.g. for different users), ensure you're using the license-cache file that matches the provided license key. Otherwise, delete your license-cache file and try again with an active internet connection to regenerate the license-cache file.

license-012

🔍 No item named "license" found in TOML config file.

🔧 Please ensure there is a top-level key named "license" in the TOML config file. Please reference the licensing setup instructions for an example of how the TOML config file should look.

license-013

🔍 License key found in TOML config file is malformed (i.e. it is not a string or it has a length of zero).

🔧 Ensure the license key in the TOML config file is a non-empty string. Please reference the licensing setup instructions for an example of how the TOML config file should look.

license-014

🔍 Failed to read TOML config file.

🔧 Ensure the file exists and is readable, or provide the license key via an alternative source (CLI argument, environment variable).

license-015

🔍 No license key was found from any source.

🔧 Provide a license key via CLI argument, environment variable, or config file. Please reference the licensing setup instructions for examples of how to use a license key with MetriCal.

license-016

🔍 No default application config path could be found in order to locate the TOML config file. This is likely an issue with Docker configuration causing the HOME environment variable to be unset inside the container.

🔧 Please see the licensing setup instructions for an example of docker commands and options to use. If the issue persists, contact support@tangramvision.com.

license-017

🔍 The TOML config file is malformed.

🔧 Ensure the config file is valid TOML. Please reference the licensing setup instructions for an example of how the TOML config file should look.

MetriCal Exit Codes

When exiting, MetriCal will print the exit code and return it from the process. The table below lists the exit codes and a description of what each code means.

Exit CodeCategory
0Success
1I/O error
2CLI error
3Error specific to Shape mode operation
4Error specific to Init mode operation
5Error specific to Pretty Print mode operation
6MetriCal license error
7Error specific to Display mode
8Error specific to Calibrate mode
9Error specific to Completion mode