Skip to main content

Custom Runbook

A Custom runbook runs a GO or Python script directly on the ObserveOps agent that polls the monitor, with no fixed protocol binding. Use it when none of the typed runbooks fit, for example when the task combines multiple protocols, calls a cloud SDK, or shells out to a local binary.

When to Use​

  • The task does not fit SSH, Telnet, Powershell, SNMP, Trace Route, Database, or HTTP alone.
  • The script needs to call a cloud provider SDK (AWS, Azure, GCP, Office 365, VMware vCenter).
  • The script needs to orchestrate several steps in one run.
  • The task is a messaging integration (Google Chat, Telegram, WhatsApp, Teams webhook).

Fields​

FieldWhat to enter
Runbook NameA short, unique name.
DescriptionOne line on what the runbook returns or does.
Runbook CategoryDiagnostics, Performance Monitoring, Troubleshooting, System Management, Log Collection, Network Config, or Integration.
MonitorPick by Group, Tag, IP/Host, or Monitors.
Credential ProfileOptional. If the script needs secrets, point it at a credential profile and read the fields from the script context.
PortOptional. Use only when the script connects on a specific port.
TimeoutSeconds to wait before marking the run Failed.
Script LanguageGO or Python.
ScriptThe script the agent executes. There is no separate parsing script; return values are emitted by the script itself.
Add VariablePrompts the user for a value at run time. Reference it as $$$variable.name$$$ in the script.

note

Custom runbooks run inside the ObserveOps agent process on the server that polls the monitor. The script runs with the agent's permissions. Keep the script idempotent for fix tasks, and do not log secrets.

Steps​

  1. Open Settings > Plugin Library > Runbook and click Create Runbook Plugin.
  2. Pick Custom from the top menu.
  3. Fill in the fields above.
  4. Click Test to run the script once against the chosen monitor.
  5. Review the output. Adjust the script until the return values are correct.
  6. Click Save.