lvotypko / logstash-plugin

Jenkins plugin to ship the console log off to Logstash

Jenkins Logstash Plugin

Travis: Jenkins:

This plugin adds support for sending a job's console log to Logstash indexers such as ElasticSearch, RabbitMQ, or Redis.

• see Jenkins wiki for detailed feature descriptions
• use JIRA to report issues / feature requests

Install

• Generate the hpi file with the command: mvn package

• Put the hpi file in the directory $JENKINS_HOME/plugins

• Restart jenkins

Configure

Currently supported methods of input/output:

• ElasticSearch {REST API}
• Redis {format => 'json_event'}
• RabbitMQ {mechanism => PLAIN}
• Syslog {format => cee/json (RFC-5424,RFC-3164), protocol => UDP}

Pipeline

Logstash plugin can be used as a publisher in pipeline jobs:

 node('master') {
        sh'''
        echo 'Hello, world!'
        '''
        logstashSend failBuild: true, maxLines: 1000
 }

License

The Logstash Plugin is licensed under the MIT License.

Contributing

• Fork the project on Github
• Make your feature addition or bug fix, write tests, commit.
• Send me a pull request. Bonus points for topic branches.

Adding support for new indexers

• Create a new class in the package jenkins.plugins.logstash.persistence that extends AbstractLogstashIndexerDao
• Add a new entry to the enum IndexerType in LogstashIndexerDao
• Add a new mapping to the INDEXER_MAP in IndexerDaoFactory