diff --git a/README.md b/README.md index 94c0312..8d6a97f 100644 --- a/README.md +++ b/README.md @@ -80,13 +80,18 @@ This example sets up a root logger with a Loki appender. ``` - + +### Lookups / variable substitution + +Contents of the properties are automatically interpolated by Log4j2 (see [here](https://logging.apache.org/log4j/log4j-2.2/manual/lookups.html)). +All environment, system etc. variable references will be replaced by their values during initialization of the appender. +Alternatively this process could have been executed for every log message. The latter approach was deemed too expensive. If you need a mechanism +to replace a variable after logging system initialization I would lvie to hear your use case - please file an issue. + ## Details Let's go through the example config above and analyze configuration options (**Note: Tags are case-insensitive**). -**Note: Contents of the properties are automatically interpolated by Log4j2 runtime (see [here](https://logging.apache.org/log4j/log4j-2.2/manual/lookups.html)).** - #### Host (required) Network host address of Loki instance. Either IP address or host name. It will be passed to Netty and end up being resolved @@ -105,6 +110,10 @@ Self explanatory. This tag can be used multiple times to specify additional headers that are passed to Loki instance. One example is to pass a `X-Scope-OrgID` header when [running Loki in multi-tenant mode](https://grafana.com/docs/loki/latest/operations/authentication/). +``` +TODO: Implement [#4](https://github.com/tkowalcz/tjahzi/issues/4) +``` + #### Label (optional) Specify additional labels attached to each log line sent via this appender instance.