-
Notifications
You must be signed in to change notification settings - Fork 530
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(detector-alibaba): suppres internal tracing #2429
Merged
legendecas
merged 4 commits into
open-telemetry:main
from
david-luna:dluna/2320-alibaba-detector-suppress-tracing
Sep 12, 2024
+68
−2
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
0d6824f
fix(detector-alibaba): suppres internal tracing
david-luna 1625f85
chore(detector-alibaba): fix lint issues
david-luna 27d2aee
chore(detector-alibaba): revove unnecessary code
david-luna 588237c
Merge branch 'main' into dluna/2320-alibaba-detector-suppress-tracing
david-luna File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
61 changes: 61 additions & 0 deletions
61
...resource-detector-alibaba-cloud/test/detectors/AlibabaCloudEcsDetectorIntegration.test.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
/* | ||
* Copyright The OpenTelemetry Authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import * as assert from 'assert'; | ||
|
||
import { HttpInstrumentation } from '@opentelemetry/instrumentation-http'; | ||
import { | ||
InMemorySpanExporter, | ||
SimpleSpanProcessor, | ||
} from '@opentelemetry/sdk-trace-base'; | ||
import { NodeSDK } from '@opentelemetry/sdk-node'; | ||
import { IResource } from '@opentelemetry/resources'; | ||
|
||
describe('[Integration] AlibabaCloudEcsDetector', () => { | ||
it('should not start spans for detector requests', async () => { | ||
const memoryExporter = new InMemorySpanExporter(); | ||
const sdk = new NodeSDK({ | ||
instrumentations: [new HttpInstrumentation()], | ||
spanProcessors: [new SimpleSpanProcessor(memoryExporter)], | ||
}); | ||
|
||
sdk.start(); | ||
|
||
// NOTE: detectors implementing the `DetectorSync` interface and starting | ||
// HTTP requests within the `detect` method will produce Noop Spans since | ||
// the SDK resolves the trace provider after resource detectors are triggered. | ||
// Ref: https://github.com/open-telemetry/opentelemetry-js/blob/38f6689480d28dcbdafcb7b5ba4b14025328ffda/experimental/packages/opentelemetry-sdk-node/src/sdk.ts#L210-L240 | ||
// | ||
// So having the detector in the config would result in no spans for Alibaba requests | ||
// being exported which is what we want. Although we may think we're safe of sending | ||
// internal tracing any change that delays these request will result in internal | ||
// tracing being exported. We do the detection outside the SDK constructor to have such | ||
// scenario. | ||
const { | ||
alibabaCloudEcsDetector, | ||
} = require('../../build/src/detectors/AlibabaCloudEcsDetector'); | ||
const resource = alibabaCloudEcsDetector.detect() as IResource; | ||
await resource.waitForAsyncAttributes?.(); | ||
|
||
// Wait for the next loop to let the span close properly | ||
await new Promise(r => setTimeout(r, 0)); | ||
const spans = memoryExporter.getFinishedSpans(); | ||
|
||
assert.equal(spans.length, 0, 'no spans exported for GcpDetector'); | ||
|
||
await sdk.shutdown(); | ||
}); | ||
}); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note for reviewer:
DetectorSync
interface appeared inv1.10.0
. this is a leftover from #2328