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

Was this helpful?

Edit on GitHub
Export as PDF
  1. Getting Started

How Does LogBox Work?

PreviousNeed For LoggingNextLogBox

Last updated 1 year ago

Was this helpful?

LogBox has five main components:

  1. LogBox

    1. The central library that stores your loggers, appenders, categories, and configuration

  2. Logger

    1. The class in charge of sending messages to the appropriate destinations according to the category it has been defined with.

  3. Categories

    1. Each Logger is created with a unique category that usually maps to the classpath of the CFC that uses the logger.

  4. Appenders

    1. Components that receive log events and send them for storage in their implementations: files, consoles, etc.

  5. Layouts

    1. The appenders will send the messages to their destinations using a specified format. This is called the layout of the message. LogBox comes with default layouts, but you can build your own.

These components work in unison to deliver messages' logging and tracing and control how they are logged. You will primarily interact with the Logger component as it will send your statements to the Appenders you have configured. Users can extend LogBox and build custom appenders and layouts.