Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Commit

Permalink
[#681] add documentation on fideslog use (#751)
Browse files Browse the repository at this point in the history
* [#681] add documentation on fideslog use

* changelog

* update fidesops use wording
  • Loading branch information
conceptualshark committed Jul 5, 2022
1 parent 3ea9d19 commit 8e4f77d
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ The types of changes are:
### Docs
* Updated the tutorial installation to use main in fidesdemo [#715](https://github.com/ethyca/fidesops/pull/715)
* Added a page on how to use the datastore UI [#742](https://github.com/ethyca/fidesops/pull/742)
* Added a page on implementing and opting out of fideslog analytics [#751](https://github.com/ethyca/fidesops/pull/751)

### Fixed
* Make reading of environment variables case insensitive [712](https://github.com/ethyca/fidesops/pull/712)
Expand Down
30 changes: 30 additions & 0 deletions docs/fidesops/docs/development/fideslog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Fideslog Analytics

Fidesops includes an implementation of [fideslog](https://github.com/ethyca/fideslog) to provide Ethyca with an understanding of user interactions with fides tooling.

All collected analytics are anonymized, and only used in either product roadmap determination, or as insight into product adoption. Information collected by fideslog is received via HTTPs request, stored in a secure database, and never shared with third parties unless required by law.

More information on use, implementation, and configuration can be found in the [fideslog repository](https://github.com/ethyca/fideslog#readme).

## Collected Data
Fideslog collects information on instances of fidesops by recording internal events. Using fidesops may result in sending any or all of the following analytics data to Ethyca:

| Parameter | Description |
|----|----|
| `docker` | If fidesops is run in a docker container. |
| `event` | The type of analytics event - currently, either a **server start** or **endpoint call**.
| `event_created` | The time of the event. |
| `endpoint` | The endpoint accessed. |
| `status_code` | The status result of the request. |
| `error` | Error information, if any. |

## Disabling Fideslog

To opt out of analytics, set either the following fidesops environment variable or `.toml` configuration variable to `True`.

| Variable | Default | Use |
|---|---|---|
| `ANALYTICS_OPT_OUT` | False | Include in your `fidesops.toml` file. |
| `FIDESOPS__USER__ANALYTICS_OPT_OUT` | False | Include in your environment variables. |

For more information, see the fidesops [configuration guide](../guides/configuration_reference.md).
1 change: 1 addition & 0 deletions docs/fidesops/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ nav:
- Contributing Details: development/contributing_details.md
- Code Style: development/code_style.md
- Documentation: development/documentation.md
- Fideslog Analytics: development/fideslog.md
- Testing: development/testing.md
- Pull Requests: development/pull_requests.md
- Releases: development/releases.md
Expand Down

0 comments on commit 8e4f77d

Please sign in to comment.