Runtime - Performance Metrics

This section is for searching for live objects being monitored by Opsview. This is in the Runtime database, hence the URL path is /rest/runtime/{objecttype}.

URL: /rest/runtime/performancemetric.

Requires authentication - requires VIEWALL or VIEWSOME permission.

Access Control Copied

VIEWALL allows all performance data to be returned. VIEWSOME allows performance data to be returned for objects where permission has been granted for the service based on the access object selection.

Requesting Performance Metrics Copied

Performance metrics consist of a name of the format:

    {hostname}::{servicename}::{metricname}

For example, a fully qualified metric name is opsview::Opsview NDO::ndo_file_backlog.

Parameters:

Response:

Note

This will only return items that have performance data. If you want to search for all hosts, use /rest/runtime/host.

Example response for type=host:

    {
       "rows" : "13",
       "list" : [
          "build-sol10-amd64",
          "build-sol10-i386",
          "ov-build-centos4-32",
          "ov-build-centos4-64",
          "ov-build-centos5-32",
          "ov-build-centos5-64",
          "ov-build-etch-32",
          "ov-build-etch-64",
          "ov-build-hardy-32",
          "ov-build-hardy-64",
          "ov-build-lenny-64",
          "ov-build-rhel5-32",
          "ov-build-rhel5-64"
       ],
       "total" : "41"
    }

Example response for type=service:

    {
       "rows" : "6",
       "list" : [
          "/",
          "/backup",
          "/boot",
          "/home",
          "/srv/vms",
          "/var"
       ],
       "total" : "48"
    }

Example response for type=metric:

    {
       "rows" : "2",
       "list" : [
          "boot",
          "root"
       ],
       "total" : "279"
    }

Example response for type=hostgroup&format=object:

    {
       "list" : [
          {
             "id" : "4",
             "name" : "Opsview,UK,Leaf,"
          },
          {
             "id" : "2",
             "name" : "Opsview,UK,Monitoring Servers,"
          },
          {
             "id" : "5",
             "name" : "Opsview,UK2,Leaf2,"
          }
       ],
       "rows" : "3",
       "total" : "3"
    }

Example response for type not set (ie, the fully qualified metric name):

    {
       "list" : [
          "opcollector::/::root",
          "opsview::/::root",
          "ov-build-centos5-64::/::root",
          "ov-build-hardy-32::/::root",
          "ov-build-hardy-64::/::root",
          "ov-build-rhel5-64::/::root",
          "prodservice1::/boot::boot",
          "prodservice1::/::root",
          "prodweb3::/::root",
          "vmhost1::/boot::boot",
          "vmhost1::/::root",
          "vmhost2::/::root",
          "vmhost3::/::root",
          "vmhost3::/srv/vms::root"
       ],
       "rows" : "14",
       "total" : "455"
    }
["Opsview"] ["API", "Technical Reference"]

Was this topic helpful?