terminal logs in jupyter notebooks (#1049)

* init() sets auto_start_session to false if in notebook and changed docs

* deal with non-notebook manual trace

* ruff, if you will

* ruff redux

* ruff redux 2

* fix ruff deletion

---------

Co-authored-by: Pratyush Shukla <[email protected]>

Author: michi-okahata

agentops/__init__.py

@@ -116,6 +116,13 @@ def init(
     elif default_tags:
         merged_tags = default_tags
 
+    # Check if in a Jupyter Notebook (manual start/end_trace())
+    try:
+        get_ipython().__class__.__name__ == "ZMQInteractiveShell"  # type: ignore
+        auto_start_session = False
+    except NameError:
+        pass
+
     # Prepare initialization arguments
     init_kwargs = {
         "api_key": api_key,

agentops/instrumentation/__init__.py

@@ -35,7 +35,6 @@
 from agentops.logging import logger
 from agentops.sdk.core import tracer
 
-
 # Module-level state variables
 _active_instrumentors: list[BaseInstrumentor] = []
 _original_builtins_import = builtins.__import__  # Store original import

docs/v2/usage/sdk-reference.mdx

@@ -29,7 +29,7 @@ Initializes the AgentOps SDK and automatically starts tracking your application.
 - `default_tags` (List[str], optional): Default tags for the sessions that can be used for grouping or sorting later (e.g. ["GPT-4"]).
 - `tags` (List[str], optional): [Deprecated] Use `default_tags` instead.
 - `instrument_llm_calls` (bool, optional): Whether to instrument LLM calls automatically. Defaults to True.
-- `auto_start_session` (bool, optional): Whether to start a session automatically when the client is created. Defaults to True.
+- `auto_start_session` (bool, optional): Whether to start a session automatically when the client is created. Set to False if running in a Jupyter Notebook. Defaults to True.
 - `auto_init` (bool, optional): Whether to automatically initialize the client on import. Defaults to True.
 - `skip_auto_end_session` (bool, optional): Don't automatically end session based on your framework's decision-making. Defaults to False.
 - `env_data_opt_out` (bool, optional): Whether to opt out of collecting environment data. Defaults to False.

examples/openai_agents/customer_service_agent.ipynb

@@ -96,7 +96,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "agentops.init(tags=[\"customer-service-agent\", \"openai-agents\", \"agentops-example\"], auto_start_session=False)\n",
+    "agentops.init(tags=[\"customer-service-agent\", \"openai-agents\", \"agentops-example\"])\n",
     "tracer = agentops.start_trace(trace_name=\"Customer Service Agent\")"
    ]
   },