Skip to content
PrefactorPrefactorPrefactor Docs

Reveal or discard sensitive data

Values your integration marks as sensitive are redacted when you look at a run. Reveal them when you need to read what the agent actually handled, and discard them once a span’s values shouldn’t be kept any longer.

By the end you’ll have read a span’s sensitive values, and, if you choose to, deleted them for good while keeping the record that they were there.

Before you start

Section titled “Before you start”
  • Your integration marks sensitive values with the sensitive encoding. Prefactor doesn’t detect sensitive data on its own; see Sensitive data.
  • To discard values, your admin user has the Full access role. Revealing works for any role.

Open the span

Section titled “Open the span”

  1. Go to Agents and select View details on the agent’s card.

    The Agent page opens.

  2. Select the History tab.

    Every run of the agent is listed, newest first.

  3. Select View on the run’s row.

    The Agent instance page opens on the Activity tab. If the run’s own input, result, or metadata hold sensitive values, the strip at the top has a Show sensitive information for this instance checkbox.

  4. Select the span you want to read.

    The span detail panel opens. Each sensitive value in Payload and Result payload shows as a placeholder labelled with its data categories, and the top of the panel has a Show sensitive information checkbox and a Discard sensitive button.

Reveal the values

Section titled “Reveal the values”

  1. Tick Show sensitive information.

    The placeholders are replaced by the real values. They stay visible as you step through the run’s spans, and are hidden again when you switch tabs or leave the page. Show sensitive information for this instance in the strip at the top is the same switch. To read the run’s own input, result, and metadata, select the Details tab and tick it there.

Discard the values

Section titled “Discard the values”

  1. With the values showing, select Discard sensitive.

    The Discard sensitive data dialog opens and explains what will be removed.

  1. Select Discard sensitive data to confirm.

    The dialog closes, Prefactor shows Sensitive data discarded for this span, and the values are hidden again.

Discard works one span at a time in the web app. Repeat steps 4 to 7 for each span whose values you want gone.

Verify

Section titled “Verify”

Tick Show sensitive information again on the same span. The placeholders stay in place of the values, and Discard sensitive stays disabled; hovering it shows There is no sensitive information to discard.

If it didn’t work

Section titled “If it didn’t work”
  • There’s no Show sensitive information checkbox. The span holds no marked values. If you expected some, check that your integration wraps them with the sensitive encoding.
  • Discard sensitive is disabled. Hover it for the reason. Sensitive information is not currently being shown means you need to tick Show sensitive information first. There is no sensitive information to discard means the values were already discarded.
  • Discarding fails with a permission error. Your admin user is Read only. Ask someone with Full access to discard the values, or to change your role on the Account › Admin users tab.
  • A judge’s run shows the values unredacted. Judges receive the real values, and a judge’s run records what it was sent as ordinary content. See Sensitive data.

Other ways to do this

Section titled “Other ways to do this”

The API discards one span’s values with POST /api/v1/agent_spans/{agent_span_id}/discard_sensitive. To discard the sensitive values in a run’s input, result, and metadata, which the web app can’t do, use POST /api/v1/agent_instance/{agent_instance_id}/discard_sensitive.

Section titled “Related”