Skip to content

Commit ed547ca

Browse files
committed
update comment to reflect the new plan
1 parent beb0432 commit ed547ca

1 file changed

Lines changed: 18 additions & 12 deletions

File tree

  • packages/datadog-instrumentations/src/helpers/rewriter

packages/datadog-instrumentations/src/helpers/rewriter/index.js

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,26 @@
11
'use strict'
22

33
/*
4-
This rewriter is basically a JavaScript version of Orchestrion. The goal is not
5-
to replace Orchestrion, but rather to make it easier and faster to write new
6-
integrations in the short-term, especially as many changes to the rewriter will
7-
be needed as all the patterns we need have not been identified yet. This will
8-
avoid the back and forth of having to make Rust changes to an external library
9-
for basically every integration change or addition.
10-
11-
The long term goal is to backport any additional feature we add to the JS
12-
rewriter to Orchestrion once we're confident that the implementation is fairly
13-
complete and has all features we need. This should ideally happen by summer
14-
2026, but it will depend on how quickly we start using the rewriter more.
4+
This rewriter is basically a JavaScript version of Orchestrion-JS. The goal is
5+
not to replace Orchestrion-JS, but rather to make it easier and faster to write
6+
new integrations in the short-term, especially as many changes to the rewriter
7+
will be needed as all the patterns we need have not been identified yet. This
8+
will avoid the back and forth of having to make Rust changes to an external
9+
library for every integration change or addition that requires something new.
10+
11+
In the meantime, we'll work concurrently on a change to Orchestrion-JS that
12+
adds an "arbitrary transform" or "plugin" system that can be used from
13+
JavaScript, in order to enable quick iteration while still using Orchestrion-JS.
14+
Once that's done we'll use that, so that we can remove this JS approach and
15+
return to using Orchestrion-JS.
16+
17+
The long term goal is to backport any additional features we add to the JS
18+
rewriter (or using the plugin system in Orchestrion-JS once we're using that)
19+
to Orchestrion-JS once we're confident that the implementation is fairly
20+
complete and has all features we need.
1521
1622
Here is a list of the additions and changes in this rewriter compared to
17-
Orchestrion that will need to be backported:
23+
Orchestrion-JS that will need to be backported:
1824
1925
(NOTE: Please keep this list up-to-date whenever new features are added)
2026

0 commit comments

Comments
 (0)