starlingx/app-node-interface-metrics-exporter
Code Issues Proposed changes
app-node-interface-metrics-.../api-ref/source/api_node_interface_metrics.rst
Aman Pandae 9f4bbb93d4 Rest API Doc in StarlingX Api-ref 
API Request and Response Information added to the
Code Repository. Modified tox and Zuul to build
the doc html pages.

Added docs for the following APIs:
1. /metrics
2. /metrics/device/{device_name}
3. /metrics/pci-addr/{pci_addr}

Story: 2010918
Task: 50889

Change-Id: I720cbabc37b07314ef9fa74f0d39942373e6aec8
Signed-off-by: Aman Pandae <AmanPandae.Mothukuri@windriver.com>
Signed-off-by: AbhishekJ <abhishek.jaiswal@windriver.com>
2024-08-27 09:26:10 -04:00

4.3 KiB
Raw Blame History

Node Interface Metrics Exporter API v1

This Section contains the list of APIs of Node Interface Metrics Exporter.

The Application Pod retrieves the node interface information and statistics by making a call to the following REST APIs.

The server address is the node’s host name or IP address, and it uses port 9110.

The output is presented in the Open Metrics format, providing information and statistics for devices that are in the UP state.

Open Metrics API List

Get statistics of all devices in the node

  • /metrics provides the information and statistics of all Physical Function devices.
  • It provides the information and statistics of Virtual Function devices that belong to the Physical Function devices.
  • It also provides the POD information if the Virtual Function device is used by any POD (matched by PciAddr of Virtual Function device).

Normal response codes

200

Error response codes

computeFault (400, 500, …), serviceUnavailable (503), badRequest (400), badMethod (405), itemNotFound (404)

Request parameters

None

Response parameters

Node statistics in Open Metrics format.

Get Statistics of a particular device by device_name

Get the information and statistics of a particular device in the Node identified by {device_name}.

  • If the input device name is Physical Function, /metrics/device/{device_name} provides its device information and statistics. It provides device information and statistics of all the Virtual Functions that belong to the input device. It also provides the POD information if Virtual Function device is used by any POD (matched by pci-address of Virtual Function device).
  • Input Virtual Function device name is not supported as multiple Virtual Functions have the same device name in different pods.

Normal response codes

200

Error response codes

computeFault (400, 500, …), serviceUnavailable (503), badRequest (400), badMethod (405), itemNotFound (404)

Request parameters

Parameter Style Type Description
device_name URI string The unique name of Physical Function device

Response parameters

Device statistics in Open Metrics format.

Get Statistics of a particular device by pci_address

Get statistics of the particular device in the node identified by {pci_address}.

  • If the input pci-address belongs to the Physical Function device, /metrics/pci-addr/{pci_address} provides its device information and statistics. It also provides statistics of all the Virtual Function devices that belong to the Physical Function device.
  • If the input pci-address belongs to the Virtual Function device, it provides its device information and statistics. It provides the POD information as well if the Virtual Function device is used by any POD (matched by pci-address of the Virtual Function device).

Normal response codes

200

Error response codes

computeFault (400, 500, …), serviceUnavailable (503), badRequest (400), badMethod (405), itemNotFound (404)

Request parameters

Parameter Style Type Description
pci_address URI csapi:UUID Unique identifier of the pci-address of the Physical Function or the Virtual Function devices

Response parameters

Device statistics in Open Metrics format.

  • When input is pci-address of Physical Function device:
  • When input is pci-address of the Virtual Function device: