optional telemetry

[DavidGOrtega]

Add optional telemetry to CML to help prioritise features/issues based on usage.

• opens CML entrypoint improvements #1093
• Updated to JSON spec
• slightly fixes CML entrypoint improvements #1093

[casperdcl]

(self-requesting review for verifying spec)

[casperdcl]

review (mostly comparing to https://github.com/iterative/terraform-provider-iterative/blob/master/iterative/utils/analytics.go)

[0x2b3bfa0]

Still trying to figure out how to avoid injecting telemetry-specific code in every command. What if we wrap the entry point on bin/cml.js with some kind of “success” logic?

cml/bin/cml.js

Lines 96 to 115 in 6271cb8

	yargs
	.env('CML')
	.options({
	log: {
	type: 'string',
	description: 'Maximum log level',
	choices: ['error', 'warn', 'info', 'debug'],
	default: 'info'
	}
	})
	.fail(handleError)
	.middleware(setupOpts)
	.middleware(setupLogger)
	.middleware(setupTelemetry)
	.commandDir('./cml', { exclude: /\.test\.js$/ })
	.command('$0 <command>', false, (builder) => builder.strict(false), runPlugin)
	.recommendCommands()
	.demandCommand()
	.strict()
	.parse();

E.g. yargs...fail(handleError).parse() can be replaced with handleSuccess(yargs...fail(handleError).parse()) and, provided that handleError contains a process.exit they'll be mutually exclusive.

Update: see #1124 (comment) for the proposed changes.

[0x2b3bfa0]

Can probably be merged without applying #1124 first. Worth walking the plank, though. Yargs!

[casperdcl]

lgtm

[DavidGOrtega]

lgtm

But not approved 🙈

[0x2b3bfa0]

Looks mergeable enough to me