Graylog2/graylog2-server

When creating an input, have graylog show a note if the selected port is already in use

Open

#15953 opened on Jul 13, 2023

View on GitHub
 (4 comments) (1 reaction) (0 assignees)Java (6,945 stars) (1,032 forks)batch import
featuregood first issuetriaged

Description

What?

Its not uncommon to create multiple of the same input type. For example to more easily delineate logs from different sources our types of sources, one may have multiple syslog inputs. In doing this, the default port is populated in the port input box, and should the user forgot (or not be aware that they need to) change this, they input will fail to start and show an error (expected, thats ok and normal).

My thinking was that graylog already knows (via mongo) what inputs exist and can use this to help provide hints to users to save them some time and some trouble. Another way this can be useful is that once you are in the workflow of creating a new input, you can no longer use that page to see what ports are already in use. It would save time to be able to see "oh this port is in use let me choose another".

Crude mockup:

image

Why?

To help reduce friction for creating inputs and make this process more easy and more user frieindly.

Your Environment

  • Graylog Version: 5.1.3
  • OpenSearch Version: 2.8.0
  • MongoDB Version: 6.0.7
  • Operating System: Ubuntu Server 22.04 LTS
  • Browser version: Google Chrome Version 114.0.5735.198 (Official Build) (arm64)

Let me know if there are any questions!

Contributor guide

Tech stack
java
Domain
frontendbackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaGraylog input systemMongoDB
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the input creation workflow in the Graylog UI, likely in JavaScript/React files, and the backend service that handles input configuration. Look for how existing inputs are stored (MongoDB) and how to query for port usage. The mockup suggests a warning message near the port field. Review the code that validates input creation to implement a check before submission.