XTNSNS-1082 Update metrics instrumentation #596
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
Enables this client to support logs, metrics, and tracing signals from the diagnostics-nodejs library, making them available already initialized. Additionally, this change enables registration of built-in and community instrumentation.
Remove unused parameters and use logClient already initialized
Refactor client types to use Types.LogClient for consistency
wisneycardeal
changed the title
daniyelnnr
force-pushed
the
update/metrics
branch
from
3eae263 to
d7dd42c
Compare
Improve telemetry client initialization using Promise.all to optimize asynchronous calls
Adds OpenTelemetry dependencies for host metrics and Koa instrumentation
Updates startApp function to initialize telemetry beforehand and uses dynamic imports for startMaster and startWorker. This ensures that telemetry clients and libraries are proper initialized so they can use hooks with application libraries that will be loaded later
Add getMetricClient function to make the client available and creates the asynchronous initialization function to retrieve it
This commit creates a middleware for request metrics using OpenTelemetry instruments. This change is inspired by `requestMetricsMiddleware.ts` and follows the same logic, only changing the way it is instrumented to use OTel standard
Add the use of OpenTelemetry metrics middleware for request monitoring
Add Koa instrumentation to the list of instruments that will be registered and used by the telemetry client. This enables automatic instrumentation for the Koa module, as well as automatic collection and export of telemetry data.
This commit creates a wrapper for the host-metrics module, which provides automatic collection for system metrics - such as CPU, memory, and network
daniyelnnr
force-pushed
the
update/metrics
branch
from
d7dd42c to
5b5146d
Compare
|
Also, after finished, it would be awesome if you could add tests here. |
filafb
requested changes
Aug 14, 2025
There was a problem hiding this comment.
Nice work and way easier to review with the commits organized like that. Thank you for that.
The thing that called most my attention and I think it would be nice a second thought is the variables in the global context. It might lead to some weird bugs hard to get.
| return async function addOtelRequestMetrics(ctx: ServiceContext, next: () => Promise<void>) { | ||
| if (!instruments) { | ||
| try { | ||
| instruments = await Promise.race([ |
There was a problem hiding this comment.
Interesting use of Promise.race. I like it!
Refactors the instrument initialization logic to improve readability and code structure
Refactor MetricClient to use Singleton pattern for improved client management
Refactor OTel instruments initialization to use singleton pattern
@juliobguedes regarding this and exposing what we have previously aligned, I will add the tests for this change in another PR along with some smaller configuration changes that I will still need to apply. |
4 tasks
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.
What is the purpose of this pull request?
This pull request introduces OpenTelemetry-based logging and metrics instrumentation to the VTEX I/O API client, providing improved observability and standardizing telemetry collection. Key changes include the addition of OpenTelemetry dependencies, refactoring logger and metrics clients to use a centralized telemetry initializer, and the introduction of new middleware for request metrics. The telemetry initialization now registers instrumentations for Koa and host metrics, and the worker process is updated to include these new middlewares.
Telemetry and Instrumentation Integration
@opentelemetry/api,@opentelemetry/host-metrics,@opentelemetry/instrumentation,@opentelemetry/instrumentation-koa) and updated the diagnostics-nodejs package version inpackage.jsonto support new telemetry features.initializeTelemetry) insrc/service/telemetry/client.ts, which creates and registers logs, metrics, and traces clients, and sets up Koa and host metrics instrumentations. [1] [2] [3]Logger and Metrics Refactoring
src/service/logger/client.ts,src/service/logger/logger.ts,src/service/metrics/client.ts) [1] [2] [3] [4] [5] [6]src/service/metrics/instruments/hostMetrics.ts,src/service/metrics/metrics.ts) [1] [2]Middleware Enhancements
addOtelRequestMetricsMiddleware) for collecting detailed HTTP request metrics using OpenTelemetry, and integrated it into the worker process alongside context propagation middleware. (src/service/metrics/otelRequestMetricsMiddleware.ts,src/service/worker/index.ts) [1] [2] [3] [4]Service Initialization
src/service/index.ts)What problem is this solving?
This implementation of node-vtex-api is not using the newest version of diagnostics-nodejs, which is VTEX's standard library for observability. This PR provides consistency in telemetry generation and allows it to adopt OTel protocol for metrics.
How should this be manually tested?
Screenshots or example usage
Types of changes