1. Release Highlights
2. New Service - Management
3. New Service - Aggregator
4. SDK Module - Device Health
5. Driver list reload
6. New management API
7. Technical Notes
   1. Enabling device health snapshots

Release Date: 28 June 2021

Release Highlights

• The latest version of the V-Raptor™ SDK and services is now 4.0.26.10.
• A new core V-Raptor™ service is available - Management
• A new core V-Raptor™ service is available - Aggregator
• A new module has been added to the V-Raptor™ driver SDK to capture device and gateway health information.
• Additional management APIs have been added to the V-Raptor™ deployment agent.
• Users can now force the available driver list to be reloaded.

New Service - Management

A new service has been developed that can be deployed into the V-Raptor™. This service will aggregate device and gateway health information received from all drivers in the V-Raptor. This information is periodically relayed to the Aggregator service.

New Service - Aggregator

A new service has been developed that collects device and gateway health information and events from all devices and gateways connected to V-Raptor™s within a tenant.

The service also has an API that can be used to retrieve these snapshots and events.

SDK Module - Device Health

The following two NuGet packages have been added:

• IoTnxt.Raptor.ConnectionMonitor
• IoTnxt.Raptor.Management

These modules provide access to the event management system, connection status monitoring, as well as providing information about which devices are actively sending telemetry.

Note: These modules are automatically enabled when upgrading your driver to this version of the SDK. However, the Management and Raptor Aggregator services will need to be configured in order to utilise the feature.

Driver list reload

The user can now force the list of available drivers to be reloaded instead of waiting for newly uploaded packages to be discovered.

Figure 1 - Force driver list to refresh

New management API

New management APIs have been added to manipulate low-level meta information about deployed services and configuration files. These APIs are intended for DevOps and Technical personnel only and are provided for the purpose of disaster recovery and advanced use cases such as upgrading older V-Raptors. The following APIs have been added:

Figure 2 - Manage the raptor default config data

Figure 3 - Manage the raptor deployed service data

Figure 4 - Manage the raw service configuration,fix broken configs or issue where a de-sync occurred between Kubernetes and the deployment service

Technical Notes

This section provides a summary of changes that impact parties responsible for managing V-Raptor™ installations.

Enabling device health snapshots

In order to utilise the new device health modules, the management service and raptor aggregator API will first need to be deployed and configured. The management service can be deployed through the deployment agent’s CLI or by using the REST API.

Each service utilising the Management service will also require an RPC endpoint called Management to be added that points to the location of the management service in the V-Raptor™. The service will also require a DeviceManagementOptions options file to be added in which the relevant features are enabled as required.

{
  "DeviceManagementOptions": {
    "ManagementEndpointName": "Management",
    "EnableDeviceManagement": true,
    "EnableEntityManagement": true,
    "EnableEventManagement": true,
    "EnableConnectionManagement": true
  } 
}

The Raptor Aggregator service will require a connection to MongoDB to store the gateway and device snapshots.