-
Notifications
You must be signed in to change notification settings - Fork 996
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: refactor graph section and added telemetry
- Loading branch information
Showing
5 changed files
with
309 additions
and
225 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
=============== | ||
Usage Analytics | ||
=============== | ||
|
||
ScrapeGraphAI collects **anonymous** usage data by default to improve the library and guide development efforts. | ||
|
||
**Events Captured** | ||
|
||
We capture events in the following scenarios: | ||
|
||
1. When a ``Graph`` finishes running. | ||
2. When an exception is raised in one of the nodes. | ||
|
||
**Data Collected** | ||
|
||
The data captured is limited to: | ||
|
||
- Operating System and Python version | ||
- A persistent UUID to identify the session, stored in ``~/.scrapegraphai.conf`` | ||
|
||
Additionally, the following properties are collected: | ||
|
||
.. code-block:: python | ||
properties = { | ||
"graph_name": graph_name, | ||
"llm_model": llm_model_name, | ||
"embedder_model": embedder_model_name, | ||
"source_type": source_type, | ||
"execution_time": execution_time, | ||
"error_node": error_node_name, | ||
} | ||
For more details, refer to the `telemetry.py <https://github.com/VinciGit00/Scrapegraph-ai/blob/main/scrapegraphai/telemetry/telemetry.py>`_ module. | ||
|
||
**Opting Out** | ||
|
||
If you prefer not to participate in telemetry, you can opt out using any of the following methods: | ||
|
||
1. **Programmatically Disable Telemetry**: | ||
|
||
Add the following code at the beginning of your script: | ||
|
||
.. code-block:: python | ||
from scrapegraphai import telemetry | ||
telemetry.disable_telemetry() | ||
2. **Configuration File**: | ||
|
||
Set the ``telemetry_enabled`` key to ``false`` in ``~/.scrapegraphai.conf`` under the ``[DEFAULT]`` section: | ||
|
||
.. code-block:: ini | ||
[DEFAULT] | ||
telemetry_enabled = False | ||
3. **Environment Variable**: | ||
|
||
- **For a Shell Session**: | ||
|
||
.. code-block:: bash | ||
export SCRAPEGRAPHAI_TELEMETRY_ENABLED=false | ||
- **For a Single Command**: | ||
|
||
.. code-block:: bash | ||
SCRAPEGRAPHAI_TELEMETRY_ENABLED=false python my_script.py | ||
By following any of these methods, you can easily opt out of telemetry and ensure your usage data is not collected. |
Oops, something went wrong.