Skip to content

Repository files navigation

LogstashUI

A control plane and visual editor for Logstash, built for managing Logstash nodes and authoring, simulating, and deploying pipelines.

⚠️ Beta Release - This project is under active development. Features may change.

Current package version: 0.5.1 — see CHANGELOG.md. Pair with LogstashAgent 0.5.1. Operator guide: agent roles / ports / coexistence / VERSION.

Overview

LogstashUI provides a visual interface for designing, testing, and operating Logstash pipelines.

Instead of editing configuration files manually, pipelines can be authored visually, simulated against sample events, and deployed to multiple Logstash nodes from a single interface.

Features

Control Plane for Logstash — Centrally manage Logstash nodes with Centralized Pipeline Management and Logstash Agent

Control Plane for Logstash

Visual Pipeline Editor — Author pipelines in three modes: an inline graphical interface, raw text editor, and a full visual graph for building pipelines by connecting nodes. Switch between modes seamlessly on any pipeline.

Visual Pipeline Editor

Pipeline Simulation — Execute pipelines against sample events and inspect transformations step-by-step

Pipeline Simulation

Monitoring — View metrics and performance for running pipelines and Logstash nodes

Pipeline Monitoring

SNMP Pipeline Management — Configure polling, traps, discovery, credentials, devices, networks, and profiles through the UI.

SNMP Support


Documentation


Requirements

System Requirements

Minimum:

  • 8 GB RAM
  • 4 CPU Cores

Why these requirements?

LogstashUI can run on smaller instances for light usage, especially when only using the editor or basic configuration workflows. The minimum requirements above are intended to provide a reliable baseline for common usage and heavier operations like pipeline simulation and multiple instances of Logstash Agent.

If you choose to run LogstashUI with fewer resources, it will likely work fine, but performance can vary depending on the operation. If the UI feels slow, simulations take too long, or agent operations appear delayed, increase CPU and memory before troubleshooting further.

How to Deploy

The Deployment Guide covers the ways you can deploy LogstashUI — the standard Docker install, host-backed simulation, and running from source.

If you have internet access and can use Docker and GitHub, the standard install is below in the Quick Start section.


Quick Start - Embedded Mode

Tip

For heavy simulation, prefer enrolled simulate agents (isolated simulate-N instances). start_logstashui.sh --legacy-host-agent is a legacy local path.

Download LogstashUI

git clone https://github.com/elastic/LogstashUI.git
cd LogstashUI/bin

Run LogstashUI

Linux

./start_logstashui.sh

Windows

start_logstashui.bat

Once the containers are running, navigate to your host in your browser:

https://<your_server_ip_or_hostname>

And that's it!


Add Your First Connection

1. Create an initial user

2. Add a connection

3. Start managing pipelines!

Optional: Add monitoring to your connections:

Use this guide to set up the Elastic Agent's Logstash integration. Once Logstash monitoring data is indexed into Elasticsearch, metrics and logs will appear in the UI.

Updating

LogstashUI will notify you when a new version is available via a banner in the navigation sidebar:

To update LogstashUI to the latest version:

Warning

--update switches the repository to the main branch before pulling the latest code and images.

Linux

cd LogstashUI/bin
./start_logstashui.sh --update

Windows

cd LogstashUI\bin
start_logstashui.bat --update

Limitations

  • Comments inside plugin blocks (inline and standalone) are preserved through parsing and serialization, but their exact position relative to config keys is not guaranteed. All comments are grouped at the top of the plugin block in the output.
input {
    udp { # inline comments are moved
        port => 5119 # inline comments are moved
    }
}

Becomes:

input {
    udp {
        # inline comments are moved
        # inline comments are moved
        port => 5119
    }
}

Reporting Issues

Found a bug or have a feature request? Open an issue.

Contributing

Contributions are welcome!

Please open an issue to discuss large changes before submitting a pull request.

License

Copyright 2024–2026 Elasticsearch and contributors.

Licensed under the Elastic License 2.0 (ELv2). See LICENSE for details.

About

A control plane and visual pipeline editor for Logstash

Topics

Resources

Contributing

Security policy

Stars

30 stars

Watchers

3 watching

Forks

Releases

Used by

Contributors

Languages