Find out what Hyperglance rules are, and how you can use them to monitor your cloud setup
In this article, you'll learn:
- What a rule is
- Where to find rules
- How to create and edit rules, and set up notifications
- How to import/export rules
In Hyperglance, a Rule is an advanced search query that you can save, run continually, and use to automatically notify you if/when something is wrong.
Hyperglance comes preloaded with over 160 rules, all designed to ensure your cloud setup meets best practices.
In addition to the 160+ preloaded rules, you can create your own rules to implement your company's own policies and processes:
- Search for resources using any attribute and unlimited conditions
- Save your search query as a rule, giving it a name, description and label
- Set how often you'd like your rule to run, and its thresholds/triggers
- Choose how you'd like to be notified when the rule triggers (email, Slack webhook, AWS SNS, Azure Event Grid)
When you log in to Hyperglance, you can see all your rules on your dashboard:
From this view, you can quickly:
- See how many rules you have in total
- Filter by rule status (passed/failed)
- Filter by label or a string of text
- Hover over a rule's name to see its search criteria
- Select a rule to see its detailed view, including its search criteria and results
From the same view, you're also able to quickly carry out some key tasks by using the controls on the right-hand side.
These can be done on a rule-by-rule basis (icons located in the row), or in bulk against all the rules you have visible based on your filters (icons located in the column header).
|Edit a rule, or bulk-edit all your visible rules|
Manually run a rule, or bulk-run all your visible rules
|Delete a rule, or bulk-delete all your visible rules|
1. Head over to Advanced Search
2. In the left-hand side, enter the search criteria that identify the resources that you want to monitor, adding as many conditions as you like
To get the most from Advanced Search, we'd recommend reading this guide
3. Once you've entered your criteria, select 'Search'. Your results will appear in the table to the right-hand side of your search criteria.
4. When you're happy with the search criteria, you can save them as a rule by selecting 'Save As Rule'.
5. Add the information you'd like to accompany your search criteria:
- Name: A short description of your rule
- Description: An (optional) detailed description of your rule
- Labels: Categorise your rule by adding an existing label, or creating a new label.
- Notify when: Choose when a rule should notify you. The options are:
- Never: The rule will not run automatically, and won't ever notify you (useful to save time when searching in the future)
- Always: The rule will run to your schedule, and notify you every time (useful for creating scheduled reports)
- Status Changes: The rule will run to your schedule, and notify you if the status changes to passed OR failed
- Status Changes to Failure: The rule will run to your schedule, and notify you if the status changes to failed
6. If you've chosen to run your rule automatically, you'll then need to confirm how often the rule should run, and your notification preferences:
- Periodicity: How often will the rule run, e.g. once every 60 minutes
- Alert when: The threshold required for the rule to trigger. You can use less than AND greater than together, e.g. trigger when the number of results is greater than 0 and less than 20.
- Email (optional): One or more email addresses to send notifications to (separated by semicolons). To enable emails, you must also configure your SMTP settings in Hyperglance.
- Notify AWS SNS (optional)
- Topic ARN (required for AWS SNS): The Amazon Resource Name (ARN) for the SNS topic that Hyperglance will notify (required)
- Role ARN (optional): If provided, Hyperglance will perform an STS AssumeRole operation before attempting to publish to the SNS topic
- Notify Azure Event Grid (optional)
- Topic Endpoint (required for Event Grid):- The URL for the topic
- Auth Key (required for Event Grid): An authentication secret key to allow publishing to the topic
- Slack (optional)
- Incoming webhook URL (required for Slack): Your Slack app's incoming webhook URL
If you don't enter any notification options/methods, your rule will still run and its status will be visible inside Hyperglance.
7. Once you're happy with your rule settings, select 'Submit' to save your rule!
To edit a rule's name, labels, schedule, or notification settings:
- Select to edit (the pencil icon) a rule from your dashboard. This will load the edit rule view.
- Make your changes
- Select 'Submit' to save your rule changes
To edit the underlying search criteria of a custom rule:
- Select the rule from your dashboard. This will take you to the Advanced Search detail view.
- Edit your search criteria and 'Search' to show the updated results
- When you're happy with the updated criteria, select 'Update Rule' to save your changes
There are some other useful options to choose from here:
- Show in Diagram: View at your search results in a contextual diagram
- Save Rule As: Use this to save a new copy of a rule, particularly useful if you want to tweak the criteria of a 'read-only' preloaded rule that cannot be edited
- Edit Config: Use this to edit a rule's name, labels, schedule, or notification settings
- Export to CSV: Use this to export your search results as a CSV file
Exporting & Importing Rules
If you're running more than one instance of Hyperglance, you can keep your rules in synch by exporting and importing them from one instance to another.