godwit-daemon

Crates.iogodwit-daemon
lib.rsgodwit-daemon
version0.1.10
sourcesrc
created_at2020-06-04 10:13:30.197239
updated_at2020-08-09 03:34:58.511828
descriptionA daemon runner for GodWit.
homepagehttps://www.passeriform.com/prod/GodWit/daemon
repositoryhttps://github.com/Passeriform/GodWit-Daemon
max_upload_size
id249956
size126,099
Utkarsh Bhardwaj (Passeriform)

documentation

README

GodWit Daemon

crate docs build codecov maintenance

homepage repo

A daemon runner for GodWit.

Godwit-daemon is a runner for managing godwit processes. This utility is implicitly used by godwit itself. The utility is exposed for developers/power-users to create their own projects, but for a normal user something better might already exist on the godwit command itself as a plugin.

For developers, this utility should be considered as a crucial botch. A project made using this utility is also recommended to have a plugin-like front usable by godwit. The intention is to keep godwit as a complete cover over the daemon.

The "daemon" etymology does not represent daemons in conventional sense. The utility considers any process running on managed thread as a daemon. Unlike daemons though, the runner never detaches/loses focus of the process at hand. Thus, it's better to look at the utility itself as a daemon, which doesn't follow written states like godwit.

Install

release aur debian homebrew

The daemon is bundled with GodWit and can be installed as a dependency. If only the daemon is required, it is alse available on AUR and PPA repositories as a separate package.

Simply install it using

$ yay -Syu godwit-daemon

OR

$ sudo add-apt-repository ppa:passeriform/ppa
$ sudo apt update
$ sudo apt install godwit-daemon

Use

Start by creating a new tracer.

$ godwit-daemon new trace <application>

To store the trace to log.

$ godwit-daemon new trace <application> > my.trace

To run process through trace pruning.

# The file my.trace will continuously update as steps are pruned.
$ godwit-daemon regress trace <application>
 > my.trace

To kill all associated nodes and drop resources.

$ godwit-daemon die

Contributing

issues pull-requests

If you want to contribute, start by cloning this repository.

    git clone https://github.com/Passeriform/GodWit-Daemon Godwit-Daemon

Checkout to a new branch.

    # Use kebab-case categorization format.


    # Ex: A new feature.
    git checkout feature-<feature>

    # Ex: A bugfix.
    git checkout bugfix-<bug>

    # Ex: A meta update.
    git checkout meta-<title>

    # Ex: A documentation update.
    git checkout docs-<title>

    # Ex: A CI update.
    git checkout ci-<title>

Do your thing...

Code up

Squash commits and issue a PR at https://github.com/Passeriform/GodWit-Daemon

License

license

Licensed under either of

at your option.

Credition

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 38

cargo fmt