Task-based logging for rust

Matt Gleich

Last update: Feb 28, 2022

Related tags

Logging task_log

Overview

task_log

task_log is a task-based logger.

Installing

Just add task_log = 0.1.4 to your Cargo.toml's dependency section.

Example

Let's get right to the chase. What does using this logger look like?

Result<()> { let filename = "hello.txt"; fs::write(filename, "foo bar")?; thread::sleep(Duration::from_secs(2)); fs::remove_file(filename)?; Ok(()) }) .expect("Failed to create and delete the file"); } ">

use std::io::Result;
use std::time::Duration;
use std::{fs, thread};

use task_log::task;

fn main() {
	task("Creating and removing file", || -> Result<()> {
		let filename = "hello.txt";
		fs::write(filename, "foo bar")?;
		thread::sleep(Duration::from_secs(2));
		fs::remove_file(filename)?;
		Ok(())
	})
	.expect("Failed to create and delete the file");
}

As you can see we provide a task to run and a description of what that task is doing. When we run this code we get the following output.

To see more examples see the examples folder.

Configuration

You can configure task_log's task function using a struct called ConfigBuilder. Here is an example of using ConfigBuilder:

u32 { let result = 1 + 2; thread::sleep(Duration::from_secs(2)); result }); println!("Sum is {}", sum) }">

use std::thread;
use std::time::Duration;

use task_log::{task, ConfigBuilder};

fn main() {
	ConfigBuilder::new()
		.duration(false)
		.apply()
		.expect("Failed to setup configuration");

	let sum = task("Adding 1 and 2", || -> u32 {
		let result = 1 + 2;
		thread::sleep(Duration::from_secs(2));
		result
	});

	println!("Sum is {}", sum)
}

To learn more about ConfigBuilder please reference the docs.rs documentation.

Future Plans

Here are some features I'm hoping to implement in the future:

Run time: Output the run time so far in the RUNNING prefix.
Spinners: Show a loading symbol for long-running tasks.
File output: Allow writing of logs to a file.
Double log lines: Option to output log to a second line instead of replacing the first one.

You might also like...

A pretty, sensible logger for Rust - ideal for running examples and tests on a crate of choice

sensible-env-logger A pretty, sensible logger for Rust - ideal for running examples and tests on a crate of choice. This is a thin wrapper around pret

3 Aug 9, 2022

A rust library for creating and managing logs of arbitrary binary data

A rust library for creating and managing logs of arbitrary binary data. Presently it's used to collect sensor data. But it should generally be helpful in cases where you need to store timeseries data, in a nearly (but not strictly) append-only fashion.

1 May 9, 2022

A cool log library built using rust-lang

RustLog A cool log library built using rust-lang Installation: Cargo.toml rustlog = { git = "https://github.com/krishpranav/rustlog" } log = "0.4.17"

2 Jul 21, 2022

Easy c̵̰͠r̵̛̠ö̴̪s̶̩̒s̵̭̀-t̶̲͝h̶̯̚r̵̺͐e̷̖̽ḁ̴̍d̶̖̔ ȓ̵͙ė̶͎ḟ̴͙e̸̖͛r̶̖͗ë̶̱́ṉ̵̒ĉ̷̥e̷͚̍ s̷̹͌h̷̲̉a̵̭͋r̷̫̊ḭ̵̊n̷̬͂g̵̦̃ f̶̻̊ơ̵̜ṟ̸̈́ R̵̞̋ù̵̺s̷̖̅ţ̸͗!̸̼͋

Rust S̵̓i̸̓n̵̉ I̴n̴f̶e̸r̵n̷a̴l mutability! Howdy, friendly Rust developer! Ever had a value get m̵̯̅ð̶͊v̴̮̾ê̴̼͘d away right under your nose just when

294 Dec 23, 2022

TimeKnight is a neat little TUI-based timer app I use in conjunction with a task tracker

Comments

Time formatting issues

When working in a time format that can go over 100 (such as nanoseconds) the formatting doesn't work correctly. This should be fixed by using proper padding supplied by rust's formatting.
bug good first issue

opened by gleich 0
[ImgBot] Optimize images

Beep boop. Your images are optimized!

Your image file size has been reduced 🎉

Details

| File | Before | After | Percent reduction | |:--|:--|:--|:--| | /demo.gif | 496.02kb | 478.31kb | 3.57% |

📝 docs | :octocat: repo | 🙋🏾 issues | 🏪 marketplace

~Imgbot - Part of Optimole family

opened by imgbot[bot] 0