Logstash

An opinionated Docker implementation for Logstash based on the upstream official image.

• Features
• Getting Started
  • Prerequisites
  • Installing
  • Environmental Variables
• Deployment
• Components
• Contributing
• Versioning
• Authors
• License
• Acknowledgments

Features

There are a number of features that differentiate this implementation from the official or other solutions.

• Improved startup time at the expense of runtime performance.
• Heap sized based on container memory and percentages.
• Enables AWS Kinesis input plugin.
• Enabled Prune filter plugin.

Getting Started

This implementation is designed to be used with a Helm chart. However, there is a docker compose file included for testing this implementation locally. Bringing up a test cluster and discovering the Logstash endpoint is easily done with just 2 commands.

docker-compose up

It will likely take a few minutes for the containers to start and you can verify when it is available using curl.

curl $(docker-compose port logstash 8080)

Prerequisites

The only requirements for bringing up this implementation locally is Docker.

Docker 17.12.0+

Installing

It is expected that the Helm chart will be used to install this container. For local development, there are a number of ways to interact with Elasticsearch.

The http endpoint is the main way applications can send data to Logstash.

docker-compose port logstash 8080

Logstash data is send to Elasticsearch and can be viewed using Kibana.

docker-compose port kibana 5601

Environmental Variables

See the official documentation for Logstash running in Docker.

Deployment

For use on live systems, see the documentation for the Helm chart.

Components

• Logstash - Logstash - transport and process your logs, events, or other data

• Logstash-Docker - Official Logstash Docker image

• Elasticsearch - Open Source, Distributed, RESTful Search Engine

• Kibana - Kibana analytics and search dashboard for Elasticsearch

• Prometheus Logstash Exporter - Prometheus exporter for Logstash metrics

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Michael Lorant - Initial work - Nine

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Elastic
• Nine