Graylog2/graylog2-server

Util to simplify execution of basic pivot search

Open

#20,964 opened on Nov 15, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Java (1,032 forks)batch import
featuregood first issueimprovementtriaged

Repository metrics

Stars
 (6,945 stars)
PR merge metrics
 (Avg merge 8d 19h) (297 merged PRs in 30d)

Description

What?

Create a utility service that simplifies execution of basic pivot searches in the backend. It would accept the variable parts of the search (query, pivot field name) and handle the details of building the search, extracting the values from the result rows, and handling errors.

Why?

  • When coding a search for the first time, it is difficult to know which classes to use and how
  • There are multiple instances of these searches in the code base. They are very similar to each other: EventDefinitionAggregator InputDiagnosticService EventAssetRiskAggregator

Your Environment

  • Graylog Version: 6.2

Contributor guide

Research direction
Study the existing similar classes (EventDefinitionAggregator, InputDiagnosticService, EventAssetRiskAggregator) and design a common utility to handle pivot searches, including building the search, extracting values, and error handling.
Tech stack
java
Domain
backend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Java
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60