Codeboxes.Monitor Namespace Reference

The codeboxes monitor allows you to observe your app, including logging, performance, structures and even a console. More...

Namespaces
namespace	Interfaces

Classes
class	ImpactLevel
	This class is used at log, alert factories and console trace by the Monitor to determine the impact of the added message/information. It is just a value, simply combined with a description. Nothing special. Oh wait, there is more. Five default static readonly instances of this class are ready to be used. More...
class	ImpactTopic
	This class is used at log and alert factories by the Monitor to determine the impact topic of the added message/information. It is just a value, simply combined with a description. Nothing special. Oh wait, there is more. Four default static readonly instances of this class are ready to be used. But if you want you can create and use your own ones. More...
class	Logger
	This class can be used as a simple Logger. It provides the ImpactLevels as functions and takes the related source as a constructor argument. Best practice is, to use it as followed: More...
class	Monitor
	The Monitor gives you the option to monitor your application without the need to debug it. More...

Detailed Description

The codeboxes monitor allows you to observe your app, including logging, performance, structures and even a console.

So you are able to see whats happening, even when you are not debugging your app/client.

The monitor is split into two parts.
The first one is embedded into the base lib and contains the Monitor class and the used interfaces.
All other functionlities are packed into an own codeboxes monitor library. That means, you can always log your information, commit structures, update performances and add command to the console, even when the monitor lib is not part of your project.</p

The moment you add the monitor library to your project will give you many opportunities to observer your application and even what the other used codeboxes libraries are doing.

You can show different included UIs to watch the logs, structures, performances and call added commands. Just use the MonitorScreen class for that.

You can use the monitor as external app and connect to it. This will keep your app small and the "normal" users away from the monitor. Just use the MonitorConnector class for that.

The monitor can be used in so many different ways, you can set it up for exactly what you need. The MonitorSetup class will help you to set you monitor up. If you don't want to bother yourself with the complexity of the setup, then you can use the standard setup at the MonitorSetup. It has only a few functions and you need only to call one or two, to set your monitor up in a standardized way.

The most easy way is to use the SimpleStart functions of the MonitorScreen or MonitorConnector. They init and setup all in a very standarized way.

The monitors are split into parties and I recommend you to use the monitor with a party of your own. All codeboxes libraries are using the monitor with the codeboxes party, so it is divided from your own monitor stuff. Just add the name of your party, when you get a monitor instance.

The last functionality of the monitor I want to mention is the snapshot. For example: In case you are listening to uncaught errors and send them to your server, you can use the MonitorSnapshot to get a String with all information, collected by the monitor. It contains all logs (of a specified time slot if you want), the committed structures and the current performances. That information may help you to see what went wrong in that moment.

Please see the documentation of the mentioned classes itself for further information.