Johan Brandhorst-Satzkorn
a2477420da
Updated examples to show the common use case of specifying a directory path and file name for a file sink. This should hopefully prevent users from making the mistake of putting a full path for the file_name field and seeing an error like: [ERROR] unable to send event: operation="event.(Eventer).retrySend" warning= | 1 error occurred: | * mkdir : no such file or directory |
48 lines
1.2 KiB
Plaintext
48 lines
1.2 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Controller/Worker - Events - File Sink - Configuration
|
|
description: |-
|
|
The file sink configures Boundary to send events to a file.
|
|
---
|
|
|
|
# `file` Sink
|
|
|
|
The file sink configures Boundary to send events to a file.
|
|
|
|
```hcl
|
|
sink {
|
|
name = "obs-sink"
|
|
description = "Observations sent to a file"
|
|
event_types = ["observation"]
|
|
format = "cloudevents-json"
|
|
file {
|
|
path = "/var/log/boundary"
|
|
file_name = "events.ndjson"
|
|
}
|
|
}
|
|
```
|
|
|
|
The `sink` stanza may be specified more than once to make Boundary send events
|
|
to multiple sinks; however, each file sink must have a unique `path` +
|
|
`file_name`.
|
|
|
|
## common parameters
|
|
|
|
These parameters are shared across all sink types: [common sink parameters](/docs/configuration/events/common)
|
|
|
|
## `file` parameters
|
|
|
|
These parameters are only valid for a `file` sink.
|
|
|
|
- `file_name` - Specifies the file name for the sink.
|
|
|
|
- `path` - Optionally specifies the file path for the sink.
|
|
|
|
- `rotate_bytes` - Optionally specifies the number of bytes that should trigger rotation of
|
|
a file sink.
|
|
|
|
- `rotate_duration` - Optionally specifies how often a file sink should be rotated.
|
|
|
|
- `rotate_max_files` - Optionally specifies how many historical rotated files should be kept
|
|
for a file sink.
|