ApplicationMonitoring Cluster

The following commands and attributes are accepted as JSON payloads for the ApplicationMonitoring cluster.

ApplicationMonitoring Attributes

The following attribute topics are used to retrieve the ApplicationMonitoring cluster state.

ApplicationMonitoring/ApplicationName Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationName/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationName/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationName Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationName attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationName/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationName/Desired { "value": <DESIRED_APPLICATION_NAME>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationName/Reported { "value": <REPORTED_APPLICATION_NAME>}

ApplicationMonitoring/ApplicationVersion Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationVersion/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationVersion/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationVersion Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationVersion attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationVersion/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationVersion/Desired { "value": <DESIRED_APPLICATION_VERSION>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationVersion/Reported { "value": <REPORTED_APPLICATION_VERSION>}

ApplicationMonitoring/ApplicationConnected Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationConnected/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationConnected/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationConnected Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationConnected attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationConnected/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationConnected/Desired { "value": <DESIRED_APPLICATION_CONNECTED>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationConnected/Reported { "value": <REPORTED_APPLICATION_CONNECTED>}

ApplicationMonitoring/ApplicationMQTTTopics Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationMQTTTopics Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationMQTTTopics attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/Desired { "value": [<DESIRED_APPLICATION_MQTT_TOPICS>,<DESIRED_APPLICATION_MQTT_TOPICS>]}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationMQTTTopics/Reported { "value": [<REPORTED_APPLICATION_MQTT_TOPICS>,<REPORTED_APPLICATION_MQTT_TOPICS>]}

ApplicationMonitoring/UptimeMinutes Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/UptimeMinutes/Reported
[PREFIX]/ApplicationMonitoring/Attributes/UptimeMinutes/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster UptimeMinutes Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for UptimeMinutes attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/UptimeMinutes/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/UptimeMinutes/Desired { "value": <DESIRED_UPTIME_MINUTES>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/UptimeMinutes/Reported { "value": <REPORTED_UPTIME_MINUTES>}

ApplicationMonitoring/ProcessId Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ProcessId/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ProcessId/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ProcessId Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ProcessId attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ProcessId/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ProcessId/Desired { "value": <DESIRED_PROCESS_ID>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ProcessId/Reported { "value": <REPORTED_PROCESS_ID>}

ApplicationMonitoring/Hostname Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/Hostname/Reported
[PREFIX]/ApplicationMonitoring/Attributes/Hostname/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster Hostname Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for Hostname attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/Hostname/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/Hostname/Desired { "value": <DESIRED_HOSTNAME>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/Hostname/Reported { "value": <REPORTED_HOSTNAME>}

ApplicationMonitoring/FQDN Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/FQDN/Reported
[PREFIX]/ApplicationMonitoring/Attributes/FQDN/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster FQDN Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "string"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for FQDN attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/FQDN/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/FQDN/Desired { "value": <DESIRED_FQDN>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/FQDN/Reported { "value": <REPORTED_FQDN>}

ApplicationMonitoring/MQTTLoggingEnabled Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTLoggingEnabled/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTLoggingEnabled/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTLoggingEnabled Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "boolean"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTLoggingEnabled attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTLoggingEnabled/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTLoggingEnabled/Desired { "value": <DESIRED_MQTT_LOGGING_ENABLED>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTLoggingEnabled/Reported { "value": <REPORTED_MQTT_LOGGING_ENABLED>}

ApplicationMonitoring/MQTTLoggingLevel Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTLoggingLevel/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTLoggingLevel/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTLoggingLevel Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "LoggingLevelEnum"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTLoggingLevel attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTLoggingLevel/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTLoggingLevel/Desired { "value": <DESIRED_MQTT_LOGGING_LEVEL>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTLoggingLevel/Reported { "value": <REPORTED_MQTT_LOGGING_LEVEL>}

ApplicationMonitoring/MQTTStatisticsReportingIntervalSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTStatisticsReportingIntervalSeconds/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTStatisticsReportingIntervalSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTStatisticsReportingIntervalSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTStatisticsReportingIntervalSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTStatisticsReportingIntervalSeconds/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTStatisticsReportingIntervalSeconds/Desired { "value": <DESIRED_MQTT_STATISTICS_REPORTING_INTERVAL_SECONDS>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTStatisticsReportingIntervalSeconds/Reported { "value": <REPORTED_MQTT_STATISTICS_REPORTING_INTERVAL_SECONDS>}

ApplicationMonitoring/MQTTMessagesSent Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTMessagesSent/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTMessagesSent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTMessagesSent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTMessagesSent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTMessagesSent/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMessagesSent/Desired { "value": <DESIRED_MQTT_MESSAGES_SENT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMessagesSent/Reported { "value": <REPORTED_MQTT_MESSAGES_SENT>}

ApplicationMonitoring/MQTTMessagesReceived Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTMessagesReceived/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTMessagesReceived/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTMessagesReceived Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTMessagesReceived attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTMessagesReceived/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMessagesReceived/Desired { "value": <DESIRED_MQTT_MESSAGES_RECEIVED>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMessagesReceived/Reported { "value": <REPORTED_MQTT_MESSAGES_RECEIVED>}

ApplicationMonitoring/MQTTSubscriptionCount Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTSubscriptionCount/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTSubscriptionCount/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTSubscriptionCount Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTSubscriptionCount attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTSubscriptionCount/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTSubscriptionCount/Desired { "value": <DESIRED_MQTT_SUBSCRIPTION_COUNT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTSubscriptionCount/Reported { "value": <REPORTED_MQTT_SUBSCRIPTION_COUNT>}

ApplicationMonitoring/MQTTAverageDeliveryTimeSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTAverageDeliveryTimeSeconds/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTAverageDeliveryTimeSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTAverageDeliveryTimeSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTAverageDeliveryTimeSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTAverageDeliveryTimeSeconds/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTAverageDeliveryTimeSeconds/Desired { "value": <DESIRED_MQTT_AVERAGE_DELIVERY_TIME_SECONDS>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTAverageDeliveryTimeSeconds/Reported { "value": <REPORTED_MQTT_AVERAGE_DELIVERY_TIME_SECONDS>}

ApplicationMonitoring/MQTTMinDeliveryTimeSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTMinDeliveryTimeSeconds/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTMinDeliveryTimeSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTMinDeliveryTimeSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTMinDeliveryTimeSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTMinDeliveryTimeSeconds/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMinDeliveryTimeSeconds/Desired { "value": <DESIRED_MQTT_MIN_DELIVERY_TIME_SECONDS>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMinDeliveryTimeSeconds/Reported { "value": <REPORTED_MQTT_MIN_DELIVERY_TIME_SECONDS>}

ApplicationMonitoring/MQTTMaxDeliveryTimeSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/MQTTMaxDeliveryTimeSeconds/Reported
[PREFIX]/ApplicationMonitoring/Attributes/MQTTMaxDeliveryTimeSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster MQTTMaxDeliveryTimeSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for MQTTMaxDeliveryTimeSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/MQTTMaxDeliveryTimeSeconds/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMaxDeliveryTimeSeconds/Desired { "value": <DESIRED_MQTT_MAX_DELIVERY_TIME_SECONDS>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/MQTTMaxDeliveryTimeSeconds/Reported { "value": <REPORTED_MQTT_MAX_DELIVERY_TIME_SECONDS>}

ApplicationMonitoring/ApplicationStatisticsReportingIntervalSeconds Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationStatisticsReportingIntervalSeconds/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationStatisticsReportingIntervalSeconds/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationStatisticsReportingIntervalSeconds Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationStatisticsReportingIntervalSeconds attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationStatisticsReportingIntervalSeconds/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationStatisticsReportingIntervalSeconds/Desired { "value": <DESIRED_APPLICATION_STATISTICS_REPORTING_INTERVAL_SECONDS>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationStatisticsReportingIntervalSeconds/Reported { "value": <REPORTED_APPLICATION_STATISTICS_REPORTING_INTERVAL_SECONDS>}

ApplicationMonitoring/ApplicationCPUUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUUsagePercent/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationCPUUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationCPUUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationCPUUsagePercent/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUUsagePercent/Desired { "value": <DESIRED_APPLICATION_CPU_USAGE_PERCENT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUUsagePercent/Reported { "value": <REPORTED_APPLICATION_CPU_USAGE_PERCENT>}

ApplicationMonitoring/ApplicationCPUAverageUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUAverageUsagePercent/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUAverageUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationCPUAverageUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationCPUAverageUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationCPUAverageUsagePercent/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUAverageUsagePercent/Desired { "value": <DESIRED_APPLICATION_CPU_AVERAGE_USAGE_PERCENT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUAverageUsagePercent/Reported { "value": <REPORTED_APPLICATION_CPU_AVERAGE_USAGE_PERCENT>}

ApplicationMonitoring/ApplicationCPUMinUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUMinUsagePercent/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUMinUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationCPUMinUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationCPUMinUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationCPUMinUsagePercent/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUMinUsagePercent/Desired { "value": <DESIRED_APPLICATION_CPU_MIN_USAGE_PERCENT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUMinUsagePercent/Reported { "value": <REPORTED_APPLICATION_CPU_MIN_USAGE_PERCENT>}

ApplicationMonitoring/ApplicationCPUMaxUsagePercent Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUMaxUsagePercent/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationCPUMaxUsagePercent/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationCPUMaxUsagePercent Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationCPUMaxUsagePercent attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationCPUMaxUsagePercent/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUMaxUsagePercent/Desired { "value": <DESIRED_APPLICATION_CPU_MAX_USAGE_PERCENT>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationCPUMaxUsagePercent/Reported { "value": <REPORTED_APPLICATION_CPU_MAX_USAGE_PERCENT>}

ApplicationMonitoring/ApplicationRAMUsageMB Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ApplicationRAMUsageMB/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ApplicationRAMUsageMB/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ApplicationRAMUsageMB Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ApplicationRAMUsageMB attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/+/ApplicationMonitoring/Attributes/ApplicationRAMUsageMB/+'
 
# Example output
 
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationRAMUsageMB/Desired { "value": <DESIRED_APPLICATION_RAM_USAGEMB>}
ucl/by-unid/<UNID>/ApplicationMonitoring/Attributes/ApplicationRAMUsageMB/Reported { "value": <REPORTED_APPLICATION_RAM_USAGEMB>}

ApplicationMonitoring/ClusterRevision Attribute

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Attributes/ClusterRevision/Reported
[PREFIX]/ApplicationMonitoring/Attributes/ClusterRevision/Desired

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ClusterRevision Attribute Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "integer"
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see desired/reported value for ClusterRevision attribute under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Attributes/ClusterRevision/+'
# Example output
ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Attributes/ClusterRevision/Desired { "value": <DESIRED_CLUSTER_REVISION> }
ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Attributes/ClusterRevision/Reported { "value": <REPORTED_CLUSTER_REVISION> }

ApplicationMonitoring Command Support

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/SupportedCommands
[PREFIX]/ApplicationMonitoring/SupportedGeneratedCommands

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Command Support Properties",
  "type": "object",
  "properties": {
      "value": {
          "type": "array",
          "items" : {
            "type": "string",
            "enum": [
              "LogEntry",
              "WriteAttributes",
              "ForceReadAttributes"
            ]
          }
        }
      }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To see supported commands for ApplicationMonitoring cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ApplicationMonitoring/SupportedCommands'
# Example output
ucl/by-unid/<UNID>/ApplicationMonitoring/SupportedCommands { "value": ["LogEntry","WriteAttributes", "ForceReadAttributes"] }

To see supported generated commands for ApplicationMonitoring cluster under the by-unid topic space:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ApplicationMonitoring/SupportedGeneratedCommands'
# Example output
ucl/by-unid/<UNID>/ApplicationMonitoring/SupportedGeneratedCommands { "value": [] }

ApplicationMonitoring Commands

ApplicationMonitoring/LogEntry Command

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Commands/LogEntry
[PREFIX]/ApplicationMonitoring/GeneratedCommands/LogEntry

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster LogEntry Command Properties",
  "type": "object",
  "properties": {
    "Timestamp": {
      "type": "string"
    },
    "LogLevel": {
      "type": "LoggingLevelEnum"
    },
    "LogTag": {
      "type": "string"
    },
    "LogMessage": {
      "type": "string"
    }
  },
  "required": [
    "Timestamp",
    "LogLevel",
    "LogTag",
    "LogMessage"
  ]
}

Example Mosquitto CLI Tool Usage

To send a ApplicationMonitoring/LogEntry command under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/ApplicationMonitoring/Commands/LogEntry' -m  '{ "Timestamp": <TIMESTAMP_VALUE>,"LogLevel": <LOG_LEVEL_VALUE>,"LogTag": <LOG_TAG_VALUE>,"LogMessage": <LOG_MESSAGE_VALUE> }'

To receive a ApplicationMonitoring/LogEntry generated command from a UNID/endpoint:

mosquitto_sub -t 'ucl/by-unid/<UNID>/ApplicationMonitoring/GeneratedCommands/LogEntry'

ApplicationMonitoring/WriteAttributes Command

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Commands/WriteAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster WriteAttributes Command Properties",
  "type": "object",
  "properties": {
    "MQTTLoggingEnabled": {
      "type": "boolean"
    },
    "MQTTLoggingLevel": {
      "type": "LoggingLevelEnum"
    },
    "MQTTStatisticsReportingIntervalSeconds": {
      "type": "integer"
    },
    "ApplicationStatisticsReportingIntervalSeconds": {
      "type": "integer"
    },
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To update all ApplicationMonitoring attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Commands/WriteAttributes' -m  '{ "MQTTLoggingEnabled": <MQTT_LOGGING_ENABLED_VALUE> ,"MQTTLoggingLevel": <MQTT_LOGGING_LEVEL_VALUE> ,"MQTTStatisticsReportingIntervalSeconds": <MQTT_STATISTICS_REPORTING_INTERVAL_SECONDS_VALUE> ,"ApplicationStatisticsReportingIntervalSeconds": <APPLICATION_STATISTICS_REPORTING_INTERVAL_SECONDS_VALUE> , }'

‍NOTE: Specify only the list of attributes to write in this command. Unspecified attributes will not be updated.

ApplicationMonitoring/ForceReadAttributes Command

MQTT Topic Pattern:

[PREFIX]/ApplicationMonitoring/Commands/ForceReadAttributes

MQTT Payload JSON Schema:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ApplicationMonitoring Cluster ForceReadAttributes Command Properties",
  "type": "object",
  "properties": {
    "value": {
      "type": "array"
      "items": {
        "type": "string",
        "enum": [
          "ApplicationName",
          "ApplicationVersion",
          "ApplicationConnected",
          "ApplicationMQTTTopics",
          "UptimeMinutes",
          "ProcessId",
          "Hostname",
          "FQDN",
          "MQTTLoggingEnabled",
          "MQTTLoggingLevel",
          "MQTTStatisticsReportingIntervalSeconds",
          "MQTTMessagesSent",
          "MQTTMessagesReceived",
          "MQTTSubscriptionCount",
          "MQTTAverageDeliveryTimeSeconds",
          "MQTTMinDeliveryTimeSeconds",
          "MQTTMaxDeliveryTimeSeconds",
          "ApplicationStatisticsReportingIntervalSeconds",
          "ApplicationCPUUsagePercent",
          "ApplicationCPUAverageUsagePercent",
          "ApplicationCPUMinUsagePercent",
          "ApplicationCPUMaxUsagePercent",
          "ApplicationRAMUsageMB"
        ]
      }
    }
  },
  "required": [
    "value"
  ]
}

Example Mosquitto CLI Tool Usage

To force read all ApplicationMonitoring attributes under the by-unid topic space (by sending an empty array):

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Commands/ForceReadAttributes' -m  '{ "value": [] }'

To force read one of the ApplicationMonitoring attributes under the by-unid topic space:

mosquitto_pub -t 'ucl/by-unid/<UNID>/<EP>/ApplicationMonitoring/Commands/ForceReadAttributes' -m  '{ "value": ["ApplicationName"] }'