Add a visual indication to show that a streaming audit event destination has filters applied

Release notes

Problem to solve

Users will add filters to their streaming audit destinations using the API, but it is not immediately clear in the UI which destinations have a set of filters applied and which do not. This means that users might unknowingly be using a filtered destination when they do not wish to and be losing events.

Design

Add a visual indicator (badge) that signifies "this destination has one or more event filters applied to it."

Filtering

The ability to act on and change the filters in the UI will be handled in other issues, such as this one.

Concept diagram image

Intended users

  • Cameron (Compliance Manager)

Feature Usage Metrics

Implementation plan

  1. Update get_external_destinations.query.graphql to also fetch the filter status.
    • ❗ field not implemented yet #344845 (closed)
  2. Add a warning variant GlBadge to stream/stream_item.vue if a destination is filtered.
    • Note: Badge contents should start with a warning icon.
    • Note: Make sure the badge has a tabindex, else the tooltip won't show for keyboard users.
  3. Add a tooltip to the warning badge badge.
  4. Update specs.
  5. Update documentation if needed.

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.

Edited Nov 24, 2022 by Nate Rosandich
Assignee Loading
Time tracking Loading