req/req.yml

58 lines
1.3 KiB
YAML

name: journal-uploader
description: |-
The journal-uploader has two main functionalities.
- Take a stream of log messages and filter them depending on their severity
- Upload journal logs for a specified time when activated through cloud call
topics:
FEAT-1:
name: Traced Logging
subtopics:
SUB-1:
name: File Monitoring
requirements:
REQ-1:
name: Continuous Monitoring
description: The tool must continuously monitor a designated directory.
definitions:
- name: Default Journal Directory
value: /run/log/journal/<machine_id>
additional_info:
- Machine ID can be found at /etc/machine-id
- name: Default Output Directory
value: /run/log/filtered-journal
config_defaults:
- name: Journal Directory
type: Path
- name: Output Directory
type: Path
- name: Trigger Priority
type: Enum
valid_values:
- Emergency
- Alert
- Critical
- Error
- Warning
- Notice
- Info
- Debug
default_value: Warning
- name: Journal Context
type: Integer
unit: Seconds
default_value: '15'
- name: Max File Size
type: Integer
unit: Bytes
default_value: '8388608'
hint: (8 MB)
- name: Max Directory Size
type: Integer
unit: Bytes
default_value: '75497472'
hint: (72 MB)
- name: File Monitoring Interval
type: Integer
unit: Seconds
default_value: '10'