opentelemetry-js
opentelemetry-js copied to clipboard
Perf: avoid internal object format transformations during export
Background
Our current internal format for exportable telemetry like spans and metrics (and maybe events) does not match the format expected by the protobuf
serialization library we are using. In order to serialize protobuf, this means we have to create new objects with new property names, recursively, for every exported object.
We cannot change the internal representation, because it would be a breaking change for exporter interfaces. Specifically, the SpanProcessor
, MetricReader
, and Exporter
interfaces expect our existing internal formats.
The problem
The overhead for this is quite substantial in a few different ways:
- The CPU cost of iterating through every property of every object recursively
- The memory cost of creating every object twice (one internal representation and one protobuf representation)
- The bundle size cost of including the transformation library, which must contain the full name of every property in both representations
- The GC cost of reclaiming the memory for every object in multiple representations
Potential Solutions
- Use getters to alias the protobuf names to our internal names. This avoids excess object allocations and cpu iterations at the cost of bundle sizes.
- Write a custom protobuf serializer. This would avoid all of the above costs at the expense of developer time and resources. It is likely the best technical choice, but we may not have the resources to take on such a task and guarantee it is updated as OTLP continues to add features.
This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.
This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.