Graylog2/graylog2-server

Util to simplify execution of basic pivot search

Open

#20964 opened on Nov 15, 2024

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

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

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.
1-2 days
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.
mostly clear
Prerequisites
Basic Java knowledgeUnderstanding of Graylog pivot searchFamiliarity with existing aggregator classes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the existing classes mentioned in the issue: EventDefinitionAggregator, InputDiagnosticService, EventAssetRiskAggregator to understand the current pivot search implementation patterns. Look at how these classes build searches, extract values, and handle errors. The goal is to create a utility service that encapsulates these common patterns, accepting query and pivot field name as parameters. Check the comments in the issue (7 comments) for any additional guidance or maintainer suggestions. Files to explore: likely in the Java source code under packages related to search or pivot.