Skip to content
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

chore: reviewing TODO comments #129

Merged
merged 1 commit into from
Apr 10, 2024
Merged

chore: reviewing TODO comments #129

merged 1 commit into from
Apr 10, 2024

Conversation

trentm
Copy link
Member

@trentm trentm commented Apr 9, 2024

No description provided.

@trentm trentm requested a review from david-luna April 9, 2024 23:48
@trentm trentm self-assigned this Apr 9, 2024
Copy link
Member Author

@trentm trentm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I skipped over the TODOs in sdk.js regarding metrics and in host-metrics-related files, because you were working on those, David.

Of the remaining TODOs, I don't think any are critical for an alpha release.

@@ -49,7 +49,6 @@ class ElasticNodeSDK extends NodeSDK {

// Setup & fix some env
setupEnvironment();
// TODO detect service name
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per https://github.com/open-telemetry/semantic-conventions/blob/main/docs/attributes-registry/service.md

If the value was not specified, SDKs MUST fallback to unknown_service: concatenated with process.executable.name, e.g. unknown_service:bash. If process.executable.name is not available, the value MUST be set to unknown_service.

NodeSDK is already handling those MUST requirements. I'd hesitate to diverge from that by looking around in nearby package.json files. We could later add a feature request issue for this if someone wants/needs it.

@@ -62,7 +61,6 @@ class ElasticNodeSDK extends NodeSDK {
processDetectorSync,
// hostDetectorSync is not currently in the OTel default, but may be added
hostDetectorSync,
// TODO cloud/container detectors by default
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

opened #128 for this

// definitely *can* change program behaviour. Let's reconsider.
// Note: See https://github.com/open-telemetry/opentelemetry-js/issues/1521
// for some thoughts on automatic handling to shutdown the SDK.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved all this to #127

@@ -40,8 +40,6 @@ const testFixtures = [
recs = stdout.trim().split(/\n/g).map(JSON.parse);
},
checkTelemetry: (t, col) => {
// We expect telemetry like this:
// TODO: waiting for log sending from https://github.com/open-telemetry/opentelemetry-js-contrib/pull/1837 to be in an otel-js-contrib release
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already have this. Forgot to remove this TODO comment in the last update to this test file.

@@ -361,7 +358,6 @@ class TestCollector {
});
});

// TODO: sorting required? Or is incoming order sufficient? s/logs/sortedLogs/ if actively sorting.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The TODOs removed here didn't add any value. If we need sorting of metrics and logs on the TestCollector, we'll come here to add it.

@trentm trentm linked an issue Apr 10, 2024 that may be closed by this pull request
@trentm trentm merged commit 352366d into main Apr 10, 2024
12 checks passed
@trentm trentm deleted the trentm/TODO-comment-review branch April 10, 2024 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

transfer all TODO comments that should be done for alpha to issues
2 participants