Machine ID: Support for JSON log formatting#30755
Merged
strideynet merged 3 commits intomasterfrom Aug 21, 2023
Merged
Conversation
tigrato
approved these changes
Aug 21, 2023
Tener
approved these changes
Aug 21, 2023
Tener
reviewed
Aug 21, 2023
| | `--reader-user` | Enables POSIX ACLs and defines the Linux user that will read short-lived certificates from `--destination-dir`. | | ||
| | `--init-dir` | If using a config file and multiple destinations are configured, controls which destination dir to configure. | | ||
| | `--clean` | If set, remove unexpected files and directories from the destination. | | ||
| | `--log-format` | Controls the format of output logs. Can be `json` or `text`. Defaults to `text`. | |
Contributor
There was a problem hiding this comment.
@ptgott I think there was a project to auto-generate the CLI reference at some point. It would make it easier to maintain this part of the docs while potentially lowering the amount of the docs-review workload. What would be needed to make it a reality?
Contributor
There was a problem hiding this comment.
We haven't looked into auto-generating the CLI reference yet, but I imagine that we would need to:
- Determine how to auto-generate the docs from the source (e.g., using the
kingpinusage output). - Write a template for the auto-generated docs.
- Ensure that all information in the existing docs exists in the source (i.e, so we don't lose anything from auto-generation). This might include adding contextual information to the template. I'm guessing that this step will be the most difficult.
ptgott
approved these changes
Aug 21, 2023
|
@strideynet See the table below for backport results.
|
This file contains hidden or 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
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.
Use
--log-format jsonwithtbot start,tbot initortbot configureto have logs output in a structured JSON format.