elastic / elastic/logstash

Add API for retrieving the configuration

Open
#5,288 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
14.9k
Forks
3.5k
Avg merge
1d 4h
Merged PRs (30d)
88

Description

To aid in troubleshooting, it is almost always useful to be able to read the pipeline configuration of the troubled Logstash. However, accurately gathering this is often problematic because, when asked, users often only provide a subset of their whole configuration. To remedy this problem, it would be useful to be able to have a script gather the configuration from Logstash directly.

However, given that the configuration often has sensitive or secret data (credentials, etc), it would be bad if we exposed the _content_ of the configuration in an insecure way.

Adding security to the Logstash API is a good idea, but out of scope for this ticket.

Until we have a secure API, we can maybe satisfy this by the following ...
## Proposal

Add a new REST endpoint that lists the file paths that were loaded for the current configuration. A script run on the Logstash server could query this API and pack up the these listed files for delivery for support purposes.

Contributor guide

Open the contributing guide

Research direction

Start by locating Logstash's existing REST API entry points and the configuration-loading code, then check how loaded file paths are retained. Define the endpoint response and add coverage for listing paths without exposing configuration contents; the issue provides no file or test names, so repository research is required.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.