LogBox : Enterprise Logging & Messaging
2.x
2.x
  • Introduction
  • Intro
    • Introduction
      • What's New With 5.4.0
      • What's New With 5.3.0
      • What's New With 5.0.0
      • What's New With 2.1.0
      • What's New With 2.0.0
      • 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 Loggin Levels
      • Adding Categories Granularly
      • Configuring The Root Logger
  • Usage
    • Using LogBox
    • Using a Logger Object
      • Can Methods For Performance
      • $toString() and ExtraInfo Argument
    • 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
  • Parameters:
  • Examples

Was this helpful?

Edit on Git
Export as PDF
  1. Configuration
  2. Configuring LogBox

Adding Appenders

The first thing you need to do in your config object is add appenders. Each appender is added via the appender() method.

public void appender( string name, string class, [struct properties={},] [string layout,] [levelMin=0,] [levelMax=4] )

Parameters:

Name

Description

name

A unique name for the appender to register. Only unique names can be registered per instance.

class

The appender's class to register. We will create, init it and register it for you.

properties

The structure of properties to configure this appender with. (OPTIONAL)

layout

The layout class path to use in this appender for custom message rendering. (OPTIONAL)

levelMin

The numerical or English word of the minimal logging level (OPTIONAL, defaults to 0 [FATAL].)

levelMax

The numerical or English word of the maximum logging level (OPTIONAL, defaults to 4 [DEBUG].)

Examples

config.appender(
    name="CFConsole",
    class="coldbox.system.logging.appenders.ConsoleAppender"
);

config.appender(
    name="MyCF",
    class="coldbox.system.logging.appenders.CFAppender"
);

config.appender(
    name="SocketBaby",
    class="coldbox.system.logging.appenders.SocketAppender",
    properties={ host="localhost", port="444", timeout="3", persistConnection=false }
);

config.appender(
    name='Fileapp',
    class="coldbox.system.logging.appenders.FileAppender",
    properties={ filePath="/logs", fileName="Test" },
    layout="model.logging.MyFileLayout"
);
PreviousLogBox DSLNextAdding Categories to Specific Loggin Levels

Last updated 4 years ago

Was this helpful?