jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-31 22:41:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Log Collection : Enabling (#1567)

Browse Source 
* Privacy : update md

* Log Collection : markdown

* Log Collectiong : linting

* Log Collection : Enabling

* refined text

* refined text2

* Log Collection : update privacy md

* Log Collection : markdown

* refined text3

* Log Collection : disabling rolling clock

Co-authored-by: LBolte29 <lbolte@gmx.net>
This commit is contained in:
Chavithra
2022-03-28 17:47:19 +02:00
committed by GitHub
parent b2ac3465e5
commit 07537790fe
4 changed files with 73 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
gamestonk_terminal/config_terminal.py
View File

@@ -38,7 +38,7 @@ LOGGING_AWS_SECRET_ACCESS_KEY = os.getenv("GT_LOGGING_AWS_SECRET_ACCESS_KEY") or
LOGGING_FREQUENCY = os.getenv("GT_LOGGING_FREQUENCY") or "H"
# stdout,stderr,noop,file
LOGGING_HANDLERS = os.getenv("GT_LOGGING_HANDLERS") or "file"
LOGGING_ROLLING_CLOCK = strtobool(os.getenv("GT_LOGGING_ROLLING_CLOCK") or "True")
LOGGING_ROLLING_CLOCK = strtobool(os.getenv("GT_LOGGING_ROLLING_CLOCK") or "False")
# CRITICAL = 50
# FATAL = CRITICAL
# ERROR = 40

2
gamestonk_terminal/feature_flags.py
View File

@@ -65,7 +65,7 @@ ENABLE_RICH_PANEL = strtobool(os.getenv("GTFF_ENABLE_RICH_PANEL", "True"))
ENABLE_CHECK_API = strtobool(os.getenv("GTFF_ENABLE_CHECK_API", "True"))
# Send logs to data lake
LOG_COLLECTION = strtobool(os.getenv("GTFF_LOG_COLLECTION", "False"))
LOG_COLLECTION = strtobool(os.getenv("GTFF_LOG_COLLECTION", "True"))
# Provide export folder path. If empty that means default.
EXPORT_FOLDER_PATH = os.getenv("GTFF_EXPORT_FOLDER_PATH", "")

71
gamestonk_terminal/log_collection.md vendored
View File

@@ -1,71 +0,0 @@
# Log Collection Feature
## 1. Purpose
**GOAL**
In order to improve GamestonkTerminal, we need to know how people are using the tool, like :
- Which are the most used features
- Are they bugs/crashes on certain configuration (OS, python version...)
Knowing that we can focus part of our engineering effort on most common use cases.
**ISSUE**
GamestonkTerminal is an onsite application : that you install on your computer.
On a contrary of a web application that can track the usage of every button and page : we have no means to know what happens once GamestonkTerminal is installed on a computer.
**LOG COLLECTION**
Log Collection feature allow exportation of some GamestonkTerminal logs.
We are not logging credentials or elements that allows identifying you.
And we are exporting only limited portion of these logs.
## 2. How to setup : Log Collection ?
By default log collection are enabled.
**ENABLE**
Set this environment variable :
```sh
GTFF_LOG_COLLECTION = True
```
**DISABLE**
Set this environment variable :
```sh
GTFF_LOG_COLLECTION = False
```
## 3. What is collected ?
**PRIVACY**
We are making sure that none of this data are collect :
- data that let identify you
- credentials you might use with the Terminal
**DATA LIST**
Here is a list of data and whether they are collected or no :
|**Data**|**Description**|**Collected ?**|
|:-|:-|:-|
|User IP Address|User IP address.|NO|
|User API KEYS|API Keys to connect to third parties API, like : <br>- ALPHAVANTAGE <br> - COINBASE, <br>- COINPAPRIKA <br>- DEGIRO <br>- REDDIT|NO|
|User information|Other information that can let identify the users, like : <br>- E-mail <br> - LastName, <br>- Firstname|NO|
|Session duration|Start and end time of a session.|YES|
|Session size|Number of line logged within a user session.|YES|
|Number of error|Number of error lines logged within a user session.|YES|
|Commands|Commands run during a session, like : <br>- help <br>- load <br>- candle|NO|
|Commands arguments|Arguments of the commands run during a session, like : <br>- load TSLA|NO|
|Exception|Exception generated when a commands crashes : <br>- load TSLA|NO|

71
gamestonk_terminal/reporting.md vendored Normal file
View File

@@ -0,0 +1,71 @@
# `Reporting`
This document explains `GamestonkTerminal` `Reporting` feature.
## 1. Purpose
**CONTRIBUTE**
Code is not the only way you can contribute to improve `GamestonkTerminal`.
You can help the `GamestonkTerminal` Community by enabling sending logs about the usage of the terminal and errors.
If you are concerned about privacy, be assured, we do **not** collect any:
- Personal Identifiable Information (PII).
- Credentials.
This means that you will stay anonymous at all time.
**REASONS**
With your these reports, we can:
1. See what your favorite features are, understand why and further improve them.
2. Have a look at the most common errors and improve on the ease of use of the terminal.
3. Check for incompatibilities of different operating systems and python versions.
This helps to resolve bugs faster and focus the attention of the developers on what is important to you.
`GamestonkTerminal` is an on-site application: you install it on your computer.
On a contrary of a web application that can track the usage of every button and page, we need logs to be sent to us to understand where to spend our time and effort.
## 2. Disable/Enable `Reporting` ?
By default Reporting is enabled.
You can disable it running the command: `/settings/logcollection`
The key `logcollection` should appear in red in the `/settings/help` table when disabled.
You can do the same operation to re-enable it : `logcollection` will appear in green.
## 3. What is and is not collected ?
**NOT COLLECTED**
We have a filter in place, to prevent any Personal Identifiable information saved in the reports.
Credentials are not reported at all.
Here is a list of data we are not collecting :
|**Data**|**Description**|**Collected ?**|
|:-|:-|:-|
|User IP Address|User IP address.|NO|
|User API KEYS|API Keys to connect to third parties API, like : <br>- ALPHAVANTAGE <br> - COINBASE, <br>- COINPAPRIKA <br>- DEGIRO <br>- REDDIT|NO|
|User information|Other information that can let identify the users, like : <br>- E-mail <br> - LastName <br>- Firstname|NO|
|File/Folder paths|When errors occurs usually computers paths are shown : we filter those.|NO|
**COLLECTED**
Here is an exhaustive list of what can be collected :
|**Data**|**Description**|**Examples**|**Collected ?**|
|:-|:-|:-|:-|
|Python version|Python version on which `GamestonkTerminal`|<br>- 3.8.12 <br>- 3.9|YES|
|OS|Platform on which `GamestonkTerminal`, is running like|<br>- Linux <br>- Darwin <br>- Windows|YES|
|Exception/Error|When there is a crash of a command.||YES|
|Timestamp|Timestamp associated with logged information.|<br>- Launch <br>- Start of command<br>- End of command<br>- Exit<br>- Exception/Error|YES|
|Command|Commands and arguments run during a session|<br>- /help <br>- /crypto/disc/cpsearch -q eth <br>- /crypto/ov/cpinfo --help <br>- /stocks/load TSLA <br>- /stocks/candle --trend|YES|