Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/divanvisagie/delog
A log-based filter tool that acts like a debugger.
https://github.com/divanvisagie/delog
Last synced: 12 days ago
JSON representation
A log-based filter tool that acts like a debugger.
- Host: GitHub
- URL: https://github.com/divanvisagie/delog
- Owner: divanvisagie
- License: gpl-2.0
- Created: 2024-06-21T06:29:49.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-21T13:22:01.000Z (5 months ago)
- Last Synced: 2024-06-23T00:48:17.920Z (5 months ago)
- Language: Rust
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# delog
A log-based filter tool that acts like a debugger.
This repository contains multiple Rust projects (crates) organized in a single workspace. The main components are:
- `delog`: The primary tool for monitoring logs and pausing execution based on specific keywords.
- `log_simulator`: A tool to simulate logs for testing purposes.
## Table of Contents
- [Overview](#overview)
- [Setup](#setup)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [Development](#development)
- [Contributing](#contributing)
- [License](#license)
## Overview
**Delog** is designed to help you debug applications by monitoring logs for specific keywords (e.g., `DEBUG`, `BREAKPOINT`) and pausing execution when such keywords are detected. This allows you to interactively decide when to continue execution, making debugging more efficient and effective.
## Setup
1. **Clone the repository:**
```sh
git clone https://github.com/divanvisagie/delog.git
cd delog_workspace
```
2. **Build the workspace:**
```sh
cargo build
```
## Usage
1. **Run the log simulator:**
The `log_simulator` generates logs that can be used to test `delog`.
```sh
cargo run --bin log_simulator
```
2. **Use `delog` to monitor the log simulator:**
Run `delog` with a command to monitor. For example, to monitor the log simulator:
```sh
cargo run --bin delog -- cargo run --bin log_simulator
```
When a log containing `BREAK` or `BREAKPOINT` is detected, `delog` will pause execution. Press `c` to continue.
## Project Structure
```
delog_workspace/
├── Cargo.toml
├── delog/
│ ├── Cargo.toml
│ └── src/
│ └── main.rs
├── log_simulator/
│ ├── Cargo.toml
│ └── src/
│ └── main.rs
└── delog_lib/
├── Cargo.toml
└── src/
└── lib.rs
```
- **delog/**: The main tool for monitoring logs.
- **log_simulator/**: A tool to simulate logs for testing purposes.
- **delog_lib/**: Shared library with common functionality.
## Development
1. **Add dependencies:**
Add dependencies to the relevant `Cargo.toml` file.
2. **Build the project:**
```sh
cargo build
```
3. **Run tests:**
```sh
cargo test
```
4. **Run a specific binary:**
```sh
cargo run --bin
```
## Contributing
Contributions are welcome! Please open an issue or submit a pull request with your changes. Ensure your code adheres to the existing style and includes appropriate tests.
## License
This project is licensed under the GPL v2 License. See the [LICENSE](LICENSE) file for details.