Modular Output System

The Modular Output System is designed to help you get your output information to where you need it.

The system is primarily designed around transmitting key-value information (ie. a point with both a name and a value) and event logs to the destination(s) of your choice.

The modular output system is found in ModelHost, Agency, Trigger and ARDIs internal alert management system, but can also be used in other projects.

Each app that supports the Modular Output System includes an output configuration file (usually called 'output.json', which is a JSON-encoded file that provides instructions on where output data should be sent.

The file looks like the example below…

[
   { 
      "type": "value_or_event",
      "method": "methodname",
      "paramername": "parametervalue" 
   }
]

Each object indicates a single method of processing your output.

A method normally indicates a particular protocol, such as sending data to MySQL or the Prometheus time-series database.

Some of these methods will need additional parameters - for instance, you'll need the database name, table name, host and user credentials if you're sending data to a relational database like Microsoft SQL Server.

Below you'll find the pre-made output methods that are included with ARDI.

The examples given show the options available for the specific method. There are also some common options for output modules that can be set.

Output Methods for Key-Value Data
Output Methods for Event Data

You can also use the system in your own projects.