Monitoring

opscotch has in-built delivery of logs and operational metrics to your monitoring platform, or logs can be collected by your own monitoring systems.

The in-built monitoring delivery mechanism is configured in the bootstrap via the errorHandling. This includes options to:

• toggle local logging
• set the output destination for logs
• set the output destination for metrics
• define log redaction patterns to remove sensitive data

When an unhandled/unknown error occurs, opscotch will produce an error metric with the routingToken defined and metadata "error": true.

If you require a "heart beat" for an agent you can simply create a workflow step for that. For example:

{
    "workflows": [
        {
            "enabled": true,
            "name": "Agent Heart Beat",
            "steps": [
                {
                    "enabled": true,
                    "type": "scripted",
                    "stepId": "heartbeat",
                    "trigger" : {
                        "timer" : {
                            "period" : 60000
                        }
                    },
                    "resultsProcessor": {
                        "script": "context.sendMetric('heartbeat', 1.0)",
                    }
                }
            ]
        }
    ]
}