https://github.com/kward/log4sh
log4sh is an advanced logging framework for Unix shell scripts.
https://github.com/kward/log4sh
Last synced: about 1 month ago
JSON representation
log4sh is an advanced logging framework for Unix shell scripts.
- Host: GitHub
- URL: https://github.com/kward/log4sh
- Owner: kward
- License: apache-2.0
- Created: 2017-09-14T20:56:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-09-24T20:12:33.000Z (over 2 years ago)
- Last Synced: 2025-03-27T06:22:57.057Z (about 2 months ago)
- Language: Shell
- Homepage:
- Size: 667 KB
- Stars: 140
- Watchers: 9
- Forks: 23
- Open Issues: 6
-
Metadata Files:
- Readme: README-1.5.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# log4sh
log4sh is an advanced logging framework for shell scripts (eg. sh, bash) that
works similar to the logging products available from the Apache Software
Foundataion (eg. log4j, log4perl).
The main source code is the single [src/log4sh](src/log4sh) file, which can be
copied to a destination of your choice, and used without any other files from
this source repository. The remaining files in `src/` are for unit testing.
Documentation for log4sh is available as [doc/log4sh.md](doc/log4sh.md). The
`doc/` folder holds additional supporting documentation.
## Testing the code
To test the, shUnit2 unit tests are included. Prepare the test environment, and
then you can run the tests. Hopefully all of the tests will pass with a 100%
success rate.
```
$ make test-prep
$ cd test
$ ./run-test-suite
```
## Related documentation
- Logging
- [log4j](http://logging.apache.org)
- Syslog
- [Introduction to the Syslog Protocol](http://www.monitorware.com/Common/en/Articles/syslog-described.php)
- [The BSD syslog Protocol](http://www.ietf.org/rfc/rfc3164.txt)
- Unit testing
- [JUnit](http://www.junit.org)