logpeek 0.1.0

A logger implementation for the log crate. Meant to integrate with logpeek-server.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

# logpeek

`logpeek` is a logger implementation for the `log` crate, which focuses on reliability and simplicity.
It is meant to integrate seamlessly with logpeek-server.


- **Remote monitoring with logpeek-server.** Logpeek is designed to work with [logpeek-server] by default, a web-based log tail explorer.

- **A drop-in replacement for existing logger implementations.** If already using the `log` crate and it's macros,
simply replace your existing logger with `logpeek` and you're good to go.

- **Ease of use.** The logger is configured via a `Config` struct, although
for most use cases, the default configuration will suffice.  

[logpeek-server]: https://github.com/TheHighestBit/logpeek-server

## Usage

Either use `cargo add logpeek log` or include them in your `Cargo.toml`.
```toml
[dependencies]
logpeek = "0.1.0"
log = "0.4.20"
```

Initializing the logger is as simple as

```rust
use logpeek;
use log::error;

// See the documentation for the config module for more options
let config = logpeek::config::Config {
    logging_mode: logpeek::config::LoggingMode::FileAndConsole,
    datetime_format: logpeek::config::DateTimeFormat::Custom("[hour]:[minute]:[second]:[subsecond][offset_hour sign:mandatory]"), // Logpeek-server requires the UTC offset to be present. 
   ..Default::default()
};

logpeek::init(config).unwrap(); // For the default config use logpeek::init(Default::default()).unwrap();

error!("This is a test error!");
```