mirror of
https://github.com/tiennm99/tjahzi.git
synced 2026-10-18 10:15:09 +00:00
Re #36: Configuration options discussion.
This commit is contained in:
tomasz.kowalczewski committed
1 parent
43a22da5c7
commit
7fd1a21c14
3 files changed
+106
-46
No files matched your search
@@ -9,62 +9,26 @@ Latest releases:
|
||||
|
||||
[](https://search.maven.org/search?q=g:pl.tkowalcz.tjahzi)
|
||||
[](https://search.maven.org/search?q=g:pl.tkowalcz.tjahzi)
|
||||
[](https://search.maven.org/search?q=g:pl.tkowalcz.tjahzi)
|
||||
|
||||
## Features
|
||||
|
||||
Tjahzi allows pushing log data to Loki. It uses protobuf format to push log lines with timestamps and labels to Loki. This
|
||||
is implemented in the `core` component. On top of that we built the `log4j2 appender`. It's features include:
|
||||
is implemented in the `core` component. On top of that we built appenders for `log4j2` and `Logback`. These feature:
|
||||
|
||||
1. Logging does not allocate objects nor take any locks.
|
||||
1. Sending data to Loki in batches allocates as little as possible.
|
||||
1. We also provide a no-dependency version of log4j2 appender.
|
||||
1. Includes in-house implementation of protobuf wire format for Loki to reduce dependencies and improve performance
|
||||
1. We also provide a no-dependency versions of these appenders.
|
||||
1. Includes in-house implementation of protobuf wire format for Loki to reduce dependencies and improve performance.
|
||||
|
||||
It is currently used (that I know of) to ship logs from tens of servers at about 10GB of logs per day.
|
||||
Log4j2 appender is currently used to ship logs from tens of servers at about 10GB of logs per day.
|
||||
|
||||
## Getting started
|
||||
|
||||
1. Grab the no-dependency version of the appender:
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>pl.tkowalcz.tjahzi</groupId>
|
||||
<artifactId>log4j2-appender-nodep</artifactId>
|
||||
<version>0.9.4</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
If you already use a compatible version of Netty in your project then to reduce the size of your dependencies include
|
||||
regular appender distribution:
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>pl.tkowalcz.tjahzi</groupId>
|
||||
<artifactId>log4j2-appender</artifactId>
|
||||
<version>0.9.4</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
1. Add `packages="pl.tkowalcz.tjahzi.log4j2"` attribute to your log4j2 configuration xml.
|
||||
1. Include minimal appender configuration
|
||||
For `log4j2` appender quick start guide and detailed discussions see this [README.md](log4j2-appender/README.md).
|
||||
For `Logback` appender quick start guide and detailed discussions see this [README.md](logback-appender/README.md).
|
||||
|
||||
```xml
|
||||
<Loki name="loki-appender">
|
||||
<host>${sys:loki.host}</host>
|
||||
<port>${sys:loki.port}</port>
|
||||
|
||||
<PatternLayout>
|
||||
<Pattern>%X{tid} [%t] %d{MM-dd HH:mm:ss.SSS} %5p %c{1} - %m%n%exception{full}</Pattern>
|
||||
</PatternLayout>
|
||||
|
||||
<Label name="server" value="${sys:hostname}"/>
|
||||
</Loki>
|
||||
```
|
||||
|
||||
Detailed discussion of how to configure the appender with examples and description of all possible tags check
|
||||
[Log4j2 appender docs](log4j2-appender/README.md).
|
||||
|
||||
## Design principles
|
||||
## Core design principles
|
||||
|
||||
Logging should be lightweight and not interfere with main business tasks of threads that happen to log a message.
|
||||
Asking the logging subsystem to log a message should be as CPU efficient as possible.
|
||||
|
||||
@@ -3,7 +3,54 @@
|
||||
On top of a `Core` component with rather simplistic API we intend to build several layers that make it truly useful. Log4j2
|
||||
appender seemed like a good first.
|
||||
|
||||
## Example Log4j2 configuration
|
||||
## Quick start guide
|
||||
|
||||
1. Grab the no-dependency version of the appender:
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>pl.tkowalcz.tjahzi</groupId>
|
||||
<artifactId>log4j2-appender-nodep</artifactId>
|
||||
<version>0.9.4</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
If you already use a compatible version of Netty in your project then to reduce the size of your dependencies include
|
||||
regular appender distribution:
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>pl.tkowalcz.tjahzi</groupId>
|
||||
<artifactId>log4j2-appender</artifactId>
|
||||
<version>0.9.4</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
1. Add `packages="pl.tkowalcz.tjahzi.log4j2"` attribute to your existing log4j2 configuration file.
|
||||
1. Include minimal appender configuration:
|
||||
|
||||
```xml
|
||||
<Loki name="loki-appender">
|
||||
<host>${sys:loki.host}</host>
|
||||
<port>${sys:loki.port}</port>
|
||||
|
||||
<PatternLayout>
|
||||
<Pattern>%X{tid} [%t] %d{MM-dd HH:mm:ss.SSS} %5p %c{1} - %m%n%exception{full}</Pattern>
|
||||
</PatternLayout>
|
||||
|
||||
<Label name="server" value="${sys:hostname}"/>
|
||||
</Loki>
|
||||
```
|
||||
|
||||
1. Reference the appender from inside one of your logger definitions:
|
||||
|
||||
```xml
|
||||
<Root level="INFO">
|
||||
<AppenderRef ref="Loki"/>
|
||||
</Root>
|
||||
```
|
||||
|
||||
## Advanced configuration
|
||||
|
||||
This example sets up a root logger with a Loki appender. Note that `pl.tkowalcz.tjahzi.log4j2` is added to `packages` attribute
|
||||
of configuration so that the appender can be found.
|
||||
|
||||
@@ -2,7 +2,56 @@
|
||||
|
||||
On top of the `Core` component that sends logs to Loki this project gives you Logback appender.
|
||||
|
||||
## Example configuration
|
||||
## Quick start guide
|
||||
|
||||
1. Grab the no-dependency version of the appender:
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>pl.tkowalcz.tjahzi</groupId>
|
||||
<artifactId>logback-appender-nodep</artifactId>
|
||||
<version>0.1.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
If you already use a compatible version of Netty in your project then to reduce the size of your dependencies include
|
||||
regular appender distribution:
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>pl.tkowalcz.tjahzi</groupId>
|
||||
<artifactId>logback-appender</artifactId>
|
||||
<version>0.1.0</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
1. Include minimal appender configuration in your existing logback configuration:
|
||||
|
||||
```xml
|
||||
<appender name="Loki" class="pl.tkowalcz.tjahzi.logback.LokiAppender">
|
||||
<host>${loki.host}</host>
|
||||
<port>${loki.port}</port>
|
||||
|
||||
<encoder>
|
||||
<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
|
||||
</encoder>
|
||||
|
||||
<label>
|
||||
<name>server</name>
|
||||
<value>${HOSTNAME}</value>
|
||||
</label>
|
||||
</appender>
|
||||
```
|
||||
|
||||
1. Reference the appender from inside one of your logger definitions:
|
||||
|
||||
```xml
|
||||
<root level="debug">
|
||||
<appender-ref ref="Loki"/>
|
||||
</root>
|
||||
```
|
||||
|
||||
## Advanced configuration
|
||||
|
||||
This example sets up a root logger with Loki appender. The appender definition must point to class `pl.tkowalcz.tjahzi.logback.LokiAppender`.
|
||||
|
||||
|
||||
Reference in new issue
Block a user