# Introduction

![Your new best friend!](https://639975657-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkinv4fgugMReTxKWlgH5%2Fuploads%2Few939Gf5B2vYTvUTPUnl%2FCBDebugger500.png?alt=media\&token=f9830938-0899-45ef-aadd-aa94284da0e7)

## Welcome To The ColdBox Debugger Module

The ColdBox Debugger module is a lightweight performance monitor and profiling tool for ColdBox applications. It can generate a nice debugging panel on every rendered page or a dedicated visualizer to make your ColdBox application development nicer, more funner and greater! Yes, funner is a word!

<figure><img src="https://639975657-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkinv4fgugMReTxKWlgH5%2Fuploads%2FTujcSgXrmaHRsDSsPld1%2Fimage.png?alt=media&#x26;token=170a0cfa-da66-468f-98ab-bfc3aa93d55a" alt=""><figcaption><p>ColdBox Debugger</p></figcaption></figure>

<figure><img src="https://639975657-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fkinv4fgugMReTxKWlgH5%2Fuploads%2FwiYG8eB1HPJJfoKcM8fO%2Fimage.png?alt=media&#x26;token=586f700a-e5dc-426b-b126-ea3dde8c7381" alt=""><figcaption><p>Request Inspector</p></figcaption></figure>

### Capabilities

The ColdBox Debugger tracks your requests, whether Ajax, traditional, or REST, its environment, execution, etc. Here is a listing of some of the capabilities you get with the ColdBox Debugger:

* Track all incoming requests to your applications
* Track exceptions and execution environment
* Track incoming HTTP requests, parameters, body, and much more
* Track final request collections
* Track Hibernate and `cborm` queries, criteria queries, and session stats
* Track `qb` and `quick` queries, entities, and stats
* Tap into LogBox via our Tracer messages and discover logging on a per-request basis
* Profile execution and results of **ANY** model object
* Profile execution of **ANY** ColdBox interception point
* Custom Timer helpers for adding timing methods and annotations anywhere in your code
* Profile your production or development apps with ease
* Track ColdBox modules and lifecycles
* Track Hyper HTTP/S calls
* Track Adobe ColdFusion Queries (ColdFusion 2018+)
* Track Lucee Queries

### System Requirements

* Lucee 5+
* ColdFusion 2018+
* ColdBox 6+

## Versioning <a href="#versioning" id="versioning"></a>

ColdBox Debugger is maintained under the [Semantic Versioning](http://semver.org) guidelines as much as possible. Releases will be numbered in the following format:

```
<major>.<minor>.<patch>
```

And constructed with the following guidelines:

* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bump the patch

## License <a href="#license" id="license"></a>

Apache 2 License: [http://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)​

### Important Links

* Source: <https://github.com/coldbox-modules/cbdebugger>
* ForgeBox: <https://www.forgebox.io/view/cbdebugger>
* Community: <https://community.ortussolutions.com/c/box-modules/cbdebugger/38>
* Issues: <https://ortussolutions.atlassian.net/browse/CBDEBUGGER>
* Changelog: <https://github.com/coldbox-modules/cbdebugger/blob/development/changelog.md>

## Professional Open Source <a href="#professional-open-source" id="professional-open-source"></a>

![www.ortussolutions.com](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LA-UVvG0NM7NpDzssBL%2F-LA-Uaei0WzTH7Su5CR7%2F-LA-UqN1BRXynZ7RUVO7%2Fortussolutions_button.png?generation=1523647999385555\&alt=media)

This module is professional open-source software backed by [Ortus Solutions, Corp](http://www.ortussolutions.com/services) offering services like:

* Custom Development
* Professional Support & Mentoring
* Training
* Server Tuning
* Security Hardening
* Code Reviews
* [Much More](http://www.ortussolutions.com/services)

## HONOR GOES TO GOD ABOVE ALL <a href="#honor-goes-to-god-above-all" id="honor-goes-to-god-above-all"></a>

Because of His grace, this project exists. If you don't like this, then don't read it, it's not for you.

> "Therefore being justified by **faith**, we have peace with God through our Lord Jesus Christ: By whom also we have access by **faith** into this **grace** wherein we stand, and rejoice in hope of the glory of God." Romans 5:5

## ​ <a href="#important-links" id="important-links"></a>
