feat(otel): initialize OpenTelemetry package with tracer provider and span exporter #188
Conversation
JakeChampion
commented
May 12, 2025
JakeChampion
commented
- Added package.json for @netlify/otel with necessary dependencies and scripts.
- Implemented createTracerProvider function to set up tracing within bootstrap
- Created NetlifySpanExporter class for exporting spans the spans to the console
- Defined constants for tracer retrieval and shutdown outside the bootstrap
- exports getTracer and shutdownTracers functions for use inside other packages
- Wrote tests for getTracer and shutdownTracers functionalities.
… span exporter - Added package.json for @netlify/otel with necessary dependencies and scripts. - Implemented createTracerProvider function to set up tracing within bootstrap - Created NetlifySpanExporter class for exporting spans the spans to the console - Defined constants for tracer retrieval and shutdown outside the bootstrap - exports getTracer and shutdownTracers functions for use inside other packages - Wrote tests for getTracer and shutdownTracers functionalities.
packages/otel/src/bootstrap/main.ts
Outdated
| configurable: true, | ||
| writable: false, | ||
| value: async () => { | ||
| return await nodeTracerProvider.shutdown() |
There was a problem hiding this comment.
This will be used to shutdown the open telemetry provider at the end of an invocation, thereby ensuring the lambda instance can be used again in the future without retaining any tracing information from the previous invocation -- this enables us to activate tracing for a single request and not all future requests to the same lambda instance
packages/otel/src/constants.ts
Outdated
| @@ -0,0 +1,2 @@ | |||
| export const GET_TRACER = Symbol('getTracer') | |||
There was a problem hiding this comment.
Do we not need Symbol.for here? If I understand correctly, we'll have two instances of @netlify/otel: one inline into serverless-functions-api and the other one loaded as a dependency from user code. I think Symbol("getTracer") will map to two different symbols, whereas Symbol.for("getTracer") would point to the same one?
There was a problem hiding this comment.
Yes that's true, perhaps we should just use a string instead of adding to the global symbol registry
packages/otel/src/main.ts
Outdated
| import { GET_TRACER, SHUTDOWN_TRACERS } from './constants.js'; | ||
|
|
||
| export const getTracer = async (name?: string, version?: string): Promise<SugaredTracer | undefined> => { | ||
| // @ts-ignore |
There was a problem hiding this comment.
To avoid using @ts-ignore, in other places I did this:
There was a problem hiding this comment.
Nice, updated to use similar approach
packages/otel/src/bootstrap/main.ts
Outdated
| siteId: string, | ||
| siteName: string, | ||
| }) => { | ||
| if (options.headers.has('x-nf-enable-tracing')) { |
There was a problem hiding this comment.
nit: I would flip this and early-return here, to avoid having everything nested under this statement.
| return | ||
| } | ||
|
|
||
| console.log('__nfOTLPTrace', NetlifySpanExporter.#decoder.decode(JsonTraceSerializer.serializeRequest(spans))) |
There was a problem hiding this comment.
nit: We could move __nfOTLPTrace to the constants file.
packages/otel/src/main.ts
Outdated
| } | ||
|
|
||
| export const shutdownTracers = async (): Promise<void> => { | ||
| // @ts-ignore |
