Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
Signed-off-by: Kohei Morita <[email protected]>
  • Loading branch information
mrtc0 committed Mar 27, 2022
1 parent 7c6a84e commit b574bf3
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
36 changes: 36 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <br><li>`format: [json|text]`</li><li>`output: <path>`</li><li>`max_size:`: Maximum size to rotate (MB). Default: 100MB</li><li>`max_age`: Period for which logs are kept. Default: 365</li>| Log configuration. |
| `log` | List containing the following sub-keys: <br><li>`format: [json|text]`</li><li>`output: <path>`</li><li>`max_size:`: Maximum size to rotate (MB). Default: 100MB</li><li>`max_age`: Period for which logs are kept. Default: 365</li><li>`labels`: Key / Value to be added to the log.</li>| Log configuration. |

0 comments on commit b574bf3

Please sign in to comment.