From b574bf3c6c4434646e2f14a1b338a82a2befe22b Mon Sep 17 00:00:00 2001 From: Kohei Morita Date: Sun, 27 Mar 2022 22:46:00 +0900 Subject: [PATCH] docs: update Signed-off-by: Kohei Morita --- CHANGELOG.md | 36 +++++++++++++++++++++++++++++ docs/configuration/configuration.md | 2 +- 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bdd06b7..6c64766 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,42 @@ ## [Unreleased][unreleased] +### Added + +#### Support for labels in log + +Logs can contain arbitrary labels in key/value format. +For example: + +```yaml +log: + labels: + environment: produdction + role: app +``` + +```json +{ + "Action": "BLOCKED", + "Addr": "52.219.1.53", + "Comm": "curl", + ... + "environment": "production", + "role": "app", + "time": "2022-03-27T13:33:17Z" +} +``` + +### Fix + +#### TTL-based name resolution instead of periodically [#18](https://github.com/mrtc0/bouheki/pull/18) + +Workarounds for [#17](https://github.com/mrtc0/bouheki/issues/17). + +#### Context logger + +Log context was not set correctly. + ## [0.0.6] 2022-03-23 ### Fix diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md index f206fef..27c4dee 100644 --- a/docs/configuration/configuration.md +++ b/docs/configuration/configuration.md @@ -9,4 +9,4 @@ bouheki's configuration file is a YAML file containing a collection of `key: val | `network` | List (see [Network Restiction](./network-restriction/configuration.md)) | Rule for network restrictions. | | `files` | List (see [File Access Restiction](./file-access-restriction/configuration.md)) | Rule for file access restrictions. | | `mount` | List (see [Mount Restiction](./mount-restriction/configuration.md)) | Rule for mount restrictions. | -| `log` | List containing the following sub-keys:
  • `format: [json|text]`
  • `output: `
  • `max_size:`: Maximum size to rotate (MB). Default: 100MB
  • `max_age`: Period for which logs are kept. Default: 365
  • | Log configuration. | \ No newline at end of file +| `log` | List containing the following sub-keys:
  • `format: [json|text]`
  • `output: `
  • `max_size:`: Maximum size to rotate (MB). Default: 100MB
  • `max_age`: Period for which logs are kept. Default: 365
  • `labels`: Key / Value to be added to the log.
  • | Log configuration. | \ No newline at end of file