> ## Documentation Index
> Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Monitoring

You can monitor various aspects of your customer's contract and usage.

## Add a monitor

1. Click on **Monitoring** in the left sidebar.
2. Click on the **ADD MONITOR** button.
3. Fill in the following details:

* **Monitor name**: a descriptive name for the monitor.
* **Monitor description**: add a description for the monitor.
* **Monitor source**: choose from **Contract** and **Usage Aggregate**.

<Image align="center" className="border" border={true} src="https://files.readme.io/09863683b1f786ccfd8c0ad28b1bb0044c6957fb71ffd470faa277414fbdc0c8-image.png" />

### Select contract

1. Click on the **Select Contract** dropdown.
2. Select the contract you would like to add monitors for.

The example contract, **A Simple Contract**, has only one flat-fee based product.

<Image align="center" className="border" border={true} src="https://files.readme.io/ee3c8baeb4cad9648417c0e290db4ff76aabef9f2a347be660885f0ba84c0a3e-image.png" />

3. Click on the newly added **Select Item** dropdown.

<Image align="center" className="border" border={true} src="https://files.readme.io/2e540e9dc78db40cf985b7a42d418d17e3cf1807e32904f45f3c7bc572631c69-image.png" />

4. Select itmes:

* You can add monitors for various aspects of the billing period, such as:
  * `end_date`: end date of the billing period.
  * `start_date`: start date of the billing period.
  * `cycle_length`: how many days/weeks/months/years does a billing cycle last.
  * `cycle_unit`: unit of the cycle (day/week/month/year).
  * `cycle_start_date`: start date of the billing cycle.
  * `contract_start_date`: start date of the contract.
* You can add monitors for various aspects of a product. The aspects are dependent on the product.
  * For example, for a flat-fee-based product, `amount`, `billed_amount`, and `billed_days` can be selected.
  * For example, for a volume-pricing-based product, only `amount` can be monitored.

<Image align="center" className="border" border={true} src="https://files.readme.io/3177799839fc71d0968b6d19cf41eed4ff724f853199eebaaba88f21906883cc-image.png" />

<Image align="center" className="border" border={true} src="https://files.readme.io/0c0ee430d94281fa5ce990e31842e882eefe9ba920017bc63fbc1ca3d4e1338f-image.png" />

* You can add a monitor for invoice by selecting `invoice_total`.

### Select usage aggregate

> 🚧 Coming soon

## View a monitor

1. Click on **Monitoring** in the left sidebar.
2. All available monitors will be listed on the **Monitoring** page.

<Image align="center" className="border" border={true} src="https://files.readme.io/9f20c517dea931b6ff78058ee1d416d31c8afc9e56a089d482f82ed0bc90e3c4-image.png" />

3. Click on the monitor you are interested in.
4. A panel will appear on the right side. Select the following parameters to view the monitor:

* **Customer**: select the customer.
* **Select date**: select the date for which you want to view the monitor.
* **Net or increment**: The net value of the monitor or the increment compared to the previous day.

<Image align="center" src="https://files.readme.io/7025f128be81aeef8ace441f71188fea2467b70f08f077cdf989da6a27c62a15-Screenshot_from_2024-09-16_15-38-47.png" />
