Skip to content

API endpoint to retrieve all audit events under a given group

Problem to solve

Users today wish to retrieve all Audit Events from their Gitlab groups and child projects. This currently requires them to iterate through each project and subgroup and call the specific API. This is a lot of extra steps for groups that have multiple sub-groups and projects. It also means audit event replies come in at different times depending on when the API call started. It also may put a large load on the GitLab system to do all these requests at once.

Proposal

Provide an API to retrieve all audit events for a given group. It should return:

  1. Audit events relevant to that group itself
  2. Audit events for any subgroups in that group
  3. Audit events for any projects in that group or its subgroups.

Please see here for previous state of this feature #337757 (comment 1429950717). From there here are potential follow up solutions:

  1. API that triggers background job, that then generates a report
    1. issue: how to deliver report as it will likely be over the limit for an email attachment
  2. API where clients provide us an endpoint to push the results to
    1. allows us to generate the payload asynchronously
    2. issue: requires work for customers to provide and secure an endpoint
  3. An API pass-through
    1. customers query one API, and we then query the relevant group and projects APIs for them
    2. issue: pagination, ordering, and timeouts might all be issues
  4. ???

Performance

This API will return a large amount of data potentially. As such, we must consider the impact on performance. Some things to consider:

  1. Can we deliver results with pagination?
  2. Can we do some sort of "async" response?
  3. Do we have opportunities to improve performance by combining queries rather than using many, smaller queries?

More details

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 by Nate Rosandich