Change recording to create a span of type "record_root" #1703

sfc-gh-gtokernliang · 2024-12-19T17:35:27Z

Description

Updated the app context manager to be able to create a span of type "record_root"

Other details good to know for developers

For reference, this is the current set of spans as produced in the notebook:

{
    "name": "nested2",
    "context": {
        "trace_id": "0xac43c20656ef1ed158f02f4e62c97a04",
        "span_id": "0x424b5fe0f1f1a867",
        "trace_state": "[]"
    },
    "kind": "SpanKind.INTERNAL",
    "parent_id": "0xe197ec362bed5183",
    "start_time": "2024-12-19T17:17:48.214895Z",
    "end_time": "2024-12-19T17:17:48.828808Z",
    "status": {
        "status_code": "UNSET"
    },
    "attributes": {
        "name": "nested2",
        "kind": "SPAN_KIND_TRULENS",
        "parent_span_id": 4777017249493002343,
        "trulens.record_id": "bbd1b4dc-75fb-4d93-993d-e989e161330a",
        "nested2_ret": "nested2: test",
        "nested2_args[0]": "test",
        "status": "STATUS_CODE_UNSET"
    },
    "events": [],
    "links": [],
    "resource": {
        "attributes": {
            "telemetry.sdk.language": "python",
            "telemetry.sdk.name": "opentelemetry",
            "telemetry.sdk.version": "1.25.0",
            "service.name": "trulens"
        },
        "schema_url": ""
    }
}
{
    "name": "nested",
    "context": {
        "trace_id": "0xac43c20656ef1ed158f02f4e62c97a04",
        "span_id": "0xe197ec362bed5183",
        "trace_state": "[]"
    },
    "kind": "SpanKind.INTERNAL",
    "parent_id": "0x90ebf55e6bebc620",
    "start_time": "2024-12-19T17:17:47.576714Z",
    "end_time": "2024-12-19T17:17:49.875737Z",
    "status": {
        "status_code": "UNSET"
    },
    "attributes": {
        "name": "nested",
        "kind": "SPAN_KIND_TRULENS",
        "parent_span_id": 16255721097426456963,
        "trulens.record_id": "bbd1b4dc-75fb-4d93-993d-e989e161330a",
        "nested_attr1": "value1",
        "status": "STATUS_CODE_UNSET"
    },
    "events": [],
    "links": [],
    "resource": {
        "attributes": {
            "telemetry.sdk.language": "python",
            "telemetry.sdk.name": "opentelemetry",
            "telemetry.sdk.version": "1.25.0",
            "service.name": "trulens"
        },
        "schema_url": ""
    }
}
{
    "name": "respond_to_query",
    "context": {
        "trace_id": "0xac43c20656ef1ed158f02f4e62c97a04",
        "span_id": "0x90ebf55e6bebc620",
        "trace_state": "[]"
    },
    "kind": "SpanKind.INTERNAL",
    "parent_id": "0x47c29031b69b4971",
    "start_time": "2024-12-19T17:17:46.523158Z",
    "end_time": "2024-12-19T17:17:50.869185Z",
    "status": {
        "status_code": "UNSET"
    },
    "attributes": {
        "name": "respond_to_query",
        "kind": "SPAN_KIND_TRULENS",
        "parent_span_id": 10442709946874971680,
        "trulens.record_id": "bbd1b4dc-75fb-4d93-993d-e989e161330a",
        "status": "STATUS_CODE_UNSET"
    },
    "events": [],
    "links": [],
    "resource": {
        "attributes": {
            "telemetry.sdk.language": "python",
            "telemetry.sdk.name": "opentelemetry",
            "telemetry.sdk.version": "1.25.0",
            "service.name": "trulens"
        },
        "schema_url": ""
    }
}
{
    "name": "root",
    "context": {
        "trace_id": "0xac43c20656ef1ed158f02f4e62c97a04",
        "span_id": "0x47c29031b69b4971",
        "trace_state": "[]"
    },
    "kind": "SpanKind.INTERNAL",
    "parent_id": null,
    "start_time": "2024-12-19T17:17:42.002877Z",
    "end_time": "2024-12-19T17:17:51.852615Z",
    "status": {
        "status_code": "UNSET"
    },
    "attributes": {
        "kind": "SPAN_KIND_TRULENS",
        "name": "root",
        "trulens.span_type": "record_root",
        "trulens.record_root.app_name": "default_app",
        "trulens.record_root.app_version": "base",
        "trulens.record_root.app_id": "app_hash_baf7b2cb6402e84fa3b0b3a028d4bf65",
        "trulens.record_root.record_id": "bbd1b4dc-75fb-4d93-993d-e989e161330a"
    },
    "events": [],
    "links": [],
    "resource": {
        "attributes": {
            "telemetry.sdk.language": "python",
            "telemetry.sdk.name": "opentelemetry",
            "telemetry.sdk.version": "1.25.0",
            "service.name": "trulens"
        },
        "schema_url": ""
    }
}

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to
not work as expected)
New Tests
This change includes re-generated golden test results
This change requires a documentation update

Important

Add record_root span type to app context manager for enhanced tracing with OpenTelemetry.

Behavior:
- Add span type record_root to app context manager in app.py.
- Update App class in instrument.py to manage record_root spans with OpenTelemetry.
Attributes:
- Add SPAN_TYPE and RECORD_ID attributes in trace.py for span identification.
Imports:
- Change import paths from trulens.experimental.otel_tracing.core.app to trulens.experimental.otel_tracing.core.instrument in app.py.

^{This description was created by}^{for 6b063f5. It will automatically update as commits are pushed.}

review-notebook-app · 2024-12-19T17:35:32Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

sfc-gh-dkurokawa · 2024-12-20T21:56:36Z

examples/experimental/otel_exporter.ipynb

@@ -67,6 +87,7 @@
    "dotenv.load_dotenv()\n",
    "\n",
    "session = TruSession()\n",
+    "session.experimental_enable_feature(\"otel_tracing\")\n",


note that this will enable some other stuff Piotr put in.

sfc-gh-dkurokawa · 2024-12-20T21:57:54Z

src/otel/semconv/trulens/otel/semconv/trace.py

@@ -34,6 +34,12 @@ class SpanAttributes:
    In some cases below, we also include span name or span name prefix.
    """

+    SPAN_TYPE = "trulens.span_type"


probably can remove L43 unless there's an argument to be made for multiple span types.

sfc-gh-dkurokawa · 2024-12-20T22:00:31Z

src/core/trulens/experimental/otel_tracing/core/instrument.py

+        tracer = trace.get_tracer_provider().get_tracer(TRULENS_SERVICE_NAME)
+
+        # Calling set_baggage does not actually add the baggage to the current context, but returns a new one
+        # To avoid issues with remembering to add/remove the baggage, we attach it to the runtime context.


I also don't really get this token business, can you enlighten me?

sfc-gh-dkurokawa · 2024-12-20T22:07:11Z

src/core/trulens/experimental/otel_tracing/core/instrument.py

+        root_span.set_attribute(SpanAttributes.RECORD_ROOT.APP_ID, self.app_id)
+        root_span.set_attribute(
+            SpanAttributes.RECORD_ROOT.RECORD_ID, otel_record_id
+        )


the semantic convention that Piotr laid out also has the MAIN_INPUT/MAIN_OUTPUT/MAIN_ERROR, but I don't see how we can get that even during __exit__, so I'm inclined to say we can remove them. Though that raises the question of, how will the UI know what the input and output are to display. It's too close to the finish line of 2024 that I don't want to investigate how this is determined currently but can next year haha.

There's also TOTAL_COST but I'm not as worried about that.

sfc-gh-dkurokawa · 2024-12-20T22:11:36Z

src/core/trulens/experimental/otel_tracing/core/instrument.py

@@ -51,6 +58,10 @@ def wrapper(*args, **kwargs):
                span.set_attribute(
                    "parent_span_id", parent_span.get_span_context().span_id
                )
+                span.set_attribute(


we want app/run id in the baggage as well I guess, but given that it's not totally clear yet no point in doing it now I suppose.

sfc-gh-gtokernliang requested a review from sfc-gh-dkurokawa December 19, 2024 17:35

dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Dec 19, 2024

sfc-gh-gtokernliang force-pushed the garett/SNOW-1854278 branch from 9ab5db6 to 049b404 Compare December 19, 2024 20:24

sfc-gh-gtokernliang force-pushed the garett/SNOW-1854070 branch from 712f97b to c9db9a1 Compare December 19, 2024 20:33

sfc-gh-dkurokawa reviewed Dec 20, 2024

View reviewed changes

sfc-gh-gtokernliang force-pushed the garett/SNOW-1854278 branch from 27bcac5 to e1b685c Compare December 21, 2024 00:26

sfc-gh-gtokernliang added 8 commits December 20, 2024 19:27

save

7828c6f

draft

ae0e4d8

update

474a2f0

save

c765c7b

add back debugger

b0a721d

update notebook

ede48a1

fix

d8a4062

update semcov

6b063f5

sfc-gh-gtokernliang force-pushed the garett/SNOW-1854070 branch from 6e3c22f to 6b063f5 Compare December 21, 2024 00:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change recording to create a span of type "record_root" #1703

Change recording to create a span of type "record_root" #1703

sfc-gh-gtokernliang commented Dec 19, 2024 •

edited by ellipsis-dev bot

Loading

review-notebook-app bot commented Dec 19, 2024

sfc-gh-dkurokawa Dec 20, 2024

sfc-gh-dkurokawa Dec 20, 2024

sfc-gh-dkurokawa Dec 20, 2024

sfc-gh-dkurokawa Dec 20, 2024

sfc-gh-dkurokawa Dec 20, 2024

sfc-gh-dkurokawa Dec 20, 2024

Change recording to create a span of type "record_root" #1703

Are you sure you want to change the base?

Change recording to create a span of type "record_root" #1703

Conversation

sfc-gh-gtokernliang commented Dec 19, 2024 • edited by ellipsis-dev bot Loading

Description

Other details good to know for developers

Type of change

review-notebook-app bot commented Dec 19, 2024

sfc-gh-dkurokawa Dec 20, 2024

Choose a reason for hiding this comment

sfc-gh-dkurokawa Dec 20, 2024

Choose a reason for hiding this comment

sfc-gh-dkurokawa Dec 20, 2024

Choose a reason for hiding this comment

sfc-gh-dkurokawa Dec 20, 2024

Choose a reason for hiding this comment

sfc-gh-dkurokawa Dec 20, 2024

Choose a reason for hiding this comment

sfc-gh-dkurokawa Dec 20, 2024

Choose a reason for hiding this comment

sfc-gh-gtokernliang commented Dec 19, 2024 •

edited by ellipsis-dev bot

Loading