OpenFn / OpenFn/lightning

Don't show logs in the failure reports by default

Open
#2,663 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

Adding the logs of a failed run (step) to a failure alert email potentially poses a security risk or a breach of data protection agreements as sensitive information might be logged during the run.

We should make it configurable such that users can toggle adding logs to the failure alerts via the project settings page.

@josephjclark suggested that we reference the actual error in the email but do not show all the logs. In this case, turning on the logs in failure alerts option will now let all users see logs in the email.

When Add logs to failure alerts is enabled, we should show a warning to users saying "Logs may include sensitive information".

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 project settings page and follow the failure alert email flow to find where log inclusion is configured and rendered. Done means log inclusion is configurable, the warning "Logs may include sensitive information" appears when enabled, and the email behavior matches the selected setting.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
full-stack, security
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.