https://github.com/domclick/kafka-logback

https://github.com/domclick/kafka-logback

java kafka logback logback-appender logging

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/domclick/kafka-logback
• Owner: domclick
• License: bsd-3-clause
• Created: 2017-03-09T10:21:38.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T08:35:06.000Z (almost 2 years ago)
• Last Synced: 2026-01-14T17:16:46.991Z (26 days ago)
• Topics: java, kafka, logback, logback-appender, logging
• Language: Java
• Size: 37.1 KB
• Stars: 34
• Watchers: 3
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Kafka logback appender [![](https://jitpack.io/v/Sberned/kafka-logback.svg)](https://jitpack.io/#Sberned/kafka-logback) ![](https://travis-ci.org/Sberned/kafka-logback.svg?branch=master) ![](https://maven-badges.herokuapp.com/maven-central/ru.sberned/kafka-logback/badge.svg)

This is a logback appender for Kafka (3.7.0 kafka-client used)

This appender expects topic, bootstrapServers, valueSerializer and layout as mandatory.

You could also supply additional kafka customProps in `` tag in the following manner

`key1|value1,key2|value2`



We recommend wrapping this appender inside AsyncAppender in order not to block your application (consider setting neverBlock to true).

This appender ships with CustomJsonLayout, which extends JsonLayout from logback. It inherits all its properties and adds its own in the same manner.

List of properties added: includeLineNumber, includeClassName, includeMethodName, includeHost, includeFileName all set to true by default.

You can also add any constant fields via additionalFields (see sample config below).



Do not forget to add `true` to AsyncAppender in case you need caller data (method, class, file, line number).

Kafka appender could be used with any other layout rather than Json, just think about proper kafka value Serializer.



Sample configuration

```xml

    

        

        ,

        org.apache.kafka.common.serialization.StringSerializer

        false

        acks|all

        

            yyyy-MM-dd'T'HH:mm:ssZ

            

            environment|${KAFKA_ENVIRONMENT:-dev}

        

    

    

        true

        true

        

    

    

    

        

        

    

    

    

        

        

        

    

```