openfaas / openfaas/faas-cli

Research item: anonymous usage analytics

Open
#108 12 comments 4 reactions 1 assignee View on GitHub

@johnmccabe is already working on this.

Since Oct 8, 2017.

enhancement help wanted skill/intermediate
Dominant language
Go
Stars
816
Forks
230
Avg merge
6h 4m
Merged PRs (30d)
1

Description

Expected Behaviour

Track usage of commands (verbs), parameters (used), build times and other anonymous data that can help us understand usage and improve the CLI.

Remit:

  • This would only cover the CLI usage - this would not instrument the back-end services.

  • Opt-in by default, opt-out of collection via environmental variable in a similar fashion to VSCode and Brew.

.bash_profile

export OPEN_FAAS_TELEMETRY=0
  • We must explain how data is used, how long it is kept for etc and make sure it's in keeping with data protection.

  • Data must be anonymised

Current Behaviour

Relying on unsolicited feedback / word of mouth

Possible Solution

Google Analytics (subject to costing out) - has a Golang library. https://github.com/google/google-api-go-client/blob/master/analytics/v3/analytics-gen.go

Initial work would only be a PoC

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.