open-vault/website/source/docs/audit/syslog.html.md
Jeff Escalante a3dfde5cec New Docs Website (#5535)
* conversion stage 1

* correct image paths

* add sidebar title to frontmatter

* docs/concepts and docs/internals

* configuration docs and multi-level nav corrections

* commands docs, index file corrections, small item nav correction

* secrets converted

* auth

* add enterprise and agent docs

* add extra dividers

* secret section, wip

* correct sidebar nav title in front matter for apu section, start working on api items

* auth and backend, a couple directory structure fixes

* remove old docs

* intro side nav converted

* reset sidebar styles, add hashi-global-styles

* basic styling for nav sidebar

* folder collapse functionality

* patch up border length on last list item

* wip restructure for content component

* taking middleman hacking to the extreme, but its working

* small css fix

* add new mega nav

* fix a small mistake from the rebase

* fix a content resolution issue with middleman

* title a couple missing docs pages

* update deps, remove temporary markup

* community page

* footer to layout, community page css adjustments

* wip downloads page

* deps updated, downloads page ready

* fix community page

* homepage progress

* add components, adjust spacing

* docs and api landing pages

* a bunch of fixes, add docs and api landing pages

* update deps, add deploy scripts

* add readme note

* update deploy command

* overview page, index title

* Update doc fields

Note this still requires the link fields to be populated -- this is solely related to copy on the description fields

* Update api_basic_categories.yml

Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.

* Add bottom hero, adjust CSS, responsive friendly

* Add mega nav title

* homepage adjustments, asset boosts

* small fixes

* docs page styling fixes

* meganav title

* some category link corrections

* Update API categories page

updated to reflect the second level headings for api categories

* Update docs_detailed_categories.yml

Updated to represent the existing docs structure

* Update docs_detailed_categories.yml

* docs page data fix, extra operator page remove

* api data fix

* fix makefile

* update deps, add product subnav to docs and api landing pages

* Rearrange non-hands-on guides to _docs_

Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.

* WIP Redirects for guides to docs

* content and component updates

* font weight hotfix, redirects

* fix guides and intro sidenavs

* fix some redirects

* small style tweaks

* Redirects to learn and internally to docs

* Remove redirect to `/vault`

* Remove `.html` from destination on redirects

* fix incorrect index redirect

* final touchups

* address feedback from michell for makefile and product downloads
2018-10-19 08:40:11 -07:00

1.9 KiB

layout page_title sidebar_title sidebar_current description
docs Syslog - Audit Devices Syslog docs-audit-syslog The "syslog" audit device writes audit logs to syslog.

Syslog Audit Device

The syslog audit device writes audit logs to syslog.

It currently does not support a configurable syslog destination, and always sends to the local agent. This device is only supported on Unix systems, and should not be enabled if any standby Vault instances do not support it.

~> Warning: Audit messages generated for some operations can be quite large, and can be larger than a maximum-size single UDP packet. If possible with your syslog daemon, configure a TCP listener. Otherwise, consider using a file backend and having syslog configured to read entries from the file; or, enable both file and syslog so that a failure for a particular message to log directly to syslog will not result in Vault being blocked.

Examples

Audit syslog device can be enabled by the following command:

$ vault audit enable syslog

Supply configuration parameters via K=V pairs:

$ vault audit enable syslog tag="vault" facility="AUTH"

Configuration

  • facility (string: "AUTH") - The syslog facility to use.

  • tag (string: "vault") - The syslog tag to use.

  • log_raw (bool: false) - If enabled, logs the security sensitive information without hashing, in the raw format.

  • hmac_accessor (bool: true) - If enabled, enables the hashing of token accessor.

  • mode (string: "0600") - A string containing an octal number representing the bit pattern for the file mode, similar to chmod.

  • format (string: "json") - Allows selecting the output format. Valid values are "json" and "jsonx", which formats the normal log entries as XML.

  • prefix (string: "") - A customizable string prefix to write before the actual log line.