From 8c4698aa1bc7c19ce059363417291fcd2991a51c Mon Sep 17 00:00:00 2001 From: Philipp Muens Date: Fri, 15 Jul 2016 17:01:02 +0200 Subject: [PATCH] Add docs for usage tracking --- docs/usage-tracking/usage-tracking.md | 31 +++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/docs/usage-tracking/usage-tracking.md b/docs/usage-tracking/usage-tracking.md index b73ae3e19..f3bdb9964 100644 --- a/docs/usage-tracking/usage-tracking.md +++ b/docs/usage-tracking/usage-tracking.md @@ -1 +1,32 @@ # Usage tracking + +Serverless will automatically track anonymous usage data. This is done so that we better understand the usage and needs +of our users to improve Serverless in future releases. However you can always [disable usage tracking](#how-to-disable-it). + +## What we track + +Our main goal is anonymity while tracking usage behavior. All the data is anonymized and won't reveal who you are or what +the project you're working on is / looks like. + +Here's a list about all the information we track: +- Entered command(s) +- Entered options(s) +- Operating system +- Loaded plugins +- Serverless version +- Functions count inside a service +- Provider of your service +- If the command was run inside a service + +## How tracking is implemented + +We encourage you to look into the source to see more details about the actual implementation. + +The tracking implementation consists of two parts: +1. The [tracking plugin](/lib/plugins/tracking) +2. The `track` method you can find in the [Utils class](/lib/classes/Utils.js) + +## How to disable it + +You can disable usage tracking by running the following command: `serverless tracking --disable`. +You can always run `serverless tracking --enable` to enable tracking again.