IMPORTANT
Tase is on beta version at the moment and missing truncate functionality.

WARNING Tase is well-tested on limited environments but not battle-tested fully.

Tase

Table of Contents

• Tase
  • Table of Contents
  • What is Tase?
  • Features
  • Installation
  • CLI Arguments
  • Configuration Reference
    • Configuration File Structure
      • 1. Configs (configs)
      • 2. Action Strategies
        • Truncate Strategy
        • Rotate Strategy
        • Delete Strategy
      • 3. Agents Configuration
      • 4. Server Configuration
  • Example Configuration
  • License
  • Contributing
  • Roadmap
  • Author

What is Tase?

Tase is a lightweight log management system written in Zig. It consists of a daemon running on a master server and lightweight agents deployed across multiple servers. With a single config.yaml, Tase allows centralized control over log file management, including deletion, rotation, and truncation.

Features

1. Master-Agent Architecture: The master server manages configurations and schedules, while agents execute log management tasks.
2. YAML-Based Configuration: The master server reads a config.yaml file to determine agent behavior and scheduling.
3. Cron-based Scheduling: The application uses cron-based scheduling to execute the log management tasks at predefined intervals.
4. Delete Logs: The application can delete log files that are older than a specified number of days or exceed a certain size.
5. Rotate Logs: The application can rotate log files, optionally compressing the archived files using the GZip algorithm. It can also delete archived logs older than a specified number of days or size same as delete action.
6. Truncate Logs (Not yet implemented): The application can truncate log files that are older than a specified number of days or exceed a certain size.

Installation

Tase is written in Zig, and to build and install it, follow these steps:

# Clone the repository
git clone https://github.com/Gnyblast/tase.git
cd tase

# Build the application
zig build

# Run the master daemon
zig-out/bin/tase -m master -c /path/to/config.yml

# Run the agent daemon on other servers that can communicate with master server
zig-out/bin/tase --agent --secret <a-generated-secret-that-matches-to-config> --port 7423 --master-host localhost --master-port 7423

CLI Arguments

Configuration Reference

Configuration File Structure

The application uses a YAML configuration file with the following main sections:

1. Configs (configs)

Each config defines a log management task with the following properties:

2. Action Strategies

The action object supports three strategies:

Truncate Strategy

Rotate Strategy

Delete Strategy

3. Agents Configuration

4. Server Configuration

Example Configuration

server:
  host: "127.0.0.1"
  port: 7423
  time_zone: "UTC"

agents:
  - name: agent_1
    hostname: "192.xxx.xxx.xxx"
    port: 7423
    secret: "your-secret-key"

configs:
  - app_name: "rotate_logs"
    logs_dir: "/var/log/myapp"
    log_files_regexp: 'test\.log'
    cron_expression: "0 0 * * *"
    run_agent_names:
      - agent_1
    action:
      strategy: rotate
      if:
        condition: days
        operator: ">"
        operand: 7
      compression_type: gzip
      compression_level: 5

  - app_name: "delete_logs"
    logs_dir: "/var/log/myapp2"
    log_files_regexp: 'test\.log'
    cron_expression: "30 08 * * 7"
    run_agent_names:
      - agent_1
      - local
    action:
      strategy: delete
      if:
        condition: size
        operator: ">"
        operand: 20

For more example please see: config

Contributing

Contributions are welcome! Feel free to submit issues and pull requests on GitHub.

Please read Contiribution guide

Roadmap

Version 1.0.0

• Write unit and coverate tests for log_service.zig
• Truncate
  • Write Truncate feature and it's tests to log_service.zig
  • Add Truncate container testing to app-test-container with all the requirements
  • Update config to cover truncate for test
• Create a builder for different CPU architectures and OS and implement a released inside

Version 2.0.0

1. Log file monitoring
2. Parse and process monitored log files
3. Save processed log files to a database for future consumption by a UI application

License

This project is licensed under the MIT License.

Author

Developed by Gnyblast.