Endpoints

Endpoints describes the address of a single data endpoint within a specific protocol.

See also: Cybus::Endpoint resource

Overview

In the list, all endpoints are displayed with the following information:

Service ID

• The unique identifier of the service that contains this endpoint.

Name

• The name of the endpoint (e.g. current, rpm, temperature).

Connection ID

• The unique identifier assigned to this specific endpoint within the service.

Protocol

• The communication protocol used for the endpoint (e.g., Modbus, HTTPS, OPC UA).

Operation

• The operation type of the endpoint (e.g., subscribe or publish).

Agent

• The agent that is assigned to the endpoint.

Status

• The current state of the endpoint (e.g., enabled or disabled).

Endpoint Details View

• To open the Endpoint View for a specific service, click Services > Service Overview and select a service. In the Service Details View of the selected service, click the Endpoints tab.

At the top of the Endpoint Details View, the following information is displayed:

Name

• The name of the endpoint (e.g. current, rpm, temperature).

Service ID

• The unique identifier of the service that contains this endpoint.

Protocol

• The communication protocol used for the endpoint (e.g., Modbus, HTTPS, OPC UA).

Operation

• The operation type of the endpoint (e.g., subscribe or publish).

Agent

• The agent that is assigned to the endpoint.

Status

• The current state of the endpoint (e.g., enabled or disabled).

Topics

• The topic of the endpoint. You can monitor all topics in the Data Explorer.

Resources of Endpoints

Each endpoint has resources itself.

• To open the resources of endpoints, click an endpoint in the Endpoints View.

Endpoint Logs

You can view detailed log messages for the endpoints of the selected service in the Endpoints Logs tab of the Endpoint Details View.

Download CSV

• Export the visible log entries as a CSV file.

Refresh Logs

• Refresh the log messages to show the most recent entries.

Filter

• Use these filters to focus on specific service log message types based on your troubleshooting or monitoring needs. You can filter for Debug, Error, Fatal, Info, Trace, and Warn messages.

Start Time/End Time

• Select a specific start date/time and end date/time to define the period for which you want to view log messages.

Search

• Find specific log messages by keyword. The search filters the displayed service log messages, showing only matching results.

Level

• The type of message. For example, info or warning.

Time

• Shows the exact date and time when each log message was generated.

Message

• Displays the message of the log (e.g., lathe_01: Enabled InfluxdbEndpoint).

Log Details Dialog

The Log Details dialog provides in-depth information about specific log entries in the service logs.

• To open the Log Details dialog, click a log entry of a service.

When you select a log entry, this dialog displays the following fields:

Time

• The timestamp of the log entry in Unix milliseconds format (.e.g., 1728878765733).

Pid

• The Process ID associated with the log entry.

Hostname

• The name of the host or service that generated the log (e.g., protocol-mapper).

Class Name

• The class or category of the log entry (e.g., InfluxdbEndpoint).

Message

• A detailed description of the logged event. Example: lathe_01: Enabled ModbusEndpoint

Address

The Address lists the address property specified for the endpoint in the service commissioning file.

Name

• The name of the address (e.g. length or interval).

Value

• The value of the address.

Search

• Find specific addresses by keyword.

Rules

The Rules tab lists associated Rule Engine rules for the endpoint. The rules define how data should be processed between subscribing and publishing. For more information, see Rule Engine.