feat(NODE-5967): container and Kubernetes awareness in client metadata #4011
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.
Note: This PR's description and changes are almost identical to the one on the 6.x branch (NODE-5968).
Description
Track user usage of containers on 5.x branch.
What is changing?
When kubernetes is in
process.env
, we add a{orchestrator: 'kubernetes'}
field to theclient.env
field of the handshake document (if this does not make the document exceed 512 bytes).When '/.dockerenv' exists, we add a
{runtime: 'docker'}
field to theclient.env
field of the handshake document (if this does not make the document exceed 512 bytes).Note: We do not unit test docker, but I tested our logic for detecting docker on an EVG Host, ran Docker and detection succeeds for both root and non-root user cases.
Is there new documentation needed for these changes?
No, non-user facing change.
What is the motivation for this change?
Product wants to track user usage of docker and kubernetes.
Release Highlight
Container and Kubernetes Awareness
The Node.js driver now keeps track of container metadata in the
client.env.container
field of the handshake document.If space allows, the following metadata will be included in
client.env.container
:Note: If neither Kubernetes nor Docker is present,
client.env
will not have thecontainer
property.Double check the following
npm run check:lint
scripttype(NODE-xxxx)[!]: description
feat(NODE-1234)!: rewriting everything in coffeescript