Device Monitor

Retrieve monitoring information collected by the device monitor

Minimum user role is admin for every endpoint.

API

• Get state of the system

  • Path: /device_monitor/v1/state

  • Method: GET

  • Response:

    {
        "message" : "Success",
        "data" : {
            "cpu_data" : {
                "cpu_load_avg_1_minutes" : 1.96,
                "cpu_load_avg_15_minutes" : 1.47,
                "cpu_load_avg_5_minutes" : 1.67,
                "cpu_utilization_percent" : 14.9496780348199,
                "cpu_temperature_celsius" : 44
            },
            "time" : 1683640858,
            "interfaces_data" : [
                {
                    "interface_sw_dropped_packets" : 0,
                    "interface_capturing" : false,
                    "interface_written_bytes" : 0,
                    "interface_hardware_version" : "0318",
                    "interface_link_b_up" : false,
                    "interface_software_version" : "0.2.3.30",
                    "interface_hw_dropped_packets" : 0,
                    "interface_link_a_up" : false
                }
            ],
            "consumers_data" : {
                "flow_tracker_queue_size" : 0,
                "pcap_processor_queue_size" : 0,
                "file_exporter_queue_size" : 0,
                "pcap_eye_subscribed" : true,
                "pcap_processor_subscribed" : true,
                "file_exporter_subscribed" : false,
                "flow_tracker_subscribed" : true,
                "pcap_eye_queue_size" : 0
            },
            "nvme_data" : {
                "nvme_used_bytes" : 787648512,
                "nvme_total_bytes" : 964981100544,
                "nvme_temperature_celsius" : null
            },
            "ram_data" : {
                "ram_total_bytes" : 3909578752,
                "ram_used_bytes" : 2433650688
            },
            "iota_data" : {
                "iota_sw_version" : "3.1.0",
                "iota_ip_public" : "217.149.134.173",
                "iota_device_type" : "IOTA-1G",
                "iota_ip_eth0" : "10.10.12.72",
                "hostname" : "iota_d063b4023bad"
            },
            "iota_network_data" : {
                "iota_network_status" : "connected",
                "iota_mac_address" : "d0:63:b4:02:3b:ad"
            },
            "zerotier_data" : {
                "zt_ip" : null,
                "zt_node_id" : null,
                "zt_status" : "stopped",
                "zt_network_id" : null
            },
            "commit_id" : "d6f79dc",
            "uptime" : 2173,
            "geo_data" : {
                "geo_country" : "NL",
                "geo_coordinates" : [
                    5.4928,
                    51.5114
                ],
                "geo_asname" : "Signet B.V."
            },
            "database_versions" : {
                "flow_tracker_version" : "14",
                "device_monitor_version" : "4",
                "pcap_processor_version" : "cc522a0ee072dd59112b2d32d219eac6"
            },
            "disk_data" : {
                "disk_total_bytes" : 964981100544,
                "disk_used_bytes" : 787648512
            },
            "clickhouse_data" : {
                "clickhouse_server_uuid" : "96cc799f-923e-4631-9337-cddab88ac6a1"
            },
            "fan_data" : {
                "fan_speed_hertz" : 0
            },
            "firmware_update" : {
                "is_update_available": false
            }
        }
    }

    • interfaces_data - one entry per capture interface
• Get the size of metadata

  • Path: /device_monitor/metadata

  • Method: GET

  • Response:

    {
        "size": 3482904
    }

• Clean up all the metadata
  • Path: /device_monitor/metadata/all
  • Method: DELETE
  • Response: success or failure message
• Clean up the metadata given a range
  • Path: /device_monitor/metadata/range
  • Method: DELETE
  • Arguments:
    • URL parameters:
      • start_ts - beginning of the range in nanoseconds
      • end_ts - end of the range in nanoseconds
  • Response: success or failure message

Back to Index