LogBox : Enterprise Logging & Messaging
5.x
5.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
  • System Requirements
  • Manual Installation
  • CommandBox Installation
  • Namespaces
  • Useful Resources

Was this helpful?

Edit on Git
Export as PDF
  1. Getting Started

Installation

PreviousFeatures at a GlanceNextLogBox Refcard

Last updated 7 years ago

Was this helpful?

LogBox can be downloaded as a standalone framework or it is included with the latest ColdBox Platform release. The main difference between both versions is the instantiation and usage namespace, the rest is the same.

The best way to install LogBox is using CommandBox CLI and package manager.

System Requirements

  • ColdFusion 11+

  • Lucee 4.5+

Manual Installation

If you are using LogBox within a ColdBox application context, then LogBox is part of the platform. Just install ColdBox normally. If you are using LogBox standalone, just drop LogBox in your application root or create a mapping called logbox that points to the installation folder. If you can run the following snippet, then LogBox is installed correctly:

logbox = new logbox.system.logging.LogBox();

CommandBox Installation

You can leverage to install the standalone version of LogBox

# Latest CommandBox
box install logbox

# Bleeding Edge
box install logbox@be

Namespaces

Standalone

logbox.system.logging

ColdBox

coldbox.system.logging

Info In this book we will be using the standalone namespace for all examples.

Useful Resources

Download LogBox Standalone
API Docs
CommandBox
LogBox Docs Source
LogBox Planning Board
Log4J
LogStash