From 8e4f77d310086168d46a65ab1d9d6da59b8ea144 Mon Sep 17 00:00:00 2001
From: Cole Isaac <82131455+conceptualshark@users.noreply.github.com>
Date: Tue, 5 Jul 2022 10:25:36 -0400
Subject: [PATCH] [#681] add documentation on fideslog use (#751)

* [#681] add documentation on fideslog use

* changelog

* update fidesops use wording
---
 CHANGELOG.md                               |  1 +
 docs/fidesops/docs/development/fideslog.md | 30 ++++++++++++++++++++++
 docs/fidesops/mkdocs.yml                   |  1 +
 3 files changed, 32 insertions(+)
 create mode 100644 docs/fidesops/docs/development/fideslog.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2dccbac27..3467b8de9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -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)
diff --git a/docs/fidesops/docs/development/fideslog.md b/docs/fidesops/docs/development/fideslog.md
new file mode 100644
index 000000000..c1c32d79b
--- /dev/null
+++ b/docs/fidesops/docs/development/fideslog.md
@@ -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).
\ No newline at end of file
diff --git a/docs/fidesops/mkdocs.yml b/docs/fidesops/mkdocs.yml
index 41c5ea7b5..c627a8d7f 100644
--- a/docs/fidesops/mkdocs.yml
+++ b/docs/fidesops/mkdocs.yml
@@ -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