b71abcfbf4
* quick econ fix * black * keys and feature flags * terminal name 👀 * some more replacements * some more replacements * edit pyproject * gst -> openbb * add example portfolios back to git * Update api from gst * sorry. skipping some tests * another round of names * another round of test edits * Missed some .gst refs and update timezone * water mark stuff * Fixing Names in terminal.spec and name of GTFF_DEFAULTS to OBBFF_DEFAULTS * fix more GST to OpenBB Terminal * Logging : merge conflicts with main * Revert wrong files Co-authored-by: Andrew <andrew.kenreich@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2.8 KiB
Vendored
Reporting
This document explains OpenBBTerminal Reporting feature.
1. Purpose
CONTRIBUTE
Code is not the only way you can contribute to improve OpenBBTerminal.
You can help the OpenBBTerminal 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:
- See what your favorite features are, understand why and further improve them.
- Have a look at the most common errors and improve on the ease of use of the terminal.
- 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.
OpenBBTerminal 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 |
NO |
| User information | Other information that can let identify the users, like : - 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 OpenBBTerminal |
- 3.8.12 - 3.9 |
YES |
| OS | Platform on which OpenBBTerminal, 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 |