For the complete documentation index, see llms.txt. This page is also available as Markdown.

Metrics Functions

When the simulation is running, you may want to store some performance parameters for analysis. Normally, you would need to create a separate backend application that could store such metrics, however with a very large-scale dataset, this could become difficult. IoTIFY provides a simple and easy-to-use time-series database for this purpose via our Metrics API.

To create any custom metric, use the following function.

//requires a string key parameter and an optional value parameter as arguments
metric.add(key, ?value)

metric.add('latency', 55);
metric.add('count');          // Default value of 1 is taken

If no value is passed to the function, a default value of 1 is taken.

These metrics can be visualized and aggregated in the Metrics tab on the Sidebar. Metrics will also be available via APIs.

Last updated

Was this helpful?