Crate tracing_facade

A facade for tracing.

This crate provides a pluggable API for tracing, akin to what [log] does for logging.

Some available implementations are:

• [tracing_chromium] - to emit Chromium's trace event format

Example

#[macro_use]
extern crate tracing_facade;

#[macro_use]
extern crate serde_json;

use std::borrow::Cow;
use std::sync::{Arc, Mutex};

#[derive(Clone, Debug)]
struct Event {
  name: String,
  kind: tracing_facade::EventKind,
  metadata: tracing_facade::Metadata,
}

impl<'a> From<tracing_facade::Event<'a>> for Event {
  fn from(event: tracing_facade::Event) -> Self {
    Event {
      name: event.name.into_owned(),
      kind: event.kind,
      metadata: event.metadata,
    }
  }
}

struct Tracer {
  events: Arc<Mutex<Vec<Event>>>
}

impl Tracer {
  fn new() -> (Tracer, Arc<Mutex<Vec<Event>>>) {
    let vec = Arc::new(Mutex::new(Vec::new()));
    let tracer = Tracer {
      events: Arc::clone(&vec)
    };
    (tracer, vec)
  }
}


impl tracing_facade::Tracer for Tracer {
  fn supports_metadata(&self) -> bool {
    true
  }

  fn record_event(&self, event: tracing_facade::Event) {
    self.events.lock().unwrap().push(event.into());
  }

  fn flush(&self) {}
}

fn main() {
  let (tracer, tracer_events) = Tracer::new();
  tracing_facade::set_boxed_tracer(Box::new(tracer));
  {
    trace_scoped!("foo");
    trace_begin!("bar", "value": 42);
    trace_end!("bar");
  }

  let events = tracer_events.lock().unwrap().clone();
  assert_eq!(events.len(), 4);
  assert_eq!(events[0].name, "foo");
  assert_eq!(events[0].kind, tracing_facade::EventKind::SyncBegin);
  assert_eq!(events[0].metadata.as_json(), None);

  assert_eq!(events[1].name, "bar");
  assert_eq!(events[1].kind, tracing_facade::EventKind::SyncBegin);
  assert_eq!(events[1].metadata.as_json(), Some(&json!({"value": 42})));

  assert_eq!(events[2].name, "bar");
  assert_eq!(events[2].kind, tracing_facade::EventKind::SyncEnd);
  assert_eq!(events[2].metadata.as_json(), None);

  assert_eq!(events[3].name, "foo");
  assert_eq!(events[3].kind, tracing_facade::EventKind::SyncEnd);
  assert_eq!(events[3].metadata.as_json(), None);
}

Macros

trace_begin	Records the end of a synchronous duration.
trace_end	Records the end of a synchronous duration.
trace_scoped	Traces in a given scope.

Structs

Event	An event to trace.
Metadata	A struct containing metadata for an event.

Enums

Error
EventKind	An enum representing the types of Events that can occur.

Traits

Tracer

A trait encompassing the operations required for tracing.

Functions

flush	Flushes the installed Tracer.
is_enabled	Determines whether a Tracer has been installed, and if it is currently enabled.
record_event	Records an Event to the installed Tracer.
set_boxed_tracer	Installs a Tracer contained in a Box.
set_tracer	Installs a Tracer.
supports_metadata	Determines whether a Tracer has been installed, and if it supports metadata.