[MLOB-1540] add llmobs configuration to global tracer config #4696

sabrenner · 2024-09-17T19:08:47Z

What does this PR do?

Adds LLM Observability configuration options to the global tracer config.

There is one caveat in the behavior implemented in the config here: config.llmobs.enabled is computed intentionally with regards to environment variable first (DD_LLMOBS_ENABLED), then if the corresponding options object exists. This breaks the normal pattern of options taking precedence over environment, but is in parity with our LLMObs Python SDK.

Additionally, there is no consensus on if we'll want this to be placed under experimental yet or not. I've included in this PR a change that will coalesce llmobs from either the general or experimental options onto the general options, and is used as such for the rest of the config (as is done with appsec and iast).

Motivation

First PR in a set of PRs to release a Node.js LLM Obs SDK within the tracer.

github-actions · 2024-09-17T19:09:37Z

Overall package size

Self size: 7.15 MB
Deduped: 62.51 MB
No deduping: 62.79 MB

Dependency sizes

| name | version | self size | total size | |------|---------|-----------|------------| | @datadog/native-appsec | 8.1.1 | 18.67 MB | 18.68 MB | | @datadog/native-iast-taint-tracking | 3.1.0 | 12.27 MB | 12.28 MB | | @datadog/pprof | 5.3.0 | 9.85 MB | 10.22 MB | | protobufjs | 7.2.5 | 2.77 MB | 5.16 MB | | @datadog/native-iast-rewriter | 2.4.1 | 2.14 MB | 2.23 MB | | @opentelemetry/core | 1.14.0 | 872.87 kB | 1.47 MB | | @datadog/native-metrics | 2.0.0 | 898.77 kB | 1.3 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | jsonpath-plus | 9.0.0 | 580.4 kB | 1.03 MB | | import-in-the-middle | 1.8.1 | 71.67 kB | 785.15 kB | | msgpack-lite | 0.1.26 | 201.16 kB | 281.59 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | pprof-format | 2.1.0 | 111.69 kB | 111.69 kB | | @datadog/sketches-js | 2.1.0 | 109.9 kB | 109.9 kB | | semver | 7.6.3 | 95.82 kB | 95.82 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | lru-cache | 7.14.0 | 74.95 kB | 74.95 kB | | ignore | 5.3.1 | 51.46 kB | 51.46 kB | | int64-buffer | 0.1.10 | 49.18 kB | 49.18 kB | | shell-quote | 1.8.1 | 44.96 kB | 44.96 kB | | istanbul-lib-coverage | 3.2.0 | 29.34 kB | 29.34 kB | | rfdc | 1.3.1 | 25.21 kB | 25.21 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 kB | | dc-polyfill | 0.1.4 | 23.1 kB | 23.1 kB | | retry | 0.13.1 | 18.85 kB | 18.85 kB | | jest-docblock | 29.7.0 | 8.99 kB | 12.76 kB | | crypto-randomuuid | 1.0.0 | 11.18 kB | 11.18 kB | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | path-to-regexp | 0.1.10 | 6.38 kB | 6.38 kB | | module-details-from-path | 1.0.3 | 4.47 kB | 4.47 kB |

_{🤖 This report was automatically generated by heaviest-objects-in-the-universe}

codecov · 2024-09-17T19:11:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (sabrenner/llmobs-sdk-release@d871335). Learn more about missing BASE report.

Additional details and impacted files

@@                       Coverage Diff                       @@
##             sabrenner/llmobs-sdk-release    #4696   +/-   ##
===============================================================
  Coverage                                ?   88.29%           
===============================================================
  Files                                   ?      307           
  Lines                                   ?    13006           
  Branches                                ?       33           
===============================================================
  Hits                                    ?    11483           
  Misses                                  ?     1523           
  Partials                                ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pr-commenter · 2024-09-17T19:19:54Z

Benchmarks

Benchmark execution time: 2024-09-18 17:53:15

Comparing candidate commit 3bd6bb5 in PR branch sabrenner/llmobs-config with baseline commit d871335 in branch sabrenner/llmobs-sdk-release.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 259 metrics, 7 unstable metrics.

Yun-Kim

LGTM on behalf of team mlobs other than one question about precedence

packages/dd-trace/test/config.spec.js

packages/dd-trace/src/config.js

packages/dd-trace/test/config.spec.js

sabrenner · 2024-09-17T20:55:55Z

@ida613 I've tried to address some of the concerns in setting config.llmobs.enabled in 8fd4912. let me know what you think!

packages/dd-trace/src/config.js

* [MLOB-1540] add llmobs configuration to global tracer config (#4696) add llmobs config * [MLOB-1555] LLM Observability writers (#4699) LLM Observability writers * [MLOB-1556] LLM Observability tagger (#4718) LLM Observability tagger * [MLOB-1560] LLMObs Span Processor (#4738) * span processor * tests * remove agent exporter log and do not stringify tags * remove llmobs from exporter tests * add in default unserializable value * review comments * warning log for metric * todo-ify * remove some duplicate logic * decouple llmobs span processing with a channel * use a static weakmap to store llmobs tags/annotations instead of span tags * do not register span in map if it does not have an llmobs span kind * span is passed on an object from sp publisher * re-clarify TODOs * only send span in publish * log multiple warnings and return conditional undefined * update error logic * [MLOB-1561] LLM Observability SDK API (#4773) * wip * type definitions * active + try/catch eval metric writer append * test ts * use tagger map and processor as a channel subscriber * change decorate and add in dev changes * try some api changes * add decorate to noop * fix breaking proxy tests * experimental decorators for TS docs * api changes, fix unit + e2e tests * try removing global log mocks * add some util tests * remove logger mocks * add module tests + do not enable when not specified * fix eval metric integration test * wip * memoize getFunctionArguments * move any subscriber and global writer to the module enablement level instead of sdk * should fix TS tests * add ts integration test and fix decorator * devex for ts versions * add noop typescript test * remove startSpan * remove unneeded change * dedup decorator code * Update index.d.ts Co-authored-by: Yun Kim <35776586+Yun-Kim@users.noreply.github.com> * map metrics names * change validKind to validateKind and throw * tagger for metrics follow-up * review feedback * add some tests for not auto-annotating in certain cases --------- Co-authored-by: Yun Kim <35776586+Yun-Kim@users.noreply.github.com> * hard fail instead of soft fail, except for `wrap` span name * add ml-observability codeowners * resolve ts test * update auto-annotation check * tagger can soft fail * using custom ASL instance and scope activation * fix test comments and remove * address review comments * remove llmobs.apiKey config, only rely on global * fix evaulations test * make llmobs storage accessible --------- Co-authored-by: Yun Kim <35776586+Yun-Kim@users.noreply.github.com>

sabrenner added 2 commits September 17, 2024 15:04

config changes

4bc99e2

update tests

2a3a3d3

sabrenner marked this pull request as ready for review September 17, 2024 19:19

sabrenner requested a review from a team as a code owner September 17, 2024 19:19

Yun-Kim reviewed Sep 17, 2024

View reviewed changes

packages/dd-trace/test/config.spec.js Show resolved Hide resolved

Yun-Kim approved these changes Sep 17, 2024

View reviewed changes