Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

This opCharts API provides access to the Latest Data collection in a JSON format. The latest_data collection holds the raw values collected from the node and the derived_data calculated by the poller. The raw values collected are in the "data" section and all "stats" data the calculated data and statistics is in the "derived_data" section, the properties found in these sections are dynamic and are defined by the model used for the node. Each document in the collection has a link to its associated inventory_id and a subconcept subconcepts array. Each subconcept entry in the subconcepts array holds a document with the subconcept name as well as a data and derived_data sub documents. There is a single record per inventory_id and the record holds the most recent readings/calculations for that piece of inventory. See below for an example document.

The Latest Data API is available in opCharts from version 4.8.0

...

Panel

http://server/omk/opCharts/v2/latest_data/64194dc7da587f6374d0396b.json

{
  "cluster_id": "2f4e78ab-3b96-4540-9184-e71b48fa8120",
  "configuration": {
    "group": "DC_Network"
  },
  "id": "64194dc7da587f6374d0396b",
  "inventory_id": "64194dabda587f6374cfcdc2",
  "node_uuid": "9ce8e534-25f7-4b0d-ba8d-49cc921952c4",
  "subconcepts": [
    {
      "subconcept": "interface",
      "data": {
        "ifInOctets": 0,
        "ifInOctets_raw": 0,
        "ifOperStatus": 100,
        "ifOutOctets": 716817,
        "ifOutOctets_raw": 33901301339
      },
      "derived_data": {
        "availability": 100,
        "inputBits": 0,
        "inputUtil": 0,
        "outputBits": 22215.42,
        "outputUtil": 0.02,
        "totalUtil": 0.01
      }
    },
    {
      "subconcept": "pkts_hc"
      "data": {
        "ifInBcastPkts": 0,
        "ifInBcastPkts_raw": 0,
        "ifInDiscards": 0,
        "ifInDiscards_raw": 0,
        "ifInErrors": 0,
        "ifInErrors_raw": 0,
        "ifInMcastPkts": 0,
        "ifInMcastPkts_raw": 0,
        "ifInOctets": 0,
        "ifInOctets_raw": 0,
        "ifInUcastPkts": 0,
        "ifInUcastPkts_raw": 0,
        "ifOutBcastPkts": 1823,
        "ifOutBcastPkts_raw": 320360615,
        "ifOutDiscards": 0,
        "ifOutDiscards_raw": 0,
        "ifOutErrors": 0,
        "ifOutErrors_raw": 0,
        "ifOutMcastPkts": 6713,
        "ifOutMcastPkts_raw": 135566792,
        "ifOutOctets": 716817,
        "ifOutOctets_raw": 33901301339,
        "ifOutUcastPkts": 120,
        "ifOutUcastPkts_raw": 2944557
      },
      "derived_data": {
        "ifInDiscards": 0,
        "ifInDiscardsProc": null,
        "ifInErrors": 0,
        "ifInErrorsProc": null,
        "ifInNUcastPkts": 0,
        "ifInUcastPkts": 0,
        "ifOutDiscards": 0,
        "ifOutDiscardsProc": 0,
        "ifOutErrors": 0,
        "ifOutErrorsProc": 0,
        "ifOutNUcastPkts": 11.7,
        "ifOutUcastPkts": 0.32414
      }
    }
  ],
  "time": 1731625953.55326
}


Property

Description

Example

id

A globally unique ID

"63576103ad794974594a1f11"

cluster_id

The id of the NMIS poller server for the associated node

"6678b17aca40037e1139cace"

inventory_id

The id of the associated inventory record


node_uuid

The uuid of the associated node

"8da86248-40f3-4c92-90b6-736bb66814aa"

subconcepts

Array of documents per subconcept, each array entry contains a document with the subconcept name, a hash of all "data" values and a hash of all "derived_data" values


time

The unix timestamp that the record was made. 

1687213025

...