Fortinet Document Library

Version:


Table of Contents

User Guide

21.4.0
Copy Link

Custom metric management

FortiMonitor enables you to publish custom metrics in a variety of formats across our supported platforms. As well, you can manage the meta-data for your custom metrics once they've been reported to FortiMonitor - including name, category, unit, and type. This metadata is used throughout FortiMonitor - in graphs, incident alerts, threshold configuration, reports, and more.

Using custom metrics is powerful but can also be a bit intimidating at first - if you need some assistance or input, please contact our support team.

Custom Metric Management

Custom Metric Workflow

A quick reminder of the workflow for custom metrics.

  1. Define the custom metric using any of the following options: 

  2. Report your first metric value

  3. We'll use the metadata you defined in your custom metric to stamp out the initial Custom Metric record in FortiMonitor

  4. You can edit / override any of the settings identified below from the Custom Metric management page

Editing Custom Metric Metadata

You can view your reported custom metrics on the Custom Metric management page, which is located under the Settings navigation item. To edit the metadata about one of your metrics, locate it in the Custom Metric table, and then click the corresponding 3-dot menu in its row and click Edit.

Fields

Field

Description

Editable?

Textkey

The Plugin and Metric Textkeys you defined when creating your custom metric locally.

No

Name

The name of your metric - this will appear throughout the Control Panel, including in dashboards, alert descriptions, graphs, etc

Yes

Category

You can think of the Category as a way to logically group related custom metrics. Our built-in categories are things like SQL Server, MySQL, Apache. This will also dictate how metrics are grouped together in the monitoring configuration catalog on your instances

Yes

Unit

The unit for your metric - transactions, orders, users, etc. Metrics with the same unit are grouped together in graphs

Yes

Metric Type

Number, boolean, or percent

Yes

Boolean Values

If your metric is a boolean type, you can set the True and False states - such as is running and is not running. They map to the 1/0 values you report.

This will appear in metric descriptions and when configuring alerts.

Yes

Option

Provides context for the object type you're reporting on - such as drive or network adapter.

No

Custom Metrics in Templates

Once a Custom Metric has been reported-up for the first time, it will be available to add to your templates. Similar to the monitoring provided out of the box, it will be available in the Monitoring Catalog on a template page. Merely select Add Monitoring from the monitoring configuration table and locate the Custom Metric category in the catalog.

Custom metric management

FortiMonitor enables you to publish custom metrics in a variety of formats across our supported platforms. As well, you can manage the meta-data for your custom metrics once they've been reported to FortiMonitor - including name, category, unit, and type. This metadata is used throughout FortiMonitor - in graphs, incident alerts, threshold configuration, reports, and more.

Using custom metrics is powerful but can also be a bit intimidating at first - if you need some assistance or input, please contact our support team.

Custom Metric Management

Custom Metric Workflow

A quick reminder of the workflow for custom metrics.

  1. Define the custom metric using any of the following options: 

  2. Report your first metric value

  3. We'll use the metadata you defined in your custom metric to stamp out the initial Custom Metric record in FortiMonitor

  4. You can edit / override any of the settings identified below from the Custom Metric management page

Editing Custom Metric Metadata

You can view your reported custom metrics on the Custom Metric management page, which is located under the Settings navigation item. To edit the metadata about one of your metrics, locate it in the Custom Metric table, and then click the corresponding 3-dot menu in its row and click Edit.

Fields

Field

Description

Editable?

Textkey

The Plugin and Metric Textkeys you defined when creating your custom metric locally.

No

Name

The name of your metric - this will appear throughout the Control Panel, including in dashboards, alert descriptions, graphs, etc

Yes

Category

You can think of the Category as a way to logically group related custom metrics. Our built-in categories are things like SQL Server, MySQL, Apache. This will also dictate how metrics are grouped together in the monitoring configuration catalog on your instances

Yes

Unit

The unit for your metric - transactions, orders, users, etc. Metrics with the same unit are grouped together in graphs

Yes

Metric Type

Number, boolean, or percent

Yes

Boolean Values

If your metric is a boolean type, you can set the True and False states - such as is running and is not running. They map to the 1/0 values you report.

This will appear in metric descriptions and when configuring alerts.

Yes

Option

Provides context for the object type you're reporting on - such as drive or network adapter.

No

Custom Metrics in Templates

Once a Custom Metric has been reported-up for the first time, it will be available to add to your templates. Similar to the monitoring provided out of the box, it will be available in the Monitoring Catalog on a template page. Merely select Add Monitoring from the monitoring configuration table and locate the Custom Metric category in the catalog.