feat(detector-aws): add DetectorSync implementation for EC2 detector #2332
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
…ce for EC2 detector
david-luna
commented
Jul 12, 2024
| @@ -235,7 +235,11 @@ function getDisabledInstrumentationsFromEnv() { | |||
| export function getResourceDetectorsFromEnv(): Array<Detector | DetectorSync> { | |||
| const resourceDetectors = new Map< | |||
| string, | |||
| Detector | DetectorSync | Detector[] | DetectorSync[] | |||
| | Detector | |||
There was a problem hiding this comment.
note for reviewer: this is necessary to allow this single refactor instead of doing all AWS detector at once.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2332 +/- ##
==========================================
- Coverage 90.97% 90.41% -0.56%
==========================================
Files 146 150 +4
Lines 7492 7368 -124
Branches 1502 1527 +25
==========================================
- Hits 6816 6662 -154
- Misses 676 706 +30
|
david-luna
changed the title
david-luna
commented
Aug 1, 2024
| @@ -14,7 +14,8 @@ | |||
| * limitations under the License. | |||
| */ | |||
|
|
|||
| export * from './AwsEc2Detector'; | |||
| export { awsEc2Detector } from './AwsEc2Detector'; | |||
There was a problem hiding this comment.
note for reviewer: small step forward for open-telemetry/opentelemetry-js#4186
david-luna
commented
Aug 1, 2024
| const AWS_HOST_PATH = awsEc2Detector.AWS_INSTANCE_HOST_DOCUMENT_PATH; | ||
| const AWS_METADATA_TTL_HEADER = awsEc2Detector.AWS_METADATA_TTL_HEADER; | ||
| const AWS_METADATA_TOKEN_HEADER = awsEc2Detector.AWS_METADATA_TOKEN_HEADER; | ||
| const AWS_HOST = 'http://' + awsEc2DetectorSync.AWS_IDMS_ENDPOINT; |
There was a problem hiding this comment.
note for reviewer: the awsEc2Detector becomes a mere wrapper of awsEc2DetectorSync, we need to import the later to set these values.
|
closed in favour of #2376 following this suggestion |
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.
Context
Another PR moving away from the deprecated
Detectorinterface in favour to theDetectorSyncinterface. This time is for AWS EC2 detector and it might help a bit in open-telemetry/opentelemetry-js#3582Not doing all detectors at once:
Short description of the changes
AwsEc2DetectorSyncclass and instanceAwsEc2Detectorreuse the new sync instanceNote: since this package is marked as stable (major version is 1) we are doing a non breaking change by adding the new class and mark the current as
deprecated. The async detector changes behavior, it does not throw anymore, and it was discussed in last SIG meeting (2024-07-31). The outcome was we're okay with that.A couple of PRs will follow: