Struct RecordingScrubber

Source
pub struct RecordingScrubber<'a> { /* private fields */ }
Expand description

A utility that performs data scrubbing on compressed Replay recording payloads.

§Example

use relay_replays::recording::RecordingScrubber;
use relay_pii::PiiConfig;

// Obtain a PII config from the project state or create one on-demand.
let pii_config = PiiConfig::default();
let mut scrubber = RecordingScrubber::new(1_000_000, Some(&pii_config), None);

let payload = b"{}\n[]";
let result = scrubber.process_recording(payload.as_slice());

Implementations§

Source§

impl<'a> RecordingScrubber<'a>

Source

pub fn new( limit: usize, config1: Option<&'a PiiConfig>, config2: Option<&'a PiiConfig>, ) -> Self

Creates a new RecordingScrubber from PII configs.

limit controls the maximum size in bytes during decompression. This function returns an Err if decompressed contents exceed the limit. The two optional configs to be passed here are from data scrubbing settings and from the dedicated PII config.

§Performance

The passed PII configs are compiled by this constructor if their compiled version is not yet cached. This can be a CPU-intensive process and should be called from a blocking context.

Source

pub fn is_empty(&self) -> bool

Returns true if both configs are empty and no scrubbing would occur.

Source

pub fn process_recording( &mut self, bytes: &[u8], ) -> Result<Vec<u8>, ParseRecordingError>

Parses a replay recording payload and applies data scrubbers.

§Compression

The recording bytes passed to this function can be a raw recording payload or compressed with zlib. The result is always compressed, regardless of the input.

During decompression, the scrubber applies a limit. If the decompressed buffer exceeds the configured size, an Err is returned. This does not apply to decompressed payloads.

§Errors

This function requires a full recording payload including headers and body. This function will return errors if:

  • Headers or the body are missing.
  • Headers and the body are separated by exactly one UNIX newline (\n).
  • The payload size exceeds the configured limit of the scrubber after decompression.
  • On errors during decompression or JSON parsing.

Auto Trait Implementations§

§

impl<'a> Freeze for RecordingScrubber<'a>

§

impl<'a> !RefUnwindSafe for RecordingScrubber<'a>

§

impl<'a> !Send for RecordingScrubber<'a>

§

impl<'a> !Sync for RecordingScrubber<'a>

§

impl<'a> Unpin for RecordingScrubber<'a>

§

impl<'a> !UnwindSafe for RecordingScrubber<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T