1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
use crate::export::logs::{LogData, LogExporter};
use async_trait::async_trait;
use opentelemetry::logs::{LogError, LogResult};
use std::sync::{Arc, Mutex};
/// An in-memory logs exporter that stores logs data in memory..
///
/// This exporter is useful for testing and debugging purposes.
/// It stores logs in a `Vec<LogData>`. Logs can be retrieved using
/// `get_emitted_logs` method.
///
/// # Example
/// ```no_run
///# use opentelemetry_sdk::logs::{BatchLogProcessor, LoggerProvider};
///# use opentelemetry_sdk::runtime;
///# use opentelemetry_sdk::testing::logs::InMemoryLogsExporter;
///
///# #[tokio::main]
///# async fn main() {
/// // Create an InMemoryLogsExporter
/// let exporter: InMemoryLogsExporter = InMemoryLogsExporter::default();
/// //Create a LoggerProvider and register the exporter
/// let logger_provider = LoggerProvider::builder()
/// .with_log_processor(BatchLogProcessor::builder(exporter.clone(), runtime::Tokio).build())
/// .build();
/// // Setup Log Appenders and emit logs. (Not shown here)
/// logger_provider.force_flush();
/// let emitted_logs = exporter.get_emitted_logs().unwrap();
/// for log in emitted_logs {
/// println!("{:?}", log);
/// }
///# }
/// ```
///
#[derive(Clone, Debug)]
pub struct InMemoryLogsExporter {
logs: Arc<Mutex<Vec<LogData>>>,
}
impl Default for InMemoryLogsExporter {
fn default() -> Self {
InMemoryLogsExporterBuilder::new().build()
}
}
///Builder for ['InMemoryLogsExporter'].
/// # Example
///
/// ```no_run
///# use opentelemetry_sdk::testing::logs::{InMemoryLogsExporter, InMemoryLogsExporterBuilder};
///# use opentelemetry_sdk::logs::{BatchLogProcessor, LoggerProvider};
///# use opentelemetry_sdk::runtime;
///
///# #[tokio::main]
///# async fn main() {
/// //Create an InMemoryLogsExporter
/// let exporter: InMemoryLogsExporter = InMemoryLogsExporterBuilder::default().build();
/// //Create a LoggerProvider and register the exporter
/// let logger_provider = LoggerProvider::builder()
/// .with_log_processor(BatchLogProcessor::builder(exporter.clone(), runtime::Tokio).build())
/// .build();
/// // Setup Log Appenders and emit logs. (Not shown here)
/// logger_provider.force_flush();
/// let emitted_logs = exporter.get_emitted_logs().unwrap();
/// for log in emitted_logs {
/// println!("{:?}", log);
/// }
///# }
///
/// ```
///
#[derive(Debug, Clone)]
pub struct InMemoryLogsExporterBuilder {}
impl Default for InMemoryLogsExporterBuilder {
fn default() -> Self {
Self::new()
}
}
impl InMemoryLogsExporterBuilder {
/// Creates a new instance of `InMemoryLogsExporter`.
///
pub fn new() -> Self {
Self {}
}
/// Creates a new instance of `InMemoryLogsExporter`.
///
pub fn build(&self) -> InMemoryLogsExporter {
InMemoryLogsExporter {
logs: Arc::new(Mutex::new(Vec::new())),
}
}
}
impl InMemoryLogsExporter {
/// Returns the logs emitted via Logger as a vector of `LogData`.
///
/// # Example
///
/// ```
/// use opentelemetry_sdk::testing::logs::{InMemoryLogsExporter, InMemoryLogsExporterBuilder};
///
/// let exporter = InMemoryLogsExporterBuilder::default().build();
/// let emitted_logs = exporter.get_emitted_logs().unwrap();
/// ```
///
pub fn get_emitted_logs(&self) -> LogResult<Vec<LogData>> {
self.logs
.lock()
.map(|logs_guard| logs_guard.iter().cloned().collect())
.map_err(LogError::from)
}
/// Clears the internal (in-memory) storage of logs.
///
/// # Example
///
/// ```
/// use opentelemetry_sdk::testing::logs::{InMemoryLogsExporter, InMemoryLogsExporterBuilder};
///
/// let exporter = InMemoryLogsExporterBuilder::default().build();
/// exporter.reset();
/// ```
///
pub fn reset(&self) {
let _ = self
.logs
.lock()
.map(|mut logs_guard| logs_guard.clear())
.map_err(LogError::from);
}
}
#[async_trait]
impl LogExporter for InMemoryLogsExporter {
async fn export(&mut self, batch: Vec<LogData>) -> LogResult<()> {
self.logs
.lock()
.map(|mut logs_guard| logs_guard.append(&mut batch.clone()))
.map_err(LogError::from)
}
fn shutdown(&mut self) {
self.reset();
}
}