Skip to content

Monitoring Spec Example

andreggouveia edited this page Apr 20, 2021 · 22 revisions

The following model exemplifies a configuration intended to be created by Vertical Slicer and posted to an endpoint from MDA:

{
    "businessID": "business",
    "topic": "topic_test",
    "networkID": 4665483,
    "tenantID": "tenant",
    "referenceID": "reference",
    "resourceID": "resource",
    "timestampStart": "2021-04-06T17:36:00",
    "timestampEnd": "2021-05-28T16:27:00",
    "metrics": [
        {
            "metricName": "cpu_utilization",
            "metricType": "float",
            "aggregationMethod": null,
            "step": "30s",
            "step_aggregation": null
        },
        {
            "metricName": "disk_usage",
            "metricType": "float",
            "aggregationMethod": null,
            "step": "2m",
            "step_aggregation": null
        },
        {
            "metricName": "disk_usage",
            "metricType": "float",
            "aggregationMethod": "sum",
            "step": "2m",
            "step_aggregation": "5m"
        }
    ]
}

Resource Monitoring information

Parameter Type Description
resourceId String Unique ID of resource for which we are collecting monitoring data.
referenceId String Unique ID of entity (e.g., SLA) for whom we are collecting monitoring data.
metricName String Name of metric being monitored.
metricValue String Value of metric being monitored.
timeStamp DateTime The time at which the metric was measured.

The resourceID represents the resource for which we are collecting monitoring data. If the resource used to be part of one SLA and is now part of another SLA, it may make sense to use a distinct resourceID for the different epochs, so that data from one epoch is not used to influence decisions in another epoch. The referenceID might be the SLA identifier to which this resource is dedicated and is used to look up all relevant monitoring data for that reference. The monitoring data provided to postMonitoringData() should be a list of such structures, with one entry per metric being recorded.

Lookup Monitoring Data Structure

Parameter Type Description
resourceId String Unique ID of resource for which we are collecting monitoring data.
metricName String Name of metric being monitored.
metricValue String Value of metric being monitored.

Clone this wiki locally