Add opt-out analytics to CLI (implements #108) #187

johnmccabe · 2017-10-24T17:39:01Z

Description

This PR adds an opt-out analytics capture using Google Analytics.

Refer to the included analytics.md file for details of what is being captured at this point and how to opt out from the capture.

Note it does not capture function counts etc, pending the merge of openfaas/faas#315.

@alexellis - you will need to replace the trackingID and applicationName in analytics/google_analytics.go in order to direct events to a GA account associated with the OpenFaaS project.

Motivation and Context

I have raised an issue to propose this change (Research item: anonymous usage analytics #108)

How Has This Been Tested?

Have tested the resulting client as follows:

on OSX and Windows
unresponsive analytics endpoint results in timeout
closed endpoint results in a fail fast
opt-out envvar short circuits all capture
blocked endpoint (PiHole) fails fast
events are visible live in the Real-Time/Events dashboard
Data Studio Dashboard created from captured event data
Message displayed to stderr the first time the cli is run with analytics enabled

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I've read the CONTRIBUTION guide
I have signed-off my commits with git commit -s
I have added tests to cover my changes.
All new and existing tests passed.

open-derek · 2017-10-24T18:13:46Z

Thank you for your contribution. I've just checked and your commit doesn't appear to be signed-off.
That's something we need before your Pull Request can be merged. Please see our contributing guide.

johnmccabe · 2017-10-24T18:16:49Z

@alexellis do you want the steps to setup the Custom Dimensions, application, trackingID and Dashboard in GA added to these docs or stored elsewhere?

alexellis · 2017-10-24T19:21:06Z

This is brilliant 🥇

johnmccabe · 2017-11-01T12:03:18Z

@alexellis ignoring the rebase, is there more you need to see here

alexellis · 2017-11-08T19:28:48Z

analytics.md

+
+Due to the speed with which most OpenFaaS API calls return, a timeout of 300 milliseconds is used to give the analytics submission time to complete.
+
+## Opting out?


Can you link me to what brew/ VSCode says?

https://github.com/Homebrew/brew/blob/master/docs/Analytics.md

alexellis · 2017-11-08T19:29:15Z

analytics.md

+
+If you wish to opt out of submitting analytics events you may do so by setting the `OPEN_FAAS_TELEMETRY` environment variable.
+
+    export OPEN_FAAS_TELEMETRY=0


Our NS should be OPENFAAS_

I can't see where it was changed? The code review doesn't say "see outdated".. did you push yet?

Missed pushing the README it seems.

alexellis · 2017-11-08T19:29:59Z

analytics/google_analytics.go

+		Language:           language,
+		OS:                 runtime.GOOS,
+		ARCH:               runtime.GOARCH,
+		EventCategory:      "cli-success",


Can we get whether /.dockerenv exists? Tells you whether you're in a container or not.

/.dockerenv will tell us whether the environment is a Docker container.

I'm adding this at the moment, just need to setup the GA custom dimension and Google Data Suite dashboard to validate it's getting pushed through.

alexellis · 2017-11-08T19:30:16Z

analytics/google_analytics.go

+func (u UserSession) PostEvent(ch chan int) {
+	v, _ := query.Values(u)
+	req := &http.Request{
+		Method: "POST",


http.MethodPost

johnmccabe · 2017-11-15T23:04:46Z

I've started addressing your comments @alexellis will get something pushed up ASAP, been a bit off the radar recently as you're likely aware.

@alexellis

This commit implements #108 adding an opt-out analytics capture using Google Analytics. Refer to the analytics.md file for details of what is being captured at this point and how to opt out from the capture. *Note* it does not capture function counts etc, pending the merge of openfaas/faas#315. @alexellis - you will need to replace the `trackingID` and `applicationName` in `analytics/google_analytics.go` in order to direct events to a GA account associated with the OpenFaaS project. Signed-off-by: John McCabe <john@johnmccabe.net>

Signed-off-by: John McCabe <john@johnmccabe.net>

alexellis · 2017-11-24T15:54:41Z

Dockerfile

@@ -14,7 +14,7 @@ RUN test -z "$(gofmt -l $(find . -type f -name '*.go' -not -path "./vendor/*"))"
 # ldflags -X injects commit version into binary

 RUN license-check -path ./ --verbose=false \
- && go test $(go list ./... | grep -v /vendor/ | grep -v /template/|grep -v /build/) -cover \
+ && OPEN_FAAS_TELEMETRY=0 go test $(go list ./... | grep -v /vendor/ | grep -v /template/|grep -v /build/) -cover \


Is it easier to put this as an ENV just above?

Hmm, could do.

alexellis · 2017-11-24T16:01:40Z

analytics/types.go

+	ApplicationName    string       `url:"an"`
+	ApplicationVersion string       `url:"av"`
+	AnonymizeIP        int          `url:"aip"`
+	Language           string       `url:"cd1"`


Custom Dimension 1, its a Google Analytics term, the backend GA setup doc I shared should explain.

alexellis · 2017-11-24T16:03:08Z

analytics/google_analytics.go

+		AnonymizeIP:        1,
+		Language:           language,
+		OS:                 runtime.GOOS,
+		ARCH:               runtime.GOARCH,


Just a thought this may mis-report I think it's set at build-time. One thing it won't do is to show armv6/7/8 differences. For that an OS library like pstate etc might help - although we'd need one that doesn't use CGO.

johnmccabe · 2017-11-24T16:07:56Z

Which part do you think is set at build? The runtime.* calls?

alexellis · 2017-11-24T17:07:09Z

I'll double check but I thought it was hard-coded through the build-time runtime when cross-compiling. It didn't seem to have the ARM version for sure.

johnmccabe · 2018-06-10T21:53:24Z

@alexellis is this worth you want to see implemented? I think it should be ok from a GDPR point of view, would need to add a privacy section to the docs however.

johnmccabe changed the title ~~Add Opt-out analytics to CLI (implements #108)~~ Add opt-out analytics to CLI (implements #108) Oct 24, 2017

open-derek bot added no-dco and removed no-dco labels Oct 24, 2017

alexellis force-pushed the master branch from da0b406 to 5cd3ea2 Compare November 3, 2017 13:05

alexellis reviewed Nov 8, 2017

View reviewed changes

johnmccabe added 8 commits November 24, 2017 13:27

Vendor go-querystring and bump FaaS dep

d655e2b

Signed-off-by: John McCabe <john@johnmccabe.net>

Add analytics reference to README

4e7f3ff

Signed-off-by: John McCabe <john@johnmccabe.net>

Use changed version function in analytics

b50db32

Signed-off-by: John McCabe <john@johnmccabe.net>

Use http.MethodPost

2bc38cf

Signed-off-by: John McCabe <john@johnmccabe.net>

Add analytics to login/logout/template pull

632c3df

Signed-off-by: John McCabe <john@johnmccabe.net>

Provide feedback during redist build

897177b

Signed-off-by: John McCabe <john@johnmccabe.net>

Disable analytics during tests

c1636e2

Signed-off-by: John McCabe <john@johnmccabe.net>

alexellis reviewed Nov 24, 2017

View reviewed changes

alexellis added the inactive label Mar 20, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add opt-out analytics to CLI (implements #108) #187

Add opt-out analytics to CLI (implements #108) #187

johnmccabe commented Oct 24, 2017 •

edited

Loading

open-derek bot commented Oct 24, 2017

johnmccabe commented Oct 24, 2017

alexellis commented Oct 24, 2017

johnmccabe commented Nov 1, 2017

alexellis Nov 8, 2017

johnmccabe Nov 24, 2017

alexellis Nov 8, 2017

johnmccabe Nov 24, 2017

alexellis Nov 24, 2017

johnmccabe Nov 24, 2017

alexellis Nov 8, 2017

alexellis Nov 24, 2017

johnmccabe Nov 24, 2017

alexellis Nov 8, 2017

johnmccabe Nov 24, 2017

johnmccabe commented Nov 15, 2017

alexellis Nov 24, 2017

johnmccabe Nov 24, 2017

alexellis Nov 24, 2017

johnmccabe Nov 24, 2017

alexellis Nov 24, 2017

johnmccabe commented Nov 24, 2017

alexellis commented Nov 24, 2017

johnmccabe commented Jun 10, 2018


		Due to the speed with which most OpenFaaS API calls return, a timeout of 300 milliseconds is used to give the analytics submission time to complete.

		## Opting out?


		If you wish to opt out of submitting analytics events you may do so by setting the `OPEN_FAAS_TELEMETRY` environment variable.

		export OPEN_FAAS_TELEMETRY=0

Add opt-out analytics to CLI (implements #108) #187

Are you sure you want to change the base?

Add opt-out analytics to CLI (implements #108) #187

Conversation

johnmccabe commented Oct 24, 2017 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

open-derek bot commented Oct 24, 2017

johnmccabe commented Oct 24, 2017

alexellis commented Oct 24, 2017

johnmccabe commented Nov 1, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnmccabe commented Nov 15, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnmccabe commented Nov 24, 2017

alexellis commented Nov 24, 2017

johnmccabe commented Jun 10, 2018

johnmccabe commented Oct 24, 2017 •

edited

Loading