feat: introduced conditional tracing at runtime #2289

Gmin2 · 2025-05-27T19:42:27Z

Details

Introduced conditional tracing at runtime by defining set_tracing_active() and is_tracing_active() functions in the config module

Issues

Resolves #2090

Testing

I had craeted a test script that had two tracing enabled(which 8000 is by default) and one disabled

#test_dynamic_tracing.py
import opik
import time
import random

opik.configure(use_local=True)

@opik.track
def sample_function(input_data):
    print(f"Processing: {input_data}")
    time.sleep(0.5)  # Simulate work
    return f"Processed {input_data}"

# Test 1: Verify tracing is enabled by default
print("\n--- Test 1: Default behavior (tracing enabled) ---")
print(f"Is tracing active? {opik.is_tracing_active()}")
result = sample_function("test1")
print(f"Result: {result}")
print("Check Opik UI to confirm trace was created")
time.sleep(2)  

# Test 2: Disable tracing
print("\n--- Test 2: Disable tracing ---")
opik.set_tracing_active(False)
print(f"Is tracing active? {opik.is_tracing_active()}")
result = sample_function("test2")
print(f"Result: {result}")
print("Check Opik UI to confirm NO trace was created")
time.sleep(2)  

# Test 3: Re-enable tracing
print("\n--- Test 3: Re-enable tracing ---")
opik.set_tracing_active(True)
print(f"Is tracing active? {opik.is_tracing_active()}")
result = sample_function("test3")
print(f"Result: {result}")
print("Check Opik UI to confirm trace was created")
time.sleep(2)

and see the logs

opik/sdks/python git:dynamic-tracing*  
(venv) ❯ python3 test_dynamic_tracing.py
Found local Opik instance on: http://localhost:5173/, do you want to use it? (Y/n)Y
OPIK: Configuration saved to file: /home/mintu-ubuntu/.opik.config

--- Test 1: Default behavior (tracing enabled) ---
Is tracing active? True
Processing: test1
OPIK: Started logging traces to the "Default Project" project at http://localhost:5173/api/v1/session/redirect/projects/?trace_id=0197133d-021a-7cc6-b421-0aabe1cecf2e&path=aHR0cDovL2xvY2FsaG9zdDo1MTczL2FwaS8=.
Result: Processed test1
Check Opik UI to confirm trace was created

--- Test 2: Disable tracing ---
Is tracing active? False
Processing: test2
Result: Processed test2
Check Opik UI to confirm NO trace was created

--- Test 3: Re-enable tracing ---
Is tracing active? True
Processing: test3
Result: Processed test3
Check Opik UI to confirm trace was created

and see in the ui there is no traces of test 2

Screencast.from.2025-05-28.01-04-04.mp4

Documentation

Updated the docs of sdk python

/claim #2090

vincentkoc · 2025-05-29T13:58:03Z

@Gmin2 few of your PRs are blocked. The NLTK one will be merged once we resolve an issue with our unit tests, they are failing due to PR being an outside contributor. Bear with us 🙏

alexkuzmik · 2025-05-28T10:32:50Z

sdks/python/src/opik/config.py

+        True if tracing is active, False otherwise.
+    """
+    global _tracing_active
+    if os.environ.get("OPIK_TRACK_DISABLE", "").lower() in ("true", "1", "yes"):


we should use opik.config.OpikConfig to get this information, it handles not only env vars, but the config file as well.

If someone enables tracing via the python function, it should take priority over the environment variable.

alexkuzmik · 2025-05-30T10:46:56Z

sdks/python/src/opik/decorator/base_track_decorator.py

@@ -273,6 +278,11 @@ def _tracked_sync(
    ) -> Callable:
        @functools.wraps(func)
        def wrapper(*args, **kwargs) -> Any:  # type: ignore
+            from .. import config


All imports should be moved to the top of the module.

alexkuzmik · 2025-05-30T10:51:08Z

sdks/python/src/opik/config.py

@@ -34,6 +34,30 @@

 LOGGER = logging.getLogger(__name__)

+_tracing_active = True  # Default to enabled


No need for the comment

alexkuzmik · 2025-05-30T10:59:14Z

sdks/python/src/opik/decorator/base_track_decorator.py

@@ -152,6 +152,11 @@ def _decorate(
        So these spans can't be parents for other spans. This is usually the case LLM API calls
        with `stream=True`.
        """
+        from .. import config
+        # Check if tracing is active at runtime
+        if self.disabled or not config.is_tracing_active():


The idea behind the conditional tracing at runtime is that you can switch the parameter to on/off and your code will log/not log the data without any extra manipulations.
With that logic, if the tracing was disabled when the tracked function was initialized, after enabling the tracing - it will not work, because the function is not decorated.

So:

the decorated objects should remain decorated

the only part which will be enabled/disabled is the part that submits traces and spans

There must be proper and extensive unit tests working with fake_backend fixture to test that it really works as expected (inside tests/unit/decorator).

@Gmin2 I've updated this comment to change the expected behavior a bit, should be more straightforward now. The context manipulations will still happen, only the parts where the spans/traces are submitted via Opik client should be disabled.

alexkuzmik · May 30, 2025

sdks/python/src/opik/integrations/aisuite/opik_tracker.py

@@ -23,6 +24,10 @@ def track_aisuite(
    Returns:
        The modified AISuite client with Opik tracking enabled.
    """
+    # Check if tracing is active
+    if not is_tracing_active():


No integration should have this logic when trace_* is called. The enable/disable tracing logic should live only in base_track_decorator.

alexkuzmik · 2025-05-30T11:03:21Z

sdks/python/src/opik/config.py

@@ -34,6 +34,30 @@

 LOGGER = logging.getLogger(__name__)

+_tracing_active = True  # Default to enabled
+
+def set_tracing_active(active: bool) -> None:


I'd move these functions to opik.decorator namespace.

vincentkoc · 2025-06-17T12:33:03Z

@Gmin2 are you still working on this?

Gmin2 · 2025-06-18T02:57:45Z

yes, on it

Changes in this commit - A new global toggle controlled by `opik.set_tracing_active()` and `opik.is_tracing_active()`. - The core `@track` decorator logic has been refactored to always manage context but conditionally submit trace data based on the runtime toggle. This ensures functions remain correctly instrumented even when tracing is re-enabled at runtime. - The runtime toggle takes precedence over configuration from files or environment variables. - All library integration trackers now defer to the central decorator logic for consistency. - A comprehensive test suite has been added to validate the new functionality. - Added detailed uint test

feat: introduced dynamic tracing at runtime

5db576e

Gmin2 requested a review from a team as a code owner May 27, 2025 19:42

algora-pbc bot added the 🙋 Bounty claim label May 27, 2025

algora-pbc bot mentioned this pull request May 27, 2025

[FR]: Conditional tracing at runtime #2090

Open

Nimrod007 temporarily deployed to external-contributors May 29, 2025 13:07 — with GitHub Actions Inactive

alexkuzmik requested changes May 30, 2025

View reviewed changes

Gmin2 force-pushed the dynamic-tracing branch from fc66690 to e8d915e Compare June 20, 2025 06:49

Gmin2 requested a review from a team as a code owner June 20, 2025 06:49

Gmin2 and others added 4 commits June 20, 2025 12:27

feat(tracing): resolve merge conflicts and mypy errors

006fd33

feat(tracing): implement stable dynamic tracing before merge

5fcd39e

Merge branch 'main' into dynamic-tracing

f61a4fe

Merge branch 'main' into dynamic-tracing

b565163

Gmin2 requested a review from alexkuzmik June 20, 2025 07:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: introduced conditional tracing at runtime #2289

feat: introduced conditional tracing at runtime #2289

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

		@@ -34,6 +34,30 @@

		LOGGER = logging.getLogger(__name__)

		_tracing_active = True # Default to enabled

feat: introduced conditional tracing at runtime #2289

Are you sure you want to change the base?

feat: introduced conditional tracing at runtime #2289

Uh oh!

Conversation

Details

Issues

Testing

Documentation

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!