archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-25 15:07:39 +00:00
Code Issues Projects Releases Wiki Activity

Add docs for usage tracking

Browse Source
This commit is contained in:
Philipp Muens 2016-07-15 17:01:02 +02:00
parent 77f30d44f7
commit 8c4698aa1b
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/usage-tracking/usage-tracking.md
View File

@ -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.