LogBox : Enterprise Logging & Messaging
7.x
7.x
  • Introduction
    • Contribution Guide
    • Release History
      • What's New With 7.2.0
      • What's New With 7.1.0
      • What's New With 7.0.0
    • Upgrading to LogBox 7
    • About This Book
      • Author
  • Getting Started
    • Features at a Glance
    • Installation
      • LogBox Refcard
    • Need For Logging
    • How Does LogBox Work?
      • LogBox
      • Appender
      • Logger
        • Logger Category Inheritance
        • Security Levels
        • Dynamic Appenders
      • Layout
  • Configuration
    • Configuring LogBox
      • LogBox DSL
      • Adding Appenders
      • Adding Categories to Specific Logging Levels
      • Adding Categories Granularly
      • Configuring The Root Logger
  • Usage
    • Using LogBox
    • Using a Logger Object
      • When To Log
      • ExtraInfo Serialization
    • Appender Properties
      • CFAppender
      • ConsoleAppender
      • DBAppender
      • EmailAppender
      • FileAppender
      • RollingFileAppender
      • ScopeAppender
      • SocketAppender
      • TraceAppender
    • LogBox in a ColdBox Application
      • Configuration Within ColdBox
      • Benefits of using LogBox in a ColdBox application
      • Where is LogBox stored in a ColdBox app?
      • LogBox from the ColdBox Proxy
      • The LogBox Injection DSL
  • Extending LogBox
    • Creating Custom Appenders
      • Helper Methods
      • Instance Members
      • Dealing With Custom Layouts
      • Registering Appenders at Runtime
    • Creating a Custom Layout
      • Instance Members
Powered by GitBook
On this page
  • Properties Methods
  • Utility Methods
  • Layout Methods

Was this helpful?

Edit on GitHub
Export as PDF
  1. Extending LogBox
  2. Creating Custom Appenders

Helper Methods

The abstract appender also has various cool methods that you can use when building appenders:

Properties Methods

Method

Description

struct getProperties()

Get the entire properties struct.

void setProperties(struct properties)

Override all properties with a new properties struct.

any getProperty(string property)

Get a property.

void setProperty(string property, any value)

Set a property.

boolean propertyExists(string property)

Checks if a property exists.

Utility Methods

Method

Description

boolean isInitialized()

Returns true if the appender has been initialized.

string getName()

Get the name of the appender

string getHash()

Get the appender's unique hash id

string severityToString(numeric severity)

Transforms a severity integer to it's human readable form

Layout Methods

Method

Description

any getCustomLayout()

Get the custom layout object if defined.

boolean hasCustomLayout()

Checks if the custom layout object is defined in this appender.

PreviousCreating Custom AppendersNextInstance Members

Last updated 2 years ago

Was this helpful?