From 46a963b557a751c7ae9faa3592087f735ad3f31e Mon Sep 17 00:00:00 2001
From: Pavan Kumar <66913595+ascender1729@users.noreply.github.com>
Date: Mon, 9 Jun 2025 23:36:27 +0530
Subject: [PATCH 1/2] docs: add telemetry guide

---
 docs/swarms/telemetry.md | 42 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 docs/swarms/telemetry.md

diff --git a/docs/swarms/telemetry.md b/docs/swarms/telemetry.md
new file mode 100644
index 00000000..bac54b7b
--- /dev/null
+++ b/docs/swarms/telemetry.md
@@ -0,0 +1,42 @@
+# Telemetry Initialization
+
+Swarms runs a small bootup routine whenever the package is imported. The routine configures logging, sets up a workspace directory and silences verbose output from external libraries. This helps reduce noise in development logs and ensures your agents always have a predictable workspace.
+
+## Initialization Steps
+
+1. The [`bootup`](../../swarms/telemetry/bootup.py) function executes automatically during import.
+2. `bootup` reads the `SWARMS_VERBOSE_GLOBAL` variable to decide if logging should be suppressed.
+3. The WandB library is silenced by setting `WANDB_SILENT` to `"true"`.
+4. A workspace directory named `agent_workspace` is created if it does not already exist and the path is exported to `WORKSPACE_DIR`.
+5. Deprecation warnings are suppressed and `disable_logging()` sets `TF_CPP_MIN_LOG_LEVEL` to `"3"`.
+
+This initialization ensures minimal console output while still capturing important telemetry about your system.
+
+## Enabling or Disabling Telemetry
+
+Telemetry collection is controlled with the environment variable `USE_TELEMETRY`.
+
+```bash
+# Enable telemetry
+USE_TELEMETRY=true
+
+# Disable telemetry
+USE_TELEMETRY=false
+```
+
+When disabled, metrics from the `swarms.telemetry` package are not sent to the analytics endpoint.
+
+## Environment Variables Set on Bootup
+
+| Variable | Default | Purpose |
+|----------|---------|---------|
+| `SWARMS_VERBOSE_GLOBAL` | `False` | Controls the verbosity of logging during startup. |
+| `WANDB_SILENT` | `true` | Prevents the WandB library from printing to stdout. |
+| `WORKSPACE_DIR` | `./agent_workspace` | Path to the working directory used by agents. |
+| `TF_CPP_MIN_LOG_LEVEL` | `3` | Hides TensorFlow warnings when logging is disabled. |
+
+These variables are set automatically each time the package loads so you rarely need to set them manually. `SWARMS_VERBOSE_GLOBAL` is read before bootup to decide whether to disable logging. All others are created or overwritten when the initialization runs.
+
+---
+
+For more details, review the [`bootup` implementation](../../swarms/telemetry/bootup.py) and the [`disable_logging`](../../swarms/utils/disable_logging.py) helper.

From 45d9602242d74e8a0ce2f28709f32c98e7c713c2 Mon Sep 17 00:00:00 2001
From: Pavan Kumar <66913595+ascender1729@users.noreply.github.com>
Date: Mon, 9 Jun 2025 19:22:02 +0000
Subject: [PATCH 2/2] docs: document telemetry configuration and update mkdocs
 config

---
 docs/mkdocs.yml          | 1 +
 docs/swarms/telemetry.md | 2 ++
 2 files changed, 3 insertions(+)

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index d4e9725c..1f4f97f0 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -178,6 +178,7 @@ nav:
       - Installation: "swarms/install/install.md"
       - Environment Configuration: "swarms/install/env.md"
       - Quickstart: "swarms/install/quickstart.md"
+      - Telemetry Setup: "swarms/telemetry.md"
       # - Swarms CLI: "swarms/cli/main.md"
     # - Swarms Framework Architecture: "swarms/concept/framework_architecture.md"
     # - Swarm Ecosystem: "swarms/concept/swarm_ecosystem.md"
diff --git a/docs/swarms/telemetry.md b/docs/swarms/telemetry.md
index bac54b7b..cd0cb3b7 100644
--- a/docs/swarms/telemetry.md
+++ b/docs/swarms/telemetry.md
@@ -15,6 +15,8 @@ This initialization ensures minimal console output while still capturing importa
 ## Enabling or Disabling Telemetry
 
 Telemetry collection is controlled with the environment variable `USE_TELEMETRY`.
+By default, telemetry is disabled, so no data is sent unless you explicitly set
+`USE_TELEMETRY=true`.
 
 ```bash
 # Enable telemetry