diff --git a/README.md b/README.md index 4c613826ba..9419758cee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# Flank [![Build Status](https://app.bitrise.io/app/9767f3e19047d4db/status.svg?token=uDM3wCumR2xTd0axh4bjDQ&branch=master)](https://app.bitrise.io/app/9767f3e19047d4db) [![codecov](https://codecov.io/gh/Flank/flank/branch/master/graph/badge.svg)](https://codecov.io/gh/Flank/flank) [![pullreminders](https://pullreminders.com/badge.svg)](https://pullreminders.com?ref=badge) +# Flank [![codecov](https://codecov.io/gh/Flank/flank/branch/master/graph/badge.svg)](https://codecov.io/gh/Flank/flank) -Flank is a [massively parallel Android and iOS test runner](https://docs.google.com/presentation/d/1goan9cXpimSJsS3L60WjljnFA_seUyaWb2e-bezm084/edit#slide=id.p1) for [Firebase Test Lab](https://firebase.google.com/docs/test-lab/). +Flank is a [massively parallel Android and iOS test runner](https://docs.google.com/presentation/d/1goan9cXpimSJsS3L60WjljnFA_seUyaWb2e-bezm084/edit#slide=id.p1) for [Firebase Test Lab](https://firebase.google.com/docs/test-lab/). + +Flank is YAML compatible with [the gcloud CLI](https://cloud.google.com/sdk/gcloud/reference/alpha/firebase/test). Flank provides extra features to accelerate velocity and increase quality. ## Download @@ -10,6 +12,8 @@ https://github.com/Flank/flank/releases/latest/download/flank.jar [](https://www.bugsnag.com/) +See [docs/error_monitoring.md](./docs/error_monitoring.md) to disable Bugsnag error monitoring. + ### Contributing - Install [Oracle JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) @@ -21,14 +25,12 @@ https://github.com/Flank/flank/releases/latest/download/flank.jar ### Features -Available now | 2019 - -- | -- -Test sharding | Client/Server refactor -Cost reporting -Stability testing -HTML report -JUnit XML report -Smart Flank +- Test sharding +- Cost reporting +- Stability testing +- HTML report +- JUnit XML report +- Smart Flank ### Exit Codes diff --git a/docs/error_monitoring.md b/docs/error_monitoring.md new file mode 100644 index 0000000000..e491052a5f --- /dev/null +++ b/docs/error_monitoring.md @@ -0,0 +1,35 @@ +# Flank Error Monitoring + +Flank uses Bugsnag to monitor test runner stability. Bugsnag enables data driven decisions when prioritizing bug fixes. + +- https://www.bugsnag.com/ +- https://docs.bugsnag.com/ + +## Data Captured + +Bugsnag captures the following error data: + +Flank + - Stacktrace + - releaseStage of Flank (production or snapshot) + - version of Flank (git commit Flank was built from) + +Device + - hostname + - locale + - osArch + - osName + - osVersion + - runtimeVersions of Java + +## Disable Bugsnag + +Flank respects the same analytics opt out as gcloud CLI. + +`echo "DISABLED" > ~/.gsutil/analytics-uuid` + +## More information + +To see how Bugsnag is integrated within the Flank project please see the [Flank Bugsnag testcase](../test_runner/src/test/kotlin/ftl/util/FlankBugsnagInitHelperTest.kt) and [the actual Bugsnag implementation](../test_runner/src/main/kotlin/ftl/util/BugsnagInitHelper.kt) + +- [Bugsnag data policy](https://docs.bugsnag.com/legal/privacy-policy/#:~:text=Services%20via%20Mobile%20Devices.&text=Bugsnag%20will%20collect%20certain%20information,operating%20system%20of%20your%20device.) diff --git a/docs/readme.md b/docs/readme.md index 452b4f8ab9..1a21e5ab94 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -75,6 +75,10 @@ Client may be generated manually using `testing_v1.json` and the master branch o - `gradle build` +## Analytics + +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 API Discovery JSON may be converted to OpenAPI 3 using [apimatic.io/transformer](https://apimatic.io/transformer). See [mock_server.md](mock_server.md) for details. diff --git a/release_notes.md b/release_notes.md index 5701400b84..70582ee3e1 100644 --- a/release_notes.md +++ b/release_notes.md @@ -1,5 +1,5 @@ ## next (unreleased) -- +- [#987](https://github.com/Flank/flank/pull/987) Flank Error Monitoring readme addition ([sloox](https://github.com/Sloox)) - ## v20.08.1