Quality reports

We’re constantly monitoring the Cloud Platform for availability and possible issues. In order to help detect such issues the CrabNebula Cloud CLI may submit quality reports.

Privacy

Quality reports from the CLI are sent to CrabNebula Cloud at api.crabnebula.app and are not processed by any third parties. For more information, check our general privacy policy.

Opting-Out

While we make sure that these reports are minimal and don’t contain sensitive information, you can opt-out from sending these reports by either:

• Adding the --no-quality-reports command line option.
• Setting the CN_QUALITY_REPORTS=false environment variable.

For example:

CLI flag

cn release upload --no-quality-reports

Env Variable

CN_QUALITY_REPORTS=false cn release upload

Example Reports

Here are example of the quality reports currently being sent. Though the types of reports may change over time, for example if we become aware of new types of issues to be monitoring for.

Asset Upload

Because the cn release upload command may run into networking issues.

key	description	type
asset_idx	the index of the asset, if there are multiple	integer
asset_count	the total number of assets uploaded in one CLI call	integer
asset_id	the ID of the asset	string
asset_size	the size of the asset in bytes	integer
auth	whether authentication succeeded	Status
resolve	whether the asset metadata could be resolved	Status
start	whether the upload started	Status
parts	whether all parts could be uploaded	Status
finish	whether the upload finished	Status
part	the status of each part	Status[]
part_count	the total number of parts	integer

Where the Status type is boolean | integer | null.

• null for when this step hasn’t started yet.
• true when the step succeeded.
• integer when the step failed due to an HTTP error, the HTTP response code.
• false when the step failed for any other reason.

Here is an example report where the upload encountered a server error.

Example Quality Report

{
  "asset_idx": 0,
  "asset_count": 1,
  "asset_id": "01JC1BV1WJJMSPR267W13S9G85",
  "asset_size": 12320304,
  "auth": true,
  "resolve": true,
  "start": true,
  "parts": 500,
  "finish": null,
  "part": [500, null, null],
  "part_count": 3
}

Additionally some HTTP request headers collected from the report:

HTTP Response Headers

User-Agent: Cloud CLI/0.9.0
CF-IPCountry: NL

• User-Agent: The version of the CLI that submitted the report.
• CF-IPCountry: The GeoIP country that the report was submitted from.