feat: Add braintrust/apply-instrumentation entrypoint for CJS/TS patching#2038
Open
Luca Forstner (lforst) wants to merge 4 commits into
Open
feat: Add braintrust/apply-instrumentation entrypoint for CJS/TS patching#2038Luca Forstner (lforst) wants to merge 4 commits into
braintrust/apply-instrumentation entrypoint for CJS/TS patching#2038Luca Forstner (lforst) wants to merge 4 commits into
Conversation
Luca Forstner (lforst)
requested review from
Abhijeet Prasad (AbhiPrasad) and
Stephen Belanger (Qard)
…ntation # Conflicts: # js/src/auto-instrumentations/configs/all.ts # js/src/instrumentation/braintrust-plugin.ts # js/src/instrumentation/registry.ts
| "braintrust": minor | ||
| --- | ||
|
|
||
| feat: Add `braintrust/apply-instrumentation` entrypoint for CJS/TS patching |
There was a problem hiding this comment.
should we call it braintrust/apply-auto-instrumentation instead?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We have the problem that we don't have a good setup story around frameworks like Nestjs that are CJS but don't give you a clean way of passing the
--importhook. For this I thought we could expose something likeimport 'braintrust/apply-instrumentation'which is simply an import with a side effect that applies runtime patching. It's also good for platforms like Vercel where passing the--importargument is super painful in general.This will now be usable with
require('braintrust/apply-instrumentation')for all subsequentrequiresimport 'braintrust/apply-instrumentation'for all subsequent dynamic imports (import('foobar').then(() => console.log('foobar is instrumented')))initLoggercan be called whenever.Currently we only expose this for Nodejs - I haven't looked into how to make this work for other frameworks. I generally like the ergonomics of this and it is an additional tool in our toolbox of doing instrumentation.