OpenFn / OpenFn/lightning

Enhance the Audit Page

Open
#2,678 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

Context

As part of recent efforts, we've significantly increased auditing in the app, which means a larger number of audit events are being logged. These include actions such as exporting work orders in the history table, syncing projects to GitHub, deleting credentials, and various others. Each of these actions generates an audit entry, displayed in a table format on the /settings/audit page. With more people now needing to access this page, it’s important to enhance the user experience, making it easier to navigate and understand the audit data.

Proposal

To improve usability and efficiency on the /settings/audit page, I propose implementing two changes:

  1. Filtering and Search Functionality
    Add filtering and search options to the audit page. For Filtering, users should be able to filter audit events by attributes such as event, actor, subject (workflow, credential, oauth-client, etc.), and timestamp. We should also allow users to search for the logs by these fields project names (for super user view), workflow IDs, metadata, and users.

PS: For project-level audits, there will be no filter for project ID as the list is already filtered by project ID.

  1. Redesign for Enhanced Readability
    Improve the layout to ensure that changes and metadata are more readable without occupying too much space. We've recently added a metadata column to the audit table, which holds additional details (e.g., search parameters applied when someone exports work orders). Similar to the history table, where users can expand to see detailed steps, consider an expandable row structure here as well. This would allow users to view detailed metadata only when needed, keeping the interface clean and organized.
Goal

These changes aim to create a user-friendly and intuitive /settings/audit page, accommodating the increased volume of audit data without overwhelming users.

Image

Contributor guide

No contributing guide indexed for this repository

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 at the /settings/audit page and compare its current table with the history table, especially the existing metadata column and expandable-row behavior. Define the event, actor, subject, timestamp, project, workflow, metadata, and user search/filter requirements, then verify that the page remains readable while supporting the proposed audit queries and expanded details.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.