Agent Status

Agent Status

The agentStatus command line utility supports field deployments through simplified debugging of field issues.

Calling Methods

Via an Interactive Shell:

$ sudo docker exec -it <CONTAINER ID> /bin/bash --login
# agentStatus help

Via Docker Exec:

$ sudo docker exec <CONTAINER ID> /usr/bin/agentStatus help

Using the Command

The agentStatus command uses module group functionalities : agentStatus <MODULE>.

There are general modules that can be found on all agents and specific modules for measurements.

Getting Help

For general help:

# agentStatus help

For module-specific help:

# agentStatus <MODULE> help

Data Module

Commands relating to the data path:

stats      
status     Show status of data reporting status.
output     Show current data output settings.
output log (enable|disable)   Enable or disable data output in the container log.
output mqtt (enable|disable)   Enable or disable data output to the internal MQTT broker.
                              Topic is "debug/performancedata/openmetric".

debug                     Show debug status.
debug (enable|disable)    Enable or disable debugging.
debug <value>             Set debug level (engineering).
debug lws <LWS_LEVEL>     Set websocket debug level (engineering).
                         LWS_LEVEL: any combination of: err, info, warn, 
                           notice, debug, parser, header, ext, client, latency  , default

Example:

# agentStatus data status
{
        "connection":   {
                "DataBrokerServerPort": 55888,
                "AuthenticationError":  "",
                "LastTransmissionTime": "Never",
                "LastTransmissionTimeAck":      "Never",
                "LastConnectionTime":   "Never",
                "LastDisconnectionTime":        "Never",
                "LastAuthenticationTime":       "Never",
                "ssl":  {
                        "Enabled":      true,
                        "AllowSelfSigned":      true,
                        "AllowInsecureCerts":   false,
                        "SkipHostnameCheck":    true,
                        "AllowExpiredCerts":    false
                }
        },
        "MeasurementState":     "Disconnected",
        "DataBrokerQueueDepth": 1000,
        "RingBatchWaiting":     999
}

# agentstatus data stats
{
        "dataGatewayStats":     {
                "streamSizeMax":        1879,
                "toBrokerTxCount":      268,
                "toBrokerTxBytes":      263043,
                "toBrokerConnection":   1,
                "toBrokerConnectionError":      0,
                "toBrokerConnectionEstablished":        1,
                "toBrokerConnectionClosed":     0,
                "toBrokerConnectionShutdown":   0,
                "toBrokerSendIdentification":   1,
                "toBrokerInFlightMaxCount":     13,
                "toBrokerATO":  0,
                "toBrokerATOLimitReached":      0,
                "toBrokerAuthenticationSuccessful":     1,
                "toBrokerAuthenticationError":  0,
                "toBrokerAuthenticationFailure":        0,
                "toBrokerAuthenticationUnknown":        0,
                "toBrokerAuthenticationRenew":  0
        }
}

Management Module

Commands relating to the management path:

authentication  Show current authentication token information.
configuration   Show current active configuration receied from Sensor Orchestrate.
stats
status          Show current connection status to the management interface.

debug                     Show debug status.
debug (enable|disable)    Enable or disable debugging.
debug <value>             Set debug level (engineering).
debug lws <LWS_LEVEL>     Set websocket debug level (engineering).
                          LWS_LEVEL: any combination of: err, info, warn,
                            notice, debug, parser, header, ext, client, latency, default

Example:

# agentStatus management status
{
        "connection":   {
                "AuthenticationError":  "",
                "LastConfigUpdate":     "Never",
                "LastConnectionTime":   "Tue 15 March 2022 14:27:11 UTC",
                "LastDisconnectionTime":        "Never",
                "LastAuthenticationTime":       "Tue 15 March 2022 14:27:17 UTC",
                "ssl":  {
                        "Enabled":      true,
                        "AllowSelfSigned":      true,
                        "AllowInsecureCerts":   false,
                        "SkipHostnameCheck":    true,
                        "AllowExpiredCerts":    false
                }
        },
        "ManagementState":      "Waiting for config",
        "TenantId":     "",
        "ConfigId":     "",
        "ConfigRevision":     "",
        "ManagementServer":   "192.1.1.2",
        "ManagementPort":     55778
}

# agentStatus management stats
{
        "managementStats":      {
                "toProxyTxCount":       0,
                "toProxyTxBytes":       0,
                "toProxyConnection":    1,
                "toProxyConnectionError":       0,
                "toProxyConnectionEstablished": 1,
                "toProxyConnectionClosed":      0,
                "toProxyConnectionShutdown":    0,
                "toProxySendIdentification":    0,
                "toProxyAuthenticationSuccessful":      0,
                "toProxyAuthenticationError":   0,
                "toProxyAuthenticationFailure": 0,
                "toProxyAuthenticationUnknown": 0,
                "toProxyAuthenticationRenew":   0,
                "fromProxyRxCount":     0,
                "fromProxyRxBytes":     0,
                "fromProxyRxError":     0,
                "fromProxyRxMessageConfig":     0,
                "fromProxyRxMessageAuthenticationReply":        0,
                "fromProxyRxMessageCommandRun": 0,
                "fromProxyRxMessageCommandStart":       0,
                "fromProxyRxMessageCommandStop":        0,
                "fromProxyRxMessageCommandError":       0,
                "fromProxyRxMessageCommandUnknown":     0
        }
}

System Module

Commands related to the agent:

status          Show system status.

Example:

# agentStatus system status
{
        "AgentId":      "74fbdd77-8997-410f-8789-f8adb2ee8927",
        "agentType":    "actuate",
        "version":      "skylight-agent-actuate-amd64_22.04_2",
        "description":  "Accedian Networks skylight-agent-actuate-amd64 22.04_2",
        "InternalMqttPort":     1883
}

Monitor

The monitor is the agent's parent process. It is responsible for starting and monitoring processes.

Available commands:

    status                Show monitor's status.
    process list          List currently monitored processes.
    process stats         Display statistics for all monitored processes.
    process uuid <UUID>   Display process control block of the matching the UUID.
    process name <name>   Display process control block of the first matching name.