Skip to content
Browse files

Added a new readme file based in Markdown syntax.

  • Loading branch information...
1 parent bb9f23e commit ab98d2dc3c8f69860d24a129aed628e81c269591 @misterdai committed May 23, 2012
Showing with 44 additions and 0 deletions.
  1. +44 −0 README.md
View
44 README.md
@@ -0,0 +1,44 @@
+# CFTracker
+
+## Introduction
+
+CFTracker is a CFML based application, designed to help monitor and investigate what's currently going on inside the CFML engine you're running. It'll expose internal information, track statistics, allow you to perform actions against items, run reports, generate alerts and more.
+
+## Features
+
+This list is not finalised, suggestions and comments are welcome:
+* Expose the following CFML engine aspects:
+ * Application instances (application.cfc / CFApplication)
+ * Session instances (Overall and per application)
+ * Query Cache
+ * Template Cache
+ * CFML threads
+* Expose information from the JVM and possibly Java Application server
+ * JVM information (memory, CPU usage etc...)
+ * Java threads.
+ * Any metrics provided by the Java Application Server (tomcat, JBoss, jetty)
+* Alerts
+ * Configurable rules setting limits against the various exposed information
+ * Different actions upon the alert being raised (hit URL, email, custom CFC)
+ * Alerts can be closed, linked, information provided, audited.
+* Auditing
+ * Tracking any setting changes against who and when.
+ * Optional logging of CFTracker users and what they are viewing or performing actions against.
+* Remote monitoring
+ * Hook into other CFTracker installations or base CFML Components (exposed as a secure web service).
+ * Provide as close as an experience compared to viewing local information as possible.
+
+## Requirements
+
+This version is currently in development. The initial focus will be a set of CFML Components that will provide support for the following engines:
+
+* Adobe ColdFusion 7, 8, 9, 10
+* OpenBD 2.x
+* Railo 3.3.x
+
+There will also be a CFML Web based application, built on top of these components. The current plan is to only support the following engines, with older engines being monitored remotely (using the set of CFML components mentioned above):
+
+* Adobe ColdFusion 9, 10
+* OpenBD 2.x
+* Railo 3.3.x
+

0 comments on commit ab98d2d

Please sign in to comment.
Something went wrong with that request. Please try again.