An open API service indexing awesome lists of open source software.

https://github.com/runnable/elk

Elasticsearch, Logstash, & Kibana (ELK) Stack
https://github.com/runnable/elk

Last synced: 10 months ago
JSON representation

Elasticsearch, Logstash, & Kibana (ELK) Stack

Awesome Lists containing this project

README

          

# Elasticsearch, Logstash, Kibana (ELK)

Configured to use redis as a message broker for logstash, based on
[sebp/elk](https://registry.hub.docker.com/u/sebp/elk/).

## Running

When running the image ensure you expose the appropriate ports (5601, 9200) and
set the `REDIS_HOST` environment variable. Here's an example run command:

```
sudo docker run -it --name elk \
-p 5601:5601 -p 9200:9200 \
-e REDIS_HOST=some-redis-host \
codenow-elk
```

## Ports
When run as a container the image exposes the following ports:

* 5601 - Kibana web interface
* 9200 - Elastic search interface

## Important Files

* `Dockerfile` - Dockerfile to build the ELK image
* `10-input.conf` - Default logstash input configuration
* `20-filter.conf` - Default logstash filters configuration
* `30-output.conf` - Default logstash output configuration
* `elasticsearch.yml` - Elastic search configuration
* `start.sh` - Runs all services and tails the elasticsearch logs.

## Environment Variables

Environment variables are not supported by default for logstash configurations
however we have added limited support for them by modifying the `start.sh`.
If you want to introduce a new variable to a configuration perform the following
steps:

1. Add the placeholder for the variable in the file. It will look like this:
`{{MY_VARIABLE}}`
2. Modify the `start.sh` script to add an in-place sed to replace the placeholder
with the environment variable:
`sed -i "s/{{MY_VARIABLE}}/$MY_VARIABLE/g" /etc/logstash/conf.d/01-logstash.conf`.

Currently we support the following environment variables in the logstash
configuration script:

* `REDIS_HOST` - Hostname for the redis message broker.
* `REDIS_PORT` - Port for the redis message broker.