feat(internal): Add VECTOR_HOSTNAME env variable #21789
Merged
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
By default, Vector uses the hostname returned by the gethostname. However, in cases when Vector is running in containers, it is meaningless because hostname is always the name of the container, e.g., the name of a pod in Kubernetes cluster.
This commit adds the way to override a hostname by using the env variable. In Kubernetes it can be used like this to see the name of a node where the Vector process is running (which is more meaningful).
```
env:
- name: VECTOR_HOSTNAME
valueFrom:
fieldRef:
fieldPath: spec.nodeName
```
Signed-off-by: maksim.nabokikh <[email protected]>
pront
reviewed
Nov 14, 2024
There was a problem hiding this comment.
Hi @nabokihms, thank you for this enhancement. Please also document this new env var in website/cue/reference/cli.cue.
(Tangential to this PR: #21794)
github-actions
bot
added
the
domain: external docs
nabokihms
force-pushed
the
vector-hostname-env-variable
branch
from
353fa41 to
270821a
Compare
Signed-off-by: maksim.nabokikh <[email protected]>
nabokihms
force-pushed
the
vector-hostname-env-variable
branch
from
270821a to
98b1f3b
Compare
urseberry
approved these changes
Nov 15, 2024
changelog.d/21789_add_vector_hostname_env_variable.enhancement.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Ursula Chen <[email protected]>
jszwedko
reviewed
Nov 18, 2024
- Fix cue formatting - Use the variable value if set but empty Signed-off-by: maksim.nabokikh <[email protected]>
jszwedko
reviewed
Nov 18, 2024
There was a problem hiding this comment.
Looks good to me! I'll let @pront approve too since he was looking at it before.
I think we could (potentially) add this as a global option in the config file too (hostname: foo) but only if the hostname isn't fetched before global configuration is loaded.
pront
approved these changes
Nov 19, 2024
Would be a nice follow-up to this. |
jszwedko
approved these changes
Nov 21, 2024
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.
Summary
By default, Vector uses the hostname returned by the gethostname. However, in cases when Vector is running in containers, it is meaningless because hostname is always the name of the container, e.g., the name of a pod in Kubernetes cluster.
This commit adds the way to override a hostname by using the env variable. In Kubernetes it can be used like this to see the name of a node where the Vector process is running (which is more meaningful).
Change Type
Is this a breaking change?
How did you test this PR?
Tested manually in the kubernetes cluster.
Does this PR include user facing changes?
Checklist
Cargo.lock), pleaserun
dd-rust-license-tool writeto regenerate the license inventory and commit the changes (if any). More details here.References
Closes #20481