Skip to content

usage-data.md

Latest commit

 

History

History
40 lines (30 loc) · 1.74 KB

usage-data.md

File metadata and controls

40 lines (30 loc) · 1.74 KB
Raw
seo
title
Usage data

Usage data and product metrics

Redocly CLI sends a small set of anonymized data to help us understand how the tool is used and improve it.

What data is collected

When a command is run, the following data is collected:

  • the command being run
  • command exit code
  • whether the user is logged into Redocly
  • values from REDOCLY_ENVIRONMENT, REDOCLY_CLI_TELEMETRY_METADATA, and CI environment variables
  • CLI version
  • Node.js and NPM versions
  • whether the redocly.yaml configuration file exists
  • API specification type and version
  • names of lint rules that reported errors, warnings, or ignored problems
  • Arazzo x-security authentication types
  • for generate-client and eject-generator: which built-in generators and toolkit helpers are used, coarse outcome categories, and the toolkit versions involved — never file contents, paths, or names you chose
  • for bundle: how many overlays are applied — never their paths or contents
  • platform (Linux, macOS, Windows)
  • anonymous ID (a randomly generated identifier that doesn't contain personal information)
  • command execution time
  • whether the CLI runs from a released build or development build

Values such as file names, organization IDs, and URLs are removed, replaced by just "URL" or "file", etc.

Opt out of data collection

To opt out, set the REDOCLY_TELEMETRY environment variable to off, or set telemetry: off in the redocly.yaml configuration file.

Requests to Reunite

The login, push, and push-status commands send the CLI version, the command name, and the value of the REDOCLY_ENVIRONMENT environment variable in the user-agent header of their requests to Reunite. The REDOCLY_TELEMETRY setting does not apply to this header.