diff options
| author | Rebecca Turner <me@re-becca.org> | 2016-11-17 23:57:23 +0300 |
|---|---|---|
| committer | Rebecca Turner <me@re-becca.org> | 2016-12-13 03:23:42 +0300 |
| commit | 190a658c4222f6aa904cbc640fc394a5c875e4db (patch) | |
| tree | 803c3bb3ee2a7dbf39bd812a4b036b19f07e7c4c /doc | |
| parent | eaeb7a8f6cd77c4e7e30531a462417e653a57a20 (diff) | |
metrics: Record and report success metrics
Fixes: #12529
Credit: @iarna
Reviewed-By: @othiym23
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/npm-config.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/misc/npm-config.md b/doc/misc/npm-config.md index 26f7d3c61..e93e42a3f 100644 --- a/doc/misc/npm-config.md +++ b/doc/misc/npm-config.md @@ -600,6 +600,13 @@ Commit message which is used by `npm version` when creating version commit. Any "%s" in the message will be replaced with the version number. +### metrics-registry + +* Default: "https://registry.npmjs.org/" +* Type: String + +The registry you want to send cli metrics to if `send-metrics` is true. + ### node-version * Default: process.version @@ -844,6 +851,16 @@ Space-separated options that are always passed to search. The age of the cache, in seconds, before another registry request is made. +### send-metrics + +* Default: false +* Type: Boolean + +If true, success/failure metrics will be reported to the registry stored in +`metrics-registry`. These requests contain the number of successful and +failing runs of the npm CLI and the time period overwhich those counts were +gathered. No identifying information is included in these requests. + ### shell * Default: SHELL environment variable, or "bash" on Posix, or "cmd" on |