Struct highlightio::Highlight

pub struct Highlight(/* private fields */);

Implementations

impl Highlight

pub fn init(config: HighlightConfig) -> Result<Highlight, HighlightError>

Initialize Highlight.

pub fn capture_error_with_session( &self, err: &dyn Error, session_id: Option<String>, request_id: Option<String> )

Capture an error with session info

Like Highlight::capture_error, but also lets you provide your session_id and request_id

pub fn capture_error(&self, err: &dyn Error)

Capture an error

Explicitly captures any type with trait Error and sends it to Highlight.

pub fn span(&self, name: impl Into<Cow<'static, str>>) -> Span

Create a span

Creates a span for tracing. You can end it with span.end() by importing highlightio::SpanTrait.

pub fn project_id(&self) -> String

Returns the project ID.

pub fn shutdown(self)

Shuts down the Highlight logger and tracer. This allows for the logs and traces to flush while the runtime is still around. If this method is not called, logs and traces that happened right before your app exits will not be transmitted to Highlight.

Trait Implementations

impl Clone for Highlight

fn clone(&self) -> Highlight

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Log for Highlight

fn enabled(&self, _metadata: &Metadata<'_>) -> bool

Determines if a log message with the specified metadata would be logged.

fn log(&self, record: &Record<'_>)

Logs the Record.

fn flush(&self)

Flushes any buffered records.