# kafkalogs-plugin

**Repository Path**: tz826/kafkalogs-plugin

## Basic Information

- **Project Name**: kafkalogs-plugin
- **Description**: No description available
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-02-23
- **Last Updated**: 2024-05-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Jenkins Kafka Logs Plugin

This plugin adds support for wrapping pipeline project logs in a build wrapper that ships them to kafka.

This plugin is available [here](http://repo.jenkins-ci.org/releases/org/jenkins-ci/plugins/kafkalogs/)
and has [a page](https://wiki.jenkins.io/display/JENKINS/Kafkalogs+Plugin) on the Jenkins Wiki.

## Using in pipeline workflows

The build wrapper can be used to ship logs to kafka server and topic.

E.g., pipeline job "test" with build 40 ran with the following pipeline script:

```groovy
node {
    wrap([$class: 'KafkaBuildWrapper', kafkaServers: 'host1.example.com:9092,host2.example.com:9092', kafkaTopic: 'buildlogs', metadata:'Other info to send..']) {
        echo 'Hello World'
        echo 'Oh Hello'
        echo 'Finally'
    }
}
```

Or you can use `withKafkaLog` structs syntax:

```groovy
node {
	withKafkaLog(kafkaServers: 'host1.example.com:9092,host2.example.com:9092', kafkaTopic: 'buildlogs', metadata:'Other info to send..') {
		echo 'Hello World'
		echo 'Oh Hello'
		echo 'Finally'
	}
}
```


Would produce messages on kafka topic "buildlogs":

```
{"build":40,"job":"test","message":"Hello World","metadata":"Other info to send.."}
{"build":40,"job":"test","message":"Oh Hello","metadata":"Other info to send.."}
{"build":40,"job":"test","message":"Finally","metadata":"Other info to send.."}
```

## Copyright and Such

Copyright O.C. Tanner 2018, https://www.octanner.com. See LICENSE for more information.  

Work was derived from the sources of https://github.com/jenkinsci/ansicolor-plugin Thanks to Daniel Dobrovkine for providing a great color ansi plugin.