Get Object’s Stat Metrics

Returns a list of agent’s metric names for a given object.

Request

HTTP Request

GET /node/api/objects/:id/stat/metrics

Permissions

objectPermissions

Path parameters

Parameter Type Description

id

String
required

The ID or discovery ID of the object for which agent’s metrics names must be retrieved.

Request body

The request body is empty.

Response

Returns an array of names of all numeric values from the data table.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
object_i=<...>
url=https://$saymon_hostname/node/api/objects/$object_id/stat/metrics

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let objectId = <...>
let path = "/node/api/objects/" + objectId + "/stat/metrics";
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "GET",
    headers: headers
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log("error", error));
const http = require("http");

let login = <...>
let password = <...>
let saymonHostname = <...>
let objectId = <...>
let path = "/node/api/objects/" + objectId + "/stat/metrics";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "GET",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth
    },
    "path": path
};

let req = http.request(options, function (res) {
    let chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        let body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

req.end();
import requests

login = <...>
password = <...>
saymon_hostname = <...>
object_id = <...>
url = "https://" + saymon_hostname + "/node/api/objects/" + \
    object_id + "/stat/metrics"

response = requests.request("GET", url, auth=(login, password))
print(response.text)

Response

[
    "totalMemory",
    "freeMemory",
    "maxMemory",
    "usedHeapMemory",
    "usedNonHeapMemory",
    "processCpuLoad",
    "numberOfThreads",
    "snmpTrapsPerSecond",
    "statNotificationsPerSecond",
    "tasksNumber"
]

See Also