VAULT-8732: Add log-file to Vault Agent
#17841
Conversation
| Name: flagNameLogFile, | ||
| Target: &c.flagLogFile, | ||
| EnvVar: EnvVaultLogFile, | ||
| Usage: "Path to the log file that Vault should use for logging", |
There was a problem hiding this comment.
It's more than this though right? It can be a log dir, or a prefix: https://developer.hashicorp.com/consul/docs/agent/config/cli-flags#_log_file
There was a problem hiding this comment.
Shouldn't we add the other log options (like the rotation options) as well as flags? Or alternatively, since unlike consul we have logs of config without associated flags, should we maybe not add the -log-file CLI option?
There was a problem hiding this comment.
In Consul yes, as Consul does rotation of logs etc. so it fiddles with the name a lot more. In Vault I took the simple approach so it's no frills.
Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com>
| @@ -2,10 +2,10 @@ | |||
| layout: docs | |||
| page_title: Commands (CLI) | |||
| description: |- | |||
| In addition to a verbose HTTP API, Vault features a command-line interface | |||
There was a problem hiding this comment.
This is a lot of (potentially unnecessary?) changes - are all of these necessary? I'm wondering if it's possible to revert the (probably automatically done by your editor) changes and keep just the ones you've added. If nothing else, we should ensure that the formatting changes don't change the contents at all!
There was a problem hiding this comment.
(It also makes it hard to see only the bits you've changed, so it would help for my review, too!)
There was a problem hiding this comment.
Thanks for the catch @VioletHynes, I'm not sure why my IDE went wild with that. :(
There was a problem hiding this comment.
Looks good! Approved. I'm finding it hard to review the docs changes with the formatting changes added (I assume automatically by your editor), but the bits I've seen have been good.
Nice work!
Edit: Actually, the vercel deployment failed here: https://vercel.com/hashicorp/vault/4HArMN49mEzH9tMzGVfhzu1H2e3F
We should make sure to re-deploy then ensure the docs look good before merging.
* Started work on adding log-file support to Agent * Allow log file to be picked up and appended * Use NewLogFile everywhere * Tried to pull out the config aggregation from Agent.Run Co-authored-by: Nick Cabatoff <ncabatoff@hashicorp.com>
This pull request will add support for Vault Agent to write log files to a specified path, it can be supplied using:
log_file)VAULT_LOG_FILE)-log-file)The order of precedence follows that of other Vault parameters,
CLI > Environment variable > HCL config.The change was modelled heavily on Consul's approach to logging, and we have employed Consul changes to Vault (in a stripped down format) to support logging to files, in order to support logging from Vault Agent when running as a Windows Service.
Documentation has been updated, but suggest that it's reviewed for style guidance.
Some manual testing to be carried out in a Windows environment before this PR is marked 'ready for review'.
Related issues: #15393