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

Add info about order of arguments when customising the Windows config #837

Merged
merged 2 commits into from
May 14, 2024

Conversation

clayton-cornell
Copy link
Contributor

PR Description

Add info about order of arguments when customising the Windows config.

If the storage.path argument is not last in the set of custom arguments, you will get the following error:

Error: failed to create the remotecfg service: mkdir C:\ProgramData\GrafanaLabs\Alloy\data --server.http.listen-addr=0.0.0.0:12345: The directory name is invalid.

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

@clayton-cornell clayton-cornell added type/docs Docs Squad label across all Grafana Labs repos backport release/v1.0 backport release/v1.1 labels May 13, 2024
@clayton-cornell clayton-cornell requested a review from a team May 13, 2024 20:16
@rfratto
Copy link
Member

rfratto commented May 13, 2024

Hm, the argument isn't positional though, so I think there's a different underlying issue here. What were the custom arguments passed that caused the issue?

@rfratto
Copy link
Member

rfratto commented May 14, 2024

@clayton-cornell I'm not able to reproduce an issue where the ordering matters here. Swapping the order worked for me:

image

I suspect the underlying issue here was not ensuring each argument was placed on its own line in the Edit Multi-String box. Maybe we can document that as a requirement instead?

@rfratto rfratto added backport-to-agent PR should be backported to the agent repo. and removed backport-to-agent PR should be backported to the agent repo. labels May 14, 2024
@clayton-cornell clayton-cornell merged commit 3ad652a into main May 14, 2024
18 checks passed
@clayton-cornell clayton-cornell deleted the docs/update-windows-config branch May 14, 2024 16:48
github-actions bot pushed a commit that referenced this pull request May 14, 2024
…#837)

* Add info to step 4 about order of arguments

* Update advice about arguments

(cherry picked from commit 3ad652a)
github-actions bot pushed a commit that referenced this pull request May 14, 2024
…#837)

* Add info to step 4 about order of arguments

* Update advice about arguments

(cherry picked from commit 3ad652a)
clayton-cornell added a commit that referenced this pull request May 14, 2024
…#837) (#846)

* Add info to step 4 about order of arguments

* Update advice about arguments

(cherry picked from commit 3ad652a)

Co-authored-by: Clayton Cornell <[email protected]>
clayton-cornell added a commit that referenced this pull request May 14, 2024
…#837) (#847)

* Add info to step 4 about order of arguments

* Update advice about arguments

(cherry picked from commit 3ad652a)

Co-authored-by: Clayton Cornell <[email protected]>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport release/v1.0 backport release/v1.1 backport-to-agent PR should be backported to the agent repo. frozen-due-to-age type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants