{"_id":"55e7b3e86f626a0d0084ae05","category":{"_id":"55d3b645f77e6d0d00b1b274","__v":2,"pages":["55d3b649f77e6d0d00b1b29c","55e7b3e86f626a0d0084ae05"],"project":"55c505b41469ad2500fa2ab7","version":"55d3b644f77e6d0d00b1b273","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-11T00:52:57.334Z","from_sync":false,"order":0,"slug":"overview","title":"Overview"},"user":"55c50e9ca13abc25008c9088","__v":11,"parentDoc":null,"project":"55c505b41469ad2500fa2ab7","version":{"_id":"55d3b644f77e6d0d00b1b273","project":"55c505b41469ad2500fa2ab7","__v":6,"createdAt":"2015-08-18T22:48:36.632Z","releaseDate":"2015-08-18T22:48:36.632Z","categories":["55d3b645f77e6d0d00b1b274","55d3b645f77e6d0d00b1b275","55d3b645f77e6d0d00b1b276","55d3b645f77e6d0d00b1b277","55d3b645f77e6d0d00b1b278","55d3b645f77e6d0d00b1b279","55d3b645f77e6d0d00b1b27a","55d3b645f77e6d0d00b1b27b","55d3b645f77e6d0d00b1b27c","55d3b645f77e6d0d00b1b27d","55d7c2939510f00d007ec6fe","56fac9925df15a20002972a2","56fb2f7668e1d30e00a0b672","583498d411e8af2500f6b334","58e52a180ab7b03b00f4a97a"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"updates":["55e8a48a656faf0d00556c60"],"next":{"pages":[],"description":""},"createdAt":"2015-09-03T02:43:52.838Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"## What is a Rule?\nRule is composed of a trigger and an action. Neptune will automatically perform the configured action whenever the trigger is raised. \n \n##What is a Trigger? \nTrigger is usually an alert coming from your existing monitoring tool. We also support custom triggers like webhooks and scheduled cron triggers. \n\n## What is an Action?\nAn Action is executed when a trigger gets raised as defined in the rule. We currently support various actions types including Execute script actions (on a single host or cluster of hosts), REST API actions, CLI actions, and Email runbook actions.\n\n## What is an Agent?\nAgent is a piece of software that sits on a server and is responsible for executing scripts on that server and sending the results back to Neptune. Agent doesn’t require opening any incoming firewall ports – it only requires outbound connection for port 443. \n\n## What is an Alarm?\nAlarm is a violation condition defined in your monitoring tool that requires some human or machine intervention. For example, disk utilization exceeds 99%, memory usage exceeds 95% etc. \n\n## What is an Incident?\nIncident is an instance of an alarm configured in monitoring tool. Usually monitoring tool alerts you whenever an alarm triggers and an incident is created in your ticketing system \n\n## What is a Runbook?\nRunbook is a series of prescriptive steps to remediate an incident. \n\n## What is an incident dashboard?\nIncident dashboard shows all the open incidents and interesting statistics around historical incidents. 1) Which alarms are triggering the most (Frequency) and 2) Which alarms are causing the most damage - in terms of MTTR","excerpt":"","slug":"key-concepts","type":"basic","title":"Key concepts"}
## What is a Rule? Rule is composed of a trigger and an action. Neptune will automatically perform the configured action whenever the trigger is raised. ##What is a Trigger? Trigger is usually an alert coming from your existing monitoring tool. We also support custom triggers like webhooks and scheduled cron triggers. ## What is an Action? An Action is executed when a trigger gets raised as defined in the rule. We currently support various actions types including Execute script actions (on a single host or cluster of hosts), REST API actions, CLI actions, and Email runbook actions. ## What is an Agent? Agent is a piece of software that sits on a server and is responsible for executing scripts on that server and sending the results back to Neptune. Agent doesn’t require opening any incoming firewall ports – it only requires outbound connection for port 443. ## What is an Alarm? Alarm is a violation condition defined in your monitoring tool that requires some human or machine intervention. For example, disk utilization exceeds 99%, memory usage exceeds 95% etc. ## What is an Incident? Incident is an instance of an alarm configured in monitoring tool. Usually monitoring tool alerts you whenever an alarm triggers and an incident is created in your ticketing system ## What is a Runbook? Runbook is a series of prescriptive steps to remediate an incident. ## What is an incident dashboard? Incident dashboard shows all the open incidents and interesting statistics around historical incidents. 1) Which alarms are triggering the most (Frequency) and 2) Which alarms are causing the most damage - in terms of MTTR