opensearch-project / opensearch-project/security-analytics

[FEATURE] Alerts API Enhancements

Open
#797 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
111
Forks
111
Avg merge
1d 17h
Merged PRs (30d)
13

Description

Is your feature request related to a problem?
The current challenge involves users being unable to view all alerts in the Alerts page when dealing with a large volume of generated data/Alerts. Despite the backend accurately producing all alerts, some are not visible in the UI. To remedy this, it is essential to implement proper pagination in the UI.

What solution would you like?
To alleviate the pagination challenge on the UI, a backend modification is proposed for the /alerts API. Currently, alerts are generated as per parameters such as detectorId, detectorType, severityLevel, alertState, table (Table params include: sortOrder, sortString, missing, size, startIndex, and searchString). To enhance efficiency, the suggestion is to adapt the backend to return all the alerts collectively. This modification would consolidate the data, allowing the frontend to implement pagination more effectively. With this approach, pagination efforts can be concentrated on the UI side, simplifying the user experience when navigating through extensive alerts.

What alternatives have you considered?
A clear and concise description of any alternative solutions or features you've considered.

Do you have any additional context?
Similar to Findings API enhancement -> #795

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the /alerts API and the Alerts page, comparing the existing detector, severity, state, table, and search parameters with the pagination behavior. Use issue #795 as the related reference. Done means the API and UI can expose and navigate the complete alert set without missing alerts when volumes are large.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend, frontend
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.