feat(otlp-exporter): add timeout env var

[svetlanabrennan]

Signed-off-by: Svetlana Brennan svetlana.svn@gmail.com

Which problem is this PR solving?

Partially Fixes #2706 (issue)

This is just the first PR for issue #2706 that adds OTEL_EXPORTER_OTLP_TIMEOUT & OTEL_EXPORTER_OTLP_TRACES_TIMEOUT as an environment variable for the otlp trace exporters. I wanted to split this issue up in separate prs so it's easier to review and I need this timeout variable for another pr regarding retry logic I'm working on.

Short description of the changes

• Added OTEL_EXPORTER_OTLP_TIMEOUT as default environment variable
• Added OTEL_EXPORTER_OTLP_TRACES_TIMEOUT as default environment variable
• Added timeoutMillis property to the OTLPExporterBase class
• Added timeout logic to http request (sendWithHttp utility function)
• Added timeout logic to xhr request (sendWithXhr utility function)
• Added timeout logic to grpc request (send utility function)

Type of change

Please delete options that are not relevant.

• New feature (non-breaking change which adds functionality)
• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Unit tests
• Integration tests

Checklist:

• Followed the style guidelines of this project
• Unit tests have been added
• Documentation has been updated

[codecov]

Codecov Report

Merging #2738 (da4e4c8) into main (ac578e9) will decrease coverage by 0.27%.
The diff coverage is 40.00%.

❗ Current head da4e4c8 differs from pull request most recent head 6ee89b0. Consider uploading reports for the commit 6ee89b0 to get more accurate results

@@            Coverage Diff             @@
##             main    #2738      +/-   ##
==========================================
- Coverage   92.78%   92.51%   -0.28%     
==========================================
  Files         183      183              
  Lines        5921     5958      +37     
  Branches     1257     1266       +9     
==========================================
+ Hits         5494     5512      +18     
- Misses        427      446      +19     

Impacted Files	Coverage Δ
...kages/otlp-exporter-base/src/platform/node/util.ts	21.33% <0.00%> (-6.26%)	⬇️
...erimental/packages/otlp-exporter-base/src/types.ts	16.66% <ø> (ø)
...ntal/packages/otlp-grpc-exporter-base/src/types.ts	100.00% <ø> (ø)
...ental/packages/otlp-grpc-exporter-base/src/util.ts	67.18% <0.00%> (-1.07%)	⬇️
...ckages/opentelemetry-core/src/utils/environment.ts	96.00% <ø> (ø)
...perimental/packages/otlp-exporter-base/src/util.ts	89.65% <94.11%> (+6.32%)	⬆️
...ackages/otlp-exporter-base/src/OTLPExporterBase.ts	95.23% <100.00%> (+0.23%)	⬆️

[svetlanabrennan]

I haven't updated documentation yet. I would like some feedback on this pr before I update documentation please.

[svetlanabrennan]

Does OTEL_EXPORTER_OTLP_TRACES_TIMEOUT take precedence over OTEL_EXPORTER_OTLP_TIMEOUT?

[vmarchaud]

oes OTEL_EXPORTER_OTLP_TRACES_TIMEOUT take precedence over OTEL_EXPORTER_OTLP_TIMEOUT

Yes it should, signal specific configs take priority over generic ones

[svetlanabrennan]

Got it. I just implemented that logic for OTEL_EXPORTER_OTLP_TRACES_TIMEOUT to take precedence over OTEL_EXPORTER_OTLP_TIMEOUT and refactored some code.

[svetlanabrennan]

Added timeout config information to each otlp trace exporter readme.

This pr is ready for review/merge from my end.

[svetlanabrennan]

Lint test is passing now. The codecov tests are failing but they were passing previously. The codecov path test is saying that the sendWithHttp function isn't being test but it is being tested - the tests are just located in another package.

Should I move these tests into the otlp-exporter-base package?

[svetlanabrennan]

Tests failing after main merge. I'm seeing this test failing in the 'main' branch as well (when I run the tests locally).

[Flarna]

@dyladan moved the latest label of @opentelemetry/api from verion 1.04 to 1.1.0. This could be the cause here in case several API versions are installed.

[Flarna]

local tests on main are green for me. Seems like CI specific failures. Maybe some caching?

[svetlanabrennan]

It must have been the cache. The local tests are passing now both in main and in this pr branch.

[svetlanabrennan]

@dyladan moved the latest label of @opentelemetry/api from verion 1.04 to 1.1.0. This could be the cause here in case several API versions are installed.

Was this a codecov config change? I assume so because these tests are all passing when I run it locally.

[dyladan]

Codecov would not affect the tests anyway but this is probably because the 1.1 api is now latest. There is most likely a version mismatch somewhere. I'm on my phone and ooo right now but may be able to look later if I have time

[svetlanabrennan]

Looks like 1 browser test is failing after merging main into this branch. Not sure why. All tests passing when I run it locally.

[Flarna]

re-triggered the test and it's green now. Seems to be a test issue

[svetlanabrennan]

I think there's also a test issue with the codecov for "codecov/patch" because it's indicating that some lines are not covered by tests but they are tested.

For example, it says line 54 isn't tested in this file but there is a test for it here.

[legendecas]

LGTM % nits

[dyladan]

LGTM % legendecas' nit

[svetlanabrennan]

One test failing in an unrelated package (didn't work on that package in this pr).

Could this be a test issue again like @Flarna mentioned earlier for another time an unrelated test was failing?

[dyladan]

Failure seems to be in the OTLPTraceExporter which is touched by this PR

[svetlanabrennan]

Failure seems to be in the OTLPTraceExporter which is touched by this PR

The real http request tests were failing randomly. I think it was a timing issue. So I moved those tests to their own test suite and it's passing now. Also ran it locally a handful of times and it's all green as well.

[dyladan]

Overall LGTM was just a bit surprised to see the behavior split by major node version

[dyladan]

👍