Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Security Solution][DQD] Historical results (Phase 1) #184158

Closed
8 tasks done
kapral18 opened this issue May 23, 2024 · 3 comments
Closed
8 tasks done

[Security Solution][DQD] Historical results (Phase 1) #184158

kapral18 opened this issue May 23, 2024 · 3 comments
Assignees
Labels
Feature:Data Health Quality Data health quality dashboard and related features Team:Threat Hunting:Explore Team:Threat Hunting Security Solution Threat Hunting Team v8.16.0

Comments

@kapral18
Copy link
Contributor

kapral18 commented May 23, 2024

Changes we are introducing in scope of Phase 1 DQD Historical results implementation agreed with @dhru42 :

UI Changes

DQD Checks ListView UI overhaul:

changes:

  • Check All Panel ui redesign (behavior of checkbox for "deprecated indices" will be clarified later)
  • Collapsible panels for index patterns
  • New action buttons for checking individual indexes (expand flyout + check)
  • Summary field tab is completely removed
  • Remaining field tabs are moved into Latest Check View Flyout Tab (see below)
  • Expand action icon opens Latest Check View Flyout Tab (see below) instead of opening nested panel like it is happening now
  • Refresh (check) icon triggers in-place checking of latest index result
  • The rest is the same (including pagination after 10 indexes per pattern)

image

(NEW) Latest Check View Flyout Tab:

use cases:

  • View latest check of a given index
  • Latest automatic check happening upon entering the tab
  • Manually check the index again via Check now button at the bottom
  • List field tabs the same way as before (uncluding count labels that are currently missing from the new design) (table features like sorting, pagination and search are still discussed in the new design)
  • Add telemetry tracking for check button

image

(NEW) Historical Checks View Flyout Tab:

use cases:

  • View list of historical results for given index
  • Trigger manual check with button at the bottom
  • Select range of historical results by creation date
  • Filter results by outcome status
  • No automatic check upon transition into the view
  • Paginate per 10 items (not in design yet).
  • Sort historical results in descending order ( latest - oldest )
  • tab specific actions are the same (copy to clipboard, add to new case)
  • add telemetry tracking for check button
  • add telemetry tracking click on historical view tab

image

Server / API Changes (Internal)

api changes:

  • GET /internal/ecs_data_quality_dashboard/results?pattern -> GET /internal/ecs_data_quality_dashboard/results_latest/:pattern

new api:

  • GET /internal/ecs_data_quality_dashboard/results/:pattern - fetches list of authorized indices results without aggregation.
    Supports new query params
    • from for pagination (ex. from=5)
    • size for doc size limiting (ex. size=2)
    • startDate and endDate for historical range selection (ex. startDate=now-1w/w&endDate=now-1d/d (inclusive))
    • outcome for filtering by presence of incompatibleFieldCount field (ex. outcome=pass or outcome=fail)

P. S.

All relevant tickets are or will be also added to the linked epic.

Tasks

Preview Give feedback
  1. 8.15 candidate Feature:Data Health Quality Team:Threat Hunting Team:Threat Hunting:Explore release_note:skip
    kapral18
  2. 8.15 candidate Feature:Data Health Quality Team:Threat Hunting Team:Threat Hunting:Explore
    kapral18
  3. 8.15 candidate Feature:Data Health Quality Team:Threat Hunting Team:Threat Hunting:Explore
    kapral18
  4. 8.15 candidate Team:Threat Hunting Team:Threat Hunting:Explore
    kapral18
  5. 8.15 candidate Feature:Data Health Quality Team:Threat Hunting Team:Threat Hunting:Explore
    kapral18
  6. 8.16 candidate Feature:Data Health Quality Team:Threat Hunting Team:Threat Hunting:Explore
    kapral18
  7. 8.16 candidate Feature:Data Health Quality Team:Threat Hunting Team:Threat Hunting:Explore
    kapral18
  8. 8.16 candidate Feature:Data Health Quality Team:Threat Hunting Team:Threat Hunting:Explore
    kapral18
@botelastic botelastic bot added the needs-team Issues missing a team label label May 23, 2024
@kapral18 kapral18 changed the title [META] DQD Historical results (Phase 1) [DRAFT][META] DQD Historical results (Phase 1) May 24, 2024
@kapral18 kapral18 changed the title [DRAFT][META] DQD Historical results (Phase 1) [META] DQD Historical results (Phase 1) May 24, 2024
@kapral18 kapral18 added non-issue Indicates to automation that a pull request should not appear in the release notes Team:Threat Hunting Security Solution Threat Hunting Team Team:Threat Hunting:Explore labels May 24, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-threat-hunting (Team:Threat Hunting)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-threat-hunting-explore (Team:Threat Hunting:Explore)

@botelastic botelastic bot removed the needs-team Issues missing a team label label May 24, 2024
@kapral18 kapral18 removed the non-issue Indicates to automation that a pull request should not appear in the release notes label May 24, 2024
@kapral18 kapral18 self-assigned this May 24, 2024
@kapral18 kapral18 changed the title [META] DQD Historical results (Phase 1) DQD Historical results (Phase 1) May 24, 2024
@kapral18 kapral18 changed the title DQD Historical results (Phase 1) [Security Solution][DQD] Historical results (Phase 1) May 24, 2024
@kapral18
Copy link
Contributor Author

kapral18 commented May 27, 2024

The internal api interface has been simplified, description has been updated

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Data Health Quality Data health quality dashboard and related features Team:Threat Hunting:Explore Team:Threat Hunting Security Solution Threat Hunting Team v8.16.0
Projects
None yet
Development

No branches or pull requests

2 participants