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.

Sign up for GitHub

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

Jump to bottom

docs: clarify environment variable and system service relationship for config #19352

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
+16 −0
Open

docs: clarify environment variable and system service relationship for config #19352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9dc517c
docs: clarify environment variable and system service relationship fo…
DavSanchez Nov 21, 2024
a18deb6
style: wording
DavSanchez Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions ...structure/infrastructure-agent/configuration/configure-infrastructure-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,12 @@ Here are detailed descriptions of each configuration method:
```yml
license_key: {{MY_LICENSE_KEY}}
```
<Callout variant="important">
Often the infrastructure agent will be running as a system service in the host, managed globally (e.g. `systemd` for Linux, Windows Services, `launchd` for macOS, etc).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: Often the infrastructure agent runs as a system service in the host, managed globally (e.g. systemd for Linux, Windows Services, launchd for macOS, etc).

To apply configuration changes with environment variables in this setup, these environment variables will need to be set and made visible to the isolated context where the infrastructure agent service is running.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: To apply configuration changes with environment variables in this setup, these environment variables need to be set and made visible to the isolated context where the infrastructure agent service is running.

The way of doing this is platform-dependent, check the documentation for your platform to add environment variables to system services.
Copy link
Contributor

Choose a reason for hiding this comment

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

Which documentation are you referring to? if there is another document I would suggest you to please add the link here.

</Callout>
</Collapser>

<Collapser
Expand Down
10 changes: 10 additions & 0 deletions ...rastructure-agent/configuration/infrastructure-agent-configuration-settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@

For an example of how all these variables can be used, see our [sample configuration template in GitHub](https://github.com/newrelic/infrastructure-agent/blob/master/assets/examples/infrastructure/newrelic-infra-template.yml.example).

## Environment variables

Many of the configuration options listed also admit using environment variables to set values, which will take precendence over the YAML configuration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: Please remove "Will"


<Callout variant="important">
Often the infrastructure agent will be running as a system service in the host, managed globally (e.g. `systemd` for Linux, Windows Services, `launchd` for macOS, etc). To apply configuration changes with environment variables in this setup,

Check failure on line 45 in src/content/docs/infrastructure/infrastructure-agent/configuration/infrastructure-agent-configuration-settings.mdx

View workflow job for this annotation

GitHub Actions / vale-linter 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.", "location": {"path": "src/content/docs/infrastructure/infrastructure-agent/configuration/infrastructure-agent-configuration-settings.mdx", "range": {"start": {"line": 45, "column": 101}}}, "severity": "ERROR"}

Check warning on line 45 in src/content/docs/infrastructure/infrastructure-agent/configuration/infrastructure-agent-configuration-settings.mdx

View workflow job for this annotation

GitHub Actions / vale-linter 

[vale] reported by reviewdog 🐶
[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).

Raw Output:
{"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "src/content/docs/infrastructure/infrastructure-agent/configuration/infrastructure-agent-configuration-settings.mdx", "range": {"start": {"line": 45, "column": 172}}}, "severity": "INFO"}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: Often the infrastructure agent runs as a system service in the host

these environment variables will need to be set and made visible to the isolated context where the infrastructure agent service is running. The way of doing this is platform-dependent,

Check warning on line 46 in src/content/docs/infrastructure/infrastructure-agent/configuration/infrastructure-agent-configuration-settings.mdx

View workflow job for this annotation

GitHub Actions / vale-linter 

[vale] reported by reviewdog 🐶
[Microsoft.Passive] 'be set' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'be set' looks like passive voice.", "location": {"path": "src/content/docs/infrastructure/infrastructure-agent/configuration/infrastructure-agent-configuration-settings.mdx", "range": {"start": {"line": 46, "column": 44}}}, "severity": "INFO"}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: Please remove will from the sentence

check the documentation for your platform to add environment variables to system services.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: Please add the link to "documentation" if we are referring to another document

</Callout>

## Agent variables [#agent-variables]

<CollapserGroup>
Expand Down
Loading