telemetry 0.1.3

extern crate rustc_serialize;
use self::rustc_serialize::json::Json;

use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::mpsc::{channel, Sender};
use std::sync::Arc;
use std::thread;

use indexing::*;
use misc::{NamedStorage, SerializationFormat, Subset};
use task::{KeyedRawStorage, Op, PlainRawStorage, TelemetryTask};

///
/// The Telemetry service.
///
/// The service is in charge of maintaining the data recorded by the
/// histograms. Each application using telemetry needs one instance of
/// the service (or more, but this should seldom be necessary). The
/// data is stored and processed in a dedicated background thread and
/// the memory is recollected only when the service is dropped.
///
/// # Panics
///
/// The service will panic if an attempt is made to register two
/// histograms with the same key.
///
impl Service {
    ///
    /// Create a new instance of the service.
    ///
    /// This immediately launches the thread owning the data.
    ///
    /// If `is_active` is `false`, the service will immediately accept
    /// records. Otherwise, the service will only start recording once
    /// `set_active(true)` has been called.
    ///
    pub fn new(is_active: bool) -> Service {
        let (sender, receiver) = channel();
        thread::spawn(|| {
            let mut task = TelemetryTask::new(receiver);
            task.run()
        });
        Service {
            keys_plain: KeyGenerator::new(),
            keys_keyed: KeyGenerator::new(),
            sender,
            is_active: Arc::new(AtomicBool::new(is_active)),
        }
    }

    ///
    /// Serialize all histograms as json, in a given format.
    ///
    /// # Panics
    ///
    /// The service will panic if the sender is closed by the time serialization
    /// is complete.
    ///
    pub fn to_json(&self, what: Subset, format: SerializationFormat, sender: Sender<Json>) {
        self.sender
            .send(Op::Serialize(what, format, sender))
            .unwrap();
    }

    ///
    /// Make the service (in)active.
    ///
    /// Any data recorded on a histogram while the service is inactive will be ignored.
    ///
    pub fn set_active(&self, value: bool) {
        self.is_active.store(value, Ordering::Relaxed);
    }

    pub fn is_active(&self) -> bool {
        self.is_active.load(Ordering::Relaxed)
    }

    ///
    /// Register a plain histogram, returning a fresh key.
    ///
    fn register_plain(&self, name: String, storage: Box<dyn PlainRawStorage>) -> Key<Plain> {
        let key = self.keys_plain.next();
        let named = NamedStorage {
            name,
            contents: storage,
        };
        self.sender
            .send(Op::RegisterPlain(key.index, named))
            .unwrap();
        key
    }

    ///
    /// Register a keyed histogram, returning a fresh key.
    ///
    fn register_keyed<T>(&self, name: String, storage: Box<dyn KeyedRawStorage>) -> Key<Keyed<T>> {
        let key = self.keys_keyed.next();
        let named = NamedStorage {
            name,
            contents: storage,
        };
        self.sender
            .send(Op::RegisterKeyed(key.index, named))
            .unwrap();
        key
    }
}

/// Upon death of the service, terminate the thread and recollect all
/// owned memory.
impl Drop for Service {
    fn drop(&mut self) {
        let _ = self.sender.send(Op::Terminate);
    }
}

pub struct Service {
    /// A key generator for registration of new plain histograms. Uses
    /// atomic to avoid the use of &mut.
    keys_plain: KeyGenerator<Plain>,

    /// A key generator for registration of new keyed histograms. Uses
    /// atomic to avoid the use of &mut.
    keys_keyed: KeyGenerator<Map>,

    /// A shared boolean that may be turned on/off to (de)activate
    /// Telemetry.
    is_active: Arc<AtomicBool>,

    /// Connection to the thread holding all the storage of this
    /// instance of the service.
    sender: Sender<Op>,
}

// Backstage pass used inside the crate.
impl PrivateAccess {
    pub fn register_plain(
        service: &Service,
        name: String,
        storage: Box<dyn PlainRawStorage>,
    ) -> Key<Plain> {
        service.register_plain(name, storage)
    }

    pub fn register_keyed<T>(
        service: &Service,
        name: String,
        storage: Box<dyn KeyedRawStorage>,
    ) -> Key<Keyed<T>> {
        service.register_keyed(name, storage)
    }

    pub fn get_sender(service: &Service) -> &Sender<Op> {
        &service.sender
    }

    pub fn get_is_active(service: &Service) -> &Arc<AtomicBool> {
        &service.is_active
    }
}

pub struct PrivateAccess;