adobe / aio-cli-plugin-telemetry

telemetry for anonymous tracking of aio cli usage, errors, timing

aio-cli-plugin-telemetry

Adobe Developer cli usage telemetry

Commands

• aio telemetry yes

aio telemetry yes

Allow the cli to collect anonymous usage data

USAGE
  $ aio telemetry yes
  $ aio telemetry off
  $ aio telemetry

ARGUMENTS
  STATE  (on|off|yes|no) set telemetry state

DESCRIPTION
  Allow the cli to collect anonymous usage data

See code: src/commands/telemetry/index.js

Configuration

The following values need to be set when this plugin is hosted by different CLIs

• aioTelemetry: defined object in root cli package.json with values:
  • postUrl : Where to post telemetry data
  • postHeaders: Any specific headers that need to be posted with telemetry data (ex. x-api-key)
  • productPrivacyPolicyLink: A link to display to users when prompting to optIn
• productName: How to refer to the cli when user is prompted to enable telemetry
  • this value is read from displayName or name of the cli's package.json
• productBin: Output in help text
  • ex. To turn telemetry on run ${productBin} telemetry on
  • this value is read from 'bin' of the cli's package.json, if the package exports more than 1 bin the first is used

POST data

Here is an example of the event data as posted:

{ "id": 656915165813,
  "timestamp": 1673404918437,
  "_adobeio": {
    "eventType": "telemetry-prompt",
    "eventData": "accepted",
    "cliVersion": "@adobe/aio-cli@9.1.1",
    "clientId": 264421030538,
    "commandDuration": 5661,
    "commandFlags": "",
    "commandSuccess": true,
    "nodeVersion": "v14.20.0",
    "osNameVersion": "macOS"
  }
}