Skip to content

epacke/logstash-pipeline-tester

Repository files navigation

About

This started out as a way to make it easy to test the logstash configuration for people without much linux know-how (and from my own frustration with how hard it was). Then it kind of grew into an interface, and here we are.

It's written fast and the code could use a bit of additional love, but it works fine.

How to start

Documentation on how to get going is available here: https://loadbalancing.se/2020/03/11/logstash-pipeline-tester/

There's also a video of how to get started here: https://youtu.be/Q3IQeXWoqLQ

Article is dated 2020 but is continously updated whenever there is need to do so.

Contribute

I gladly accept pull requests. If you have a pipeline you'd like to share/contribute that'd be great too. If you don't know how to do forking and pull requests I can handle that part, just let me know via an issue or dig up my contact details here.

Contributing to the application (express/React)

If you want to to develop the application you'll need a local development environment on your client. Follow these steps to get started:

  1. Find the IP of your machine with ie ifconfig or ip addr

  2. Run export BACKEND_IP=192.168.1.10 where 192.168.1.10 is your main IP if the client

  3. Start logstash with BACKEND_ENDPOINT=http://${BACKEND_IP}:8080/api/v1/receiveLogstashOutput docker compose up logstash

    Note that some flavors uses docker compose instead of docker-compose

  4. In another terminal, start backend with cd pipeline-ui/backend; npm run dev

  5. In yet another terminal, start frontend with cd pipeline-ui/frontend

Now you can update the code freely and both backend and frontend should refresh automatically.

Reporting issues

First, please check if there's any current issues that matches your problem. If not, please feel free to submit an issue here at Github.

I have very limited time so I won't be able to act fast on any issue but it's always good to have it logged and who knows, maybe someone else will pick it up and make a PR.

Application component diagram

Screenshots

Credits

  • F5 Example pipeline copied (and slightly modified) from here

Icons/media

https://www.svgrepo.com/svg/289194/log-wood Wood Logs Vectors by Vecteezy

Great tool for cleaning up SVGs

https://iconly.io/tools/svg-cleaner