Dan Heath
3f4cd53d16
* docs: Update headings for new style rule * docs: Fix headings - Get started * docs: Fix headings - Install * docs: Fix headings - Concepts * docs: Fix typos * docs: Fix headings - Configuration * docs: Fix headings - Operations * docs: Fix headings - Troubleshoot * docs: Fix headings - Clients and Develop * docs: Fix headings - HCP and ENT * docs: Fix headings - Release notes * docs: Fix typos * docs: Fix capitalization in TOC
48 lines
1.3 KiB
Plaintext
48 lines
1.3 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](/boundary/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.
|