Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Analytics addition to readme #987

Merged
merged 13 commits into from
Aug 13, 2020
Prev Previous commit
Next Next commit
Fixes to wording, typos and recommendations as per pull request
Michael Wright committed Aug 12, 2020

Verified

This commit was signed with the committer’s verified signature.
utkarshgupta137 Utkarsh Gupta
commit 918c89298cbc4f97e0b2ae8605b7dfb0863142a0
27 changes: 20 additions & 7 deletions docs/analytics.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,35 @@
# Flank Analytics

Flank makes use of Bugsnag as its only analytics platform. It uses Bugsnag as an error monitor and project stability tool.
Flank makes use of Bugsnag as an Error monitoring and project stability tool.

For more information about Bugsnag please visit its website [here](https://www.bugsnag.com/) and documentation [here](https://docs.bugsnag.com/)

## Control

It is possible to disable the Bugsnag analytics integration used by flank or to make use of custom Bugsnag key so that any analytics can be displayed for custom use.
It is possible to disable the Bugsnag analytics integration used by Flank. Flank makes use of the same OPT-OUT approach as Gcloud CLI and can be disabled the same way.

- To disable, place the word ```DISABLED``` in the file ````~/.gsutil/analytics-uuid```` and Flank will no longer send any analytics data
- Or simply running the following code (make sure the file exists!) will disable: ```echo "DISABLED" > ~/.gsutil/analytics-uuid```
- To disable, place ONLY the word ```DISABLED``` in the file ````~/.gsutil/analytics-uuid```` and Flank will no longer make use of Bugsnag integration.
- It is recommended to backup the file ````~/.gsutil/analytics-uuid```` if it exists as it may contain your project specific UUID.
- For example running the following code will disable Bugsnag: ```echo "DISABLED" > ~/.gsutil/analytics-uuid``` (make sure the file exists!)

- To enable or reenable bugsnag simply remove the file ```~/.gsutil/analytics-uuid``` and the project will default to make use of the flanks Bugsnag key
- To enable or reenable bugsnag simply remove the file ```~/.gsutil/analytics-uuid``` or replace it with your backed-up file and the project will again begin to make use Bugsnag.

- To make use of custom Bugsnag integration, place your bugsnag key/UUID in ```~/.gsutil/analytics-uuid``` and the flank project will make use of it instead of the default key.

## More information

To see how Bugsnag integration is used within the project please see the Flank Bugsnag testcase [here](../test_runner/src/test/kotlin/ftl/util/FlankBugsnagInitHelperTest.kt)
To see how Bugsnag is integrated within the Flank project please see the Flank Bugsnag testcase [here](../test_runner/src/test/kotlin/ftl/util/FlankBugsnagInitHelperTest.kt) and the actual Bugsnag implementation found [here](../test_runner/src/main/kotlin/ftl/util/BugsnagInitHelper.kt)

Flank makes use of Bugsnag to monitor test runner stability and to capture errors. It provides diagnostic data that is used to make data driven decisions when prioritizing fixing bugs or adding new features.

The goal is to use language that demonstrates value to Flank's customers.

For example American express wants a stable and reliable test runner. Bugsnag is helping us deliver this too them.


BugSnag sumarizes the following about how it makes use of the data it collects and stores:

- Bugsnag monitors web, mobile and server applications and programs under the direction of its Customers, to provide error Event Data about the Customer’s applications and programs to the Customer. Event Data may contain Personal Information of the individuals who use the Customer’s applications. Bugsnag itself does not collect this end user Personal Information and Bugsnag has no direct relationship with these individuals. For example, a Customer may direct Bugsnag to log certain software application’s end user information associated with Event Data, such as the end user’s device ID, email and name. Bugsnag is a data processor and follows the instructions of the Customer in these cases.

More information about Bugsnag data policy can be found [here](https://docs.bugsnag.com/legal/privacy-policy/#:~:text=Services%20via%20Mobile%20Devices.&text=Bugsnag%20will%20collect%20certain%20information,operating%20system%20of%20your%20device.)


2 changes: 1 addition & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
@@ -77,7 +77,7 @@ Client may be generated manually using `testing_v1.json` and the master branch o

## Analytics

Flank makes use of various analytics. For more information on what they are and how to control them please see [analyitics.md](analytics.md)
Flank makes use of Bugsnag for analytics. For more information about analytics and how to control them please see [analyitics.md](analytics.md)

## Mock Servers