AppenderDigest: Abstract class for digests (multi-log message notifications)

In s-fleck/lgrExtra: Extra Appenders for 'lgr'

Abstract class for digests (multi-log message notifications)

Description

Digests is an abstract class for report-like output that contain several log messages and a title; e.g. an E-mail containing the last 10 log messages before an error was encountered or a push notification.

Abstract classes, only exported for package developers.

Value

Abstract classes cannot be instantiated with ⁠$new()⁠ and therefore do not return anything. They are solely for developers that want to write their own extension to lgr.

Super classes

lgr::Filterable -> lgr::Appender -> lgr::AppenderMemory -> AppenderDigest

Active bindings

subject_layout

A lgr::Layout used to format the last lgr::LogEvent in this Appenders buffer when it is flushed. The result will be used as the subject of the digest (for example, the E-mail subject).

Methods

Public methods

• AppenderDigest$new()

• AppenderDigest$set_subject_layout()

Inherited methods

• lgr::Filterable$add_filter()
• lgr::Filterable$filter()
• lgr::Filterable$remove_filter()
• lgr::Filterable$set_filters()
• lgr::Appender$set_layout()
• lgr::Appender$set_threshold()
• lgr::AppenderMemory$append()
• lgr::AppenderMemory$clear()
• lgr::AppenderMemory$flush()
• lgr::AppenderMemory$format()
• lgr::AppenderMemory$set_buffer_size()
• lgr::AppenderMemory$set_flush_on_exit()
• lgr::AppenderMemory$set_flush_on_rotate()
• lgr::AppenderMemory$set_flush_threshold()
• lgr::AppenderMemory$set_should_flush()
• lgr::AppenderMemory$show()

---

Method new()

Usage

AppenderDigest$new(...)

---

Method set_subject_layout()

Usage

AppenderDigest$set_subject_layout(layout)

See Also

lgr::LayoutFormat, lgr::LayoutGlue

Other abstract classes: AppenderMail

Other Digest Appenders: AppenderMail, AppenderPushbullet, AppenderSendmail

s-fleck/lgrExtra documentation built on Sept. 4, 2024, 2:39 a.m.