Skip to content

SAP/elasticsearch-logs-plugin

REUSE status

❗ This is not ready for productive usage

Configuration of the plugin may change without further notice in an incompatible way!

Description

A Jenkins plugin to send Pipeline build logs to an Elasticsearch instance.

This is an implementation of JEP-210.

Requirements

Download and Installation

In your Jenkins go to Manage Jenkins > Manage Plugins > Available check Pipeline Logging via Elastic Search and press Install without restart

Configuration

Go to Manage Jenkins > System Configuration > Logging to Elasticsearch for Pipelines and select Enable.

Limitations

The Elasticsearch Java High Level REST Client used by this plugin should match the Elasticsearch server version in order to prevent unexpected results.

In order to not only support the latest Elasticsearch version, and since we did not experience any issues (client: 6.x, server: 7.x), we decided to stay on a smaller client major version. If you experience any problems please create a GitHub issue.

Known Issues

None

How to obtain support

Open an issue in Github

Code Style

The Jenkins Beginners Guide to Contribute recommends the Oracle Code Conventions for Java from 1999. Those Guidelines however might better describe the Code Style rules we apply.

Most relevant rules:

  • line width: 140
  • indentation: 4 spaces
    • no tabs

To-Do (upcoming changes)

  • Implement a reader from Elastic Search
  • Improve http connection handling

About

A Jenkins plugin to send Pipeline build logs to an Elasticsearch instance.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 12