diff --git a/gamestonk_terminal/config_terminal.py b/gamestonk_terminal/config_terminal.py index bc01d732e5e..ead16aaa51e 100644 --- a/gamestonk_terminal/config_terminal.py +++ b/gamestonk_terminal/config_terminal.py @@ -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 diff --git a/gamestonk_terminal/feature_flags.py b/gamestonk_terminal/feature_flags.py index 80cca187b42..0c22bb276f2 100644 --- a/gamestonk_terminal/feature_flags.py +++ b/gamestonk_terminal/feature_flags.py @@ -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", "") diff --git a/gamestonk_terminal/log_collection.md b/gamestonk_terminal/log_collection.md deleted file mode 100644 index a4a57b3ea9f..00000000000 --- a/gamestonk_terminal/log_collection.md +++ /dev/null @@ -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 :
- ALPHAVANTAGE
- COINBASE,
- COINPAPRIKA
- DEGIRO
- REDDIT|NO| -|User information|Other information that can let identify the users, like :
- E-mail
- LastName,
- 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 :
- help
- load
- candle|NO| -|Commands arguments|Arguments of the commands run during a session, like :
- load TSLA|NO| -|Exception|Exception generated when a commands crashes :
- load TSLA|NO| diff --git a/gamestonk_terminal/reporting.md b/gamestonk_terminal/reporting.md new file mode 100644 index 00000000000..dedef5e1537 --- /dev/null +++ b/gamestonk_terminal/reporting.md @@ -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 :
- ALPHAVANTAGE
- COINBASE,
- COINPAPRIKA
- DEGIRO
- REDDIT|NO| +|User information|Other information that can let identify the users, like :
- E-mail
- LastName
- 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`|
- 3.8.12
- 3.9|YES| +|OS|Platform on which `GamestonkTerminal`, is running like|
- Linux
- Darwin
- Windows|YES| +|Exception/Error|When there is a crash of a command.||YES| +|Timestamp|Timestamp associated with logged information.|
- Launch
- Start of command
- End of command
- Exit
- Exception/Error|YES| +|Command|Commands and arguments run during a session|
- /help
- /crypto/disc/cpsearch -q eth
- /crypto/ov/cpinfo --help
- /stocks/load TSLA
- /stocks/candle --trend|YES|