pub struct FileLoggerPlugin {
sink: BatchSink,
log_format: Option<HashMap<String, LogFormatValue>>,
include_req_body: bool,
include_resp_body: bool,
}Expand description
The file-logger plugin node.
Fields§
§sink: BatchSink§log_format: Option<HashMap<String, LogFormatValue>>§include_req_body: bool§include_resp_body: boolImplementations§
Source§impl FileLoggerPlugin
impl FileLoggerPlugin
Sourcepub fn from_config(config: &HashMap<String, Value>) -> Result<Self, String>
pub fn from_config(config: &HashMap<String, Value>) -> Result<Self, String>
Builds the plugin from node config.
Config keys:
path(string, required): target file path. Opened in append mode; created if absent, but its parent directory must already exist.log_format(object): customname -> "template"entry ({{namespace.path}}references plus legacy$varinterpolation).include_req_body/include_resp_body(bool, defaultfalse).- batch keys (optional) — see
BatchConfig::from_config. Usebatch_max_size: 1for immediate per-request writes.
- id: file-log
type: file-logger
config:
path: /var/log/featherbit/access.log
batch_max_size: 1Trait Implementations§
Source§impl Plugin for FileLoggerPlugin
impl Plugin for FileLoggerPlugin
Source§fn plugin_type(&self) -> &str
fn plugin_type(&self) -> &str
Source§fn reads_response_body(&self) -> bool
fn reads_response_body(&self) -> bool
Whether this configured instance reads
context.response.body. Read moreSource§fn execute<'life0, 'async_trait>(
&'life0 self,
ctx: Context,
) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn execute<'life0, 'async_trait>(
&'life0 self,
ctx: Context,
) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Executes the plugin logic against the request/response context. Read more
Source§fn cache_target(&self) -> Option<CacheTarget>
fn cache_target(&self) -> Option<CacheTarget>
The cache backend this node writes to, if it is a
proxy-cache half. Read moreAuto Trait Implementations§
impl Freeze for FileLoggerPlugin
impl RefUnwindSafe for FileLoggerPlugin
impl Send for FileLoggerPlugin
impl Sync for FileLoggerPlugin
impl Unpin for FileLoggerPlugin
impl UnsafeUnpin for FileLoggerPlugin
impl UnwindSafe for FileLoggerPlugin
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more