runtimes/js: add support for custom metrics #2128
Open
Conversation
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
|
All committers have signed the CLA. |
fredr
force-pushed
the
fredr/ts-custom-metrics
branch
from
f68e437 to
72f6462
Compare
fredr
force-pushed
the
fredr/ts-custom-metrics
branch
from
72f6462 to
1efb0bd
Compare
eandre
reviewed
Nov 20, 2025
| const metricsBuffer = __internalInitGlobalMetricsBuffer(); | ||
| const extraWorkers = runtime.RT.numWorkerThreads() - 1; | ||
| if (extraWorkers > 0) { | ||
| log.debug(`Starting ${extraWorkers} worker threads`); |
Comment on lines
+24
to
+26
| * export const OrdersProcessed = new CounterGroup<Labels>("orders_processed"); | ||
| * | ||
| * OrdersProcessed.with({ success: true }).increment(); |
Member
There was a problem hiding this comment.
Suggested change
| * export const OrdersProcessed = new CounterGroup<Labels>("orders_processed"); | |
| * | |
| * OrdersProcessed.with({ success: true }).increment(); | |
| * export const ordersProcessed = new CounterGroup<Labels>("orders_processed"); | |
| * | |
| * ordersProcessed.with({ success: true }).increment(); |
Comment on lines
+11
to
+13
| * export const OrdersProcessed = new Counter("orders_processed"); | ||
| * | ||
| * OrdersProcessed.increment(); |
Member
There was a problem hiding this comment.
Suggested change
| * export const OrdersProcessed = new Counter("orders_processed"); | |
| * | |
| * OrdersProcessed.increment(); | |
| * export const ordersProcessed = new Counter("orders_processed"); | |
| * | |
| * ordersProcessed.increment(); |
| * Called during encores initialization | ||
| * @internal | ||
| */ | ||
| export function __internalSetGlobalMetricsBuffer( |
Member
There was a problem hiding this comment.
Do we need to export this here? Could we put it in an internal/ folder?
| * | ||
| * Note: Number values in labels are converted to integers using Math.floor(). | ||
| */ | ||
| with(labels: L): AtomicCounter | NoOpCounter { |
Member
There was a problem hiding this comment.
Do we need this return type? Or could we always return a Counter so the user doesn't need to care about the difference? For other resources we've separated the underlying implementation into an impl field so we could do like:
const impl = new NoOpCounterImpl();
return new Counter(impl);or something like that. Maybe a bit tricky to do since it would require a private constructor?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds support for creating custom metrics in typescript apps. Depends on #2109
Inspired by the implementation in the go runtime.
Metrics needs to be defined within a service, and will automatically add the service label.
This implementation is backed by a SharedArrayBuffer, where each u64 slot is a metric value, created from js by the main thread. From js we do atomic operation to update values on this buffer, and from rust we do atomic load when collecting the metrics. The rust runtime is use to coordinate what slot should be used for a label set, so that we can support multiple workers updating the same metric.