Monitoring with Amazon CloudWatch Logs

You can monitor Amazon Monitron live data export using Amazon CloudWatch Logs. When a measurement fails to export, Amazon Monitron will send a log event to your CloudWatch Logs. You can also set up a metric filter on the error log to generate metrics and set up alarms. An alarm can watch for certain thresholds and send notifications or take actions when those thresholds are met. For more information, see the CloudWatch User Guide.

Amazon Monitron sends log events to the /aws/monitron/data-export/{HASH_ID} log group.

The log event has the following JSON format:

{
    "assetName": "string",
    "destination": "string",
    "errorCode": "string",
    "errorMessage": "string",
    "eventId": "string",
    "eventType": "string",
    "positionName": "string",
    "projectName": "string",
    "projectId": "string",
    "sensorId": "string",
    "gatewayId": "string",
    "siteName": "string",
    "timestamp": "string"
}

assetName

• The asset name displayed in the app

• Type: String

destination

• The ARN of the Kinesis data stream

• Type: String

• Pattern: arn:aws:kinesis:{{REGION}}:{{AWS_ACCOUNT_ID}}:stream/{{STREAM_NAME}}

errorCode

• The error code

• Type: String

• Valid Values: INTERNAL_SEVER_ERROR | KINESIS_RESOURCE_NOT_FOUND | KINESIS_PROVISIONED_THROUGHPUT_EXCEEDED | KMS_ACCESS_DENIED | KMS_NOT_FOUND | KMS_DISABLED | KMS_INVALID_STATE | KMS_THROTTLING

errorMessage

• The detailed error message

• Type: String

eventId

• The unique event ID corresponding to each measurement export

• Type: String

eventType

• The current event type

• Type: String

• Valid values: measurement | gatewayConnected | gatewayDisconnected | sensorConnected | sensorDisconnected | assetStateTransition

positionName

• The sensor position name displayed in the app

• Type: String

projectName

• The project name displayed in the app and console

• Type: String

projectID

• The unique project ID corresponding to the Amazon Monitron project

• Type: String

sensorID

• The physical ID of the sensor from which the measurement is sent

• Type: String

gatewayID

• The physical ID of the gateway used to transmit data to the Amazon Monitron service

• Type: String

siteName

• The site name displayed in the app

• Type: String

timestamp

• The timestamp when the measurement is received by the Amazon Monitron service in UTC

• Type: String

• Pattern: yyyy-mm-dd hh:mm:ss.SSS