> For the complete documentation index, see [llms.txt](https://docs.iotify.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iotify.io/additional-helpers/iotify-helpers/metrics-functions.md).

# 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.

```javascript
//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
```

{% hint style="info" %}
If no value is passed to the function, a default value of 1 is taken.
{% endhint %}

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.iotify.io/additional-helpers/iotify-helpers/metrics-functions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.