Browse Source

update readme

main
churchianity 2 years ago
parent
commit
2fb78052bd
  1. 5
      README.md

5
README.md

@ -1,8 +1,9 @@
# Background # Background
log4jesus is an attempt to write a 'logging library' that has all of the practical benefits of a much larger logging library, but with no dependencies, and in much fewer lines of code, without sacrificing features, by taking a straight-forward approach of solving the problem at hand, and no other problems. There is nothing in this 'library' that could be called a 'system' or 'framework'. Just a few functions that actually do the work required.
tlog is an attempt to write a 'logging library' that has all of the practical benefits of a much larger logging library, but with no dependencies, and in much fewer lines of code, without sacrificing features, by taking a straight-forward approach of solving the problem at hand, and no other problems. There is nothing in this 'library' that could be called a 'system' or 'framework'. Just a few functions that actually do the work required.
# Usage # Usage
The API surface is just two functions:
```js ```js
const { log, logt } = require("./tlog"); const { log, logt } = require("./tlog");
@ -57,7 +58,7 @@ The configuration file is a .js file to enable using environment variables, as y
Network requests can fail at runtime, and often those failures are also something you want to log. Network requests can fail at runtime, and often those failures are also something you want to log.
Specify the `errorTags` property on the http object, and errors will attempt to be written to the target(s) specified when they occur. Specify the `errorTags` property on the http object, and errors will attempt to be written to the target(s) specified when they occur.
If the target that failed is tagged with one of the tags on its own `errorTags` property, it will skip itself. If the target that failed is tagged with one of the tags on its own `errorTags` property, it will skip itself.
This feature is pretty limited and needs elaboration.
This feature is pretty limited and needs elaboration. In particular, it would probably be a good idea to retry some configurable # of times, but we don't do that yet.
# Other Configuration Options/Settings # Other Configuration Options/Settings
## timestamps ## timestamps

Loading…
Cancel
Save