v22.11.6 Release Notes

maiLink Agent Changes

Telemetry Events

The maiLink Agent software has been updated to transmit telemetry event data to the cloud. As in prior maiLink Agent releases, the telemetry event data can still be logged to a file on the device by setting the log.level in mailink-agent-plugin.yml to trace.

Telemetry Status

The maiLink Agent software has been updated to transmit telemetry status data to the cloud. As in prior maiLink Agent releases, the telemetry status data can still be logged to a file on the device by setting the log.level in mailink-agent-plugin.yml to trace.

Built-In System Telemetry

Prior releases of maiLink Agent included built-in system telemetry that transmitted CPU and memory utilization data to the cloud. This has now been greatly extended to include the following:

System	Type	Unit	Property
os	status	text	Operating system type.
system_boot_time	status	Seconds	Most recent system boot time (since epoch).
system_up_time	status	Seconds	Time elapsed since completion of the last system boot.

CPU	Type	Unit	Property
cpu_cpus	status	number	Number of physical CPUs available.
cpu_cores	status	number	Number of CPU cores available.
cpu_frequency	status	MHz	CPU clock frequency.
cpu_model_name	status	text	CPU model name.
cpu_used_percent	metric	%	Fraction of CPU in use.
cpu_vendor_id	status	text	CPU vendor name.

Memory	Type	Unit	Property
memory_free_bytes	metric	Bytes	Free memory.
memory_total_bytes	status	Bytes	Amount of available memory.
memory_used_bytes	metric	Bytes	Used memory.
memory_used_percent	metric	%	Fraction of memory in use.

Network	Type	Unit	Property
interface_ip_addresses	status	text	IP Address of this network interface.
interface_mac_address	status	text	MAC Address of this network interface.
interface_name	status	text	Name of this network interface.

Disk	Type	Unit	Property
partition_device	status	text	Name of disk drive for this partition.
partition_free_bytes	metric	Bytes	Free disk partition space.
partition_fstype	status	text	Name of partition file system type.
partition_mountpoint	status	text	Name of disk drive mount point for this partition.
partition_total_bytes	status	Bytes	Amount of disk space available in this partition.
partition_used_bytes	metric	Bytes	Used disk partition space.
partition_used_percent	metric	%	Fraction of disk partition space in use.

Control. By default, your device does not transmit all of the above information to the cloud. However, starting in this release you can enable any of the above items for automated transmission. To enable the items, edit mailink-agent-plugin.yml and add any or all of the following data items below. Note that you can easily disable any of them at any time by setting enabled:false.

Note: In a future release, controls over the enabling/disabling of built-in system telemetry will be moved to the Device Type controls in the cloud.

telemetry:
  metric:
    partition:
      free_bytes:
        enabled: true
      used_bytes:
        enabled: true
      used_percent:
        enabled: true
    memory:
      used_bytes:
        enabled: true
      used_percent:
        enabled: true
      free_bytes:
        enabled: true
    cpu:
      used_percent:
        enabled: true
  status:
    os:
      enabled: true
    system:
      boot_time:
        enabled: true
      up_time:
        enabled: true
    cpu:
      cpus:
        enabled: true
      cores:
        enabled: true
      vendor_id:
        enabled: true
      model_name:
        enabled: true
      frequency:
        enabled: true
    partition:
      device:
        enabled: true
      mountpoint:
        enabled: true
      fstype:
        enabled: true
      total_bytes:
        enabled: true
    memory:
      total_bytes:
        enabled: true
    interface:
      name:
        enabled: true
      mac_address:
        enabled: true
      ip_addresses:
        enabled: true

maiLink Metrics Explorer Changes

The maiLink web port has been updated to reflect the telemetry changes described above.

Display of Telemetry Status Data

Telemetry status information is now displayed in the user interface at Devices > [Device] > About [Device] > System Status. The data displayed here includes both any enabled built-in system telemetry status data as well as all the custom telemetry status data that your system is transmitting to the cloud.

Note: The data displayed is the most recent status value received for each of the status parameters.

Display of Telemetry Events Data

Telemetry events are now displayed as a graphical overlay in the metrics explorer as vertical dashed lines.

Note: Individual events cannot be enabled or disabled at this time.

Display of Built-In System Telemetry Metric Data

Built-in system telemetry data that is sent as metrics (dynamic numeric data) can be selected for graphical display by clicking on the Add Query button in the metrics explorer found at Devices > [Device] > About [Device] > Metrics Explorer.

• ←Previous
Next→