fix(exporter-*-otlp-grpc)!: lazy load gRPC #4432
Merged
Conversation
This file contains 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
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #4432 +/- ##
==========================================
- Coverage 92.39% 92.32% -0.07%
==========================================
Files 330 327 -3
Lines 9531 9462 -69
Branches 2036 2024 -12
==========================================
- Hits 8806 8736 -70
- Misses 725 726 +1
|
pichlermarc
added
priority:p1
This was referenced Feb 13, 2024
dyladan
approved these changes
Feb 14, 2024
Comment on lines
-66
to
-72
| getServiceClientType() { | ||
| return ServiceClientType.LOGS; | ||
| } | ||
|
|
||
| getServiceProtoPath(): string { | ||
| return 'opentelemetry/proto/collector/logs/v1/logs_service.proto'; | ||
| } |
Comment on lines
-66
to
-72
| getServiceClientType() { | ||
| return ServiceClientType.SPANS; | ||
| } | ||
|
|
||
| getServiceProtoPath(): string { | ||
| return 'opentelemetry/proto/collector/trace/v1/trace_service.proto'; | ||
| } |
Comment on lines
-61
to
-66
| getServiceProtoPath(): string { | ||
| return 'opentelemetry/proto/collector/metrics/v1/metrics_service.proto'; | ||
| } | ||
|
|
||
| getServiceClientType(): ServiceClientType { | ||
| return ServiceClientType.METRICS; |
experimental/packages/otlp-grpc-exporter-base/src/grpc-exporter-transport.ts
Show resolved
Hide resolved
experimental/packages/otlp-grpc-exporter-base/src/grpc-exporter-transport.ts
Show resolved
Hide resolved
david-luna
reviewed
Feb 15, 2024
experimental/packages/otlp-grpc-exporter-base/src/OTLPGRPCExporterNodeBase.ts
Show resolved
Hide resolved
experimental/packages/otlp-grpc-exporter-base/src/export-response.ts
Outdated
Show resolved
Hide resolved
experimental/packages/otlp-grpc-exporter-base/src/grpc-exporter-transport.ts
Show resolved
Hide resolved
experimental/packages/otlp-grpc-exporter-base/src/grpc-exporter-transport.ts
Show resolved
Hide resolved
experimental/packages/otlp-grpc-exporter-base/src/create-service-client-constructor.ts
Show resolved
Hide resolved
david-luna
approved these changes
Feb 21, 2024
pichlermarc
force-pushed
the
fix/grpc-lazy-load
branch
from
ad22981
to
02f703c
Compare
3 tasks
This was referenced May 28, 2024
Open
3 tasks
Zirak
pushed a commit
to Zirak/opentelemetry-js
that referenced
this pull request
Sep 14, 2024
* fix(exporter-*-otlp-grpc)!: lazy load gRPC
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.
Which problem is this PR solving?
We've had problems in the past with the gRPC exporters, as they do not lazy-require the
@grpc/grpc-jslibrary. This causes problems with@opentelemetry/instrumentation-grpcand@opentelemetry/instrumentation-http. This PR addresses this by re-structuring internals in a way that@grpc/grpc-jsis only required on the first export.Fixes #4151
Fixes #4266 (now loads gRPC on export, instead of the next tick, which means this should not happen anymore IF the SDK/exporter is shut down properly before the test environment is torn down).
Type of change
Breaking changes
Removes
getServiceClientType()This affects
@opentelemetry/exporter-trace-otlp-grpc@opentelemetry/exporter-logs-otlp-grpc@opentelemetry/otlp-grpc-exporter-base(intended for internal use only)It was previously possible to get the service client type (Traces, Metrics, Logs) from the exporter - this is now not possible anymore. This was used internally to construct a service client. Due to the restructuring of the internals in this PR, this is now not needed anymore.
Possible impact: low this returned a static string that did not change per-exporter.
Removes
getServiceProtoPath()This affects
@opentelemetry/exporter-trace-otlp-grpc@opentelemetry/exporter-logs-otlp-grpc@opentelemetry/otlp-grpc-exporter-base(intended for internal use only)It was previously possible to get the service proto path used by exporter - this is now not possible anymore. This was used internally to construct a service client. Due to the restructuring of the internals in this PR, this is now not needed anymore.
Possible impact: low this returned a static string that did not change per-exporter.
Removes
metadataproperty, this affects@opentelemetry/exporter-trace-otlp-grpc@opentelemetry/exporter-logs-otlp-grpc@opentelemetry/otlp-grpc-exporter-base(intended for internal use only)It was previously possible to edit metadata while the exporter is running. This is likely not an intended feature as the property was only read in the internal export code and tests, but only written by the exporters themselves.
Possible impact: medium users could have used the
metadataproperty to dynamically modify metadata while the export is running.Removes
serviceClientproperty, this affects@opentelemetry/exporter-trace-otlp-grpc@opentelemetry/exporter-logs-otlp-grpc@opentelemetry/otlp-grpc-exporter-base(intended for internal use only)This was likely also intended for internal use but unintentionally exposed to users. It allowed full access to the internally used grpc service client.
Possible impact: unknown users could have used the service client directly to modify export behavior.
Removes
compressionproperty, this affects@opentelemetry/exporter-trace-otlp-grpc@opentelemetry/exporter-logs-otlp-grpc@opentelemetry/otlp-grpc-exporter-base(intended for internal use only)This was likely also intended for internal use but unintentionally exposed to users. It allowed reading the compression property. It was read when a new service client was created, but changes to it would not affect the export.
Possible impact: low, if needed it can be read from the config that's passed to the constructor
How Has This Been Tested?