Monitoring¶

The Smart Unifier Manager offers a metrics API that allows monitoring of the current status of deployed instances and deployment endpoints. This API is accessible via a REST GET request

Deployments¶

http://localhost:9000/api/metrics/v1/deployments

Example

[
  {
    "id": "9a2bd6bb-8a3a-4e92-a125-06fc2f1d0ebf",
    "group": "demo.fab01.line4",
    "name": "LatheMachine_01",
    "version": "latest",
    "state": "Started",
    "communicationState": "Connected",
    "endpoint": {
      "id": "local",
      "group": "default",
      "name": "Default",
      "type": "Local",
      "state": "Running",
      "startupType": "Automatic"
    },
    "channels": [
      {
        "id": "1ea57580-70ae-4a25-ae61-3a47ba5b0c05",
        "group": "demo.fab01.line4",
        "name": "MachineContextInMemoryChannel",
        "version": "latest",
        "state": "Connected",
        "error": ""
      },
      {
        "id": "39ed9664-dcef-45a6-bb38-13330645b039",
        "group": "demo.fab01.line4",
        "name": "MachinePartCounterGrpcClientChannel",
        "version": "latest",
        "state": "Connected",
        "error": ""
      },
      {
        "id": "7e4c7f49-6e4a-4aee-a093-5cc5a0bbe38c",
        "group": "demo.fab01.line4",
        "name": "MachineStatusGrpcClientChannel",
        "version": "latest",
        "state": "Connected",
        "error": ""
      },
      {
        "id": "b2bd8ad7-b549-4018-94b9-e345489a22de",
        "group": "demo.fab01.line4",
        "name": "MachineOpcUaClientChannel",
        "version": "latest",
        "state": "Connected",
        "error": ""
      }
    ]
  },
  {
    "id": "6edc8a83-e7a5-492b-8dc2-fbd0965331d5",
    "group": "demo.fab01.line4",
    "name": "LatheMachine_02",
    "version": "latest",
    "state": "Stopped",
    "communicationState": "Stopped",
    "endpoint": {
      "id": "local",
      "group": "default",
      "name": "Default",
      "type": "Local",
      "state": "Running",
      "startupType": "Automatic"
    },
    "channels": []
  }
]

Fields¶

Field	Description
`id`	UUID of the instance
`group`	The group of the instance
`name`	The name of the instance
`version`	Version of the instance
`state`	Current operational state of the instance (e.g., `Started`)
`communicationState`	Communication status (e.g., `Connected`, `Stopped`)
`endpoint`	Endpoint configuration object (see Endpoint)
`channels`	List of channel objects (see Channels)

Endpoint¶

Location where the instance is deployed with additional information about the endpoint

Field	Description
`id`	Identifier of the endpoint
`group`	Group the endpoint belongs to
`name`	Name of the endpoint
`type`	Type of endpoint (`Local`, `Agent`)
`state`	State of the endpoint
`startupType`	Startup mode (`Automatic`, `Manual` or `disabled`)

Channels¶

Each machine may contain one or more communication channels.

Field	Description
`id`	Unique identifier for the channel
`group`	The group or namespace the channel belongs to
`name`	The name of the channel
`version`	Version string, usually `"latest"`
`state`	State of the channel (e.g., `Connected`)
`message`	Any relevant message from the channel
`error`	Any error information if present

States

State	Description
`Stopped`	The channel is not running.
`Starting`	The channel is being started.
`Connecting`	Attempting to establish a connection.
`Disconnected`	The connection has been lost or not yet established.
`StartFailure`	The channel failed to connect (e.g. due to configuration issue or destination not available).
`RunningFailure`	The channel encountered an error while running.
`StopFailure`	An error occurred while trying to nicly stop the channel.
`Connected`	The channel is successfully connected and operational.
`Stopping`	The channel is in the process of shutting down.

Endpoints¶

hhttp://localhost:9000/api/metrics/v1/endpoints

Example

[
 {
   "id": "local",
   "group": "default",
   "name": "Default",
   "type": "Local",
   "state": "Running",
   "startupType": "Automatic"
 }
]