OpenFn / OpenFn/lightning

Add a flag to stop sensitive state being logged

Open
#946 1 comment 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

This is a companion issue to https://github.com/OpenFn/kit/issues/314

We are adding support to the runtime to automatically obfuscate all objects sent to the logger. This is ideal for running sensitive, production jobs which include debug logs which we want to disable.

We need to work out how to drive this from the Lightning end. Basically Lightning needs to write a flag to the attempt/run (or, in the short term, the CLI) if this "sensitive logging" is to be enabled.

I am not sure what the UX of this is but it's probably something like:

  • Set a an option at the project level, which makes all workflows use sensitive logging. We might call it "log data" (and default it to on).
  • Maybe add an override per workflow. This could be a "Run in debug mode" button (which may later also set different flags).

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 with the Lightning CLI and the attempt/run path, then review how project-level settings, workflow overrides, and the Run in debug mode button are represented. Done means Lightning can set the sensitive-logging flag at the proposed project or workflow scope and pass it to the runtime, with the UX decision documented.

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
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.