Overview
opEvents panels Event Panels are customisable views that allow you to create filtered perspectives of your event data. Each panel appears as an option in the Panels dropdown menu in the opEvents interface, giving users quick access to their these specialised event views.
Configuration
Location
...
Panels are configured in the /usr/local/omk/conf/EventsPanels.json file. This file contains a JSON object where each key represents a unique panel configuration. You can define multiple panels within this single configuration file, and they will all appear in the Panels dropdown menu in the order they're defined.
This file will not exist on a fresh install.
Basic Structure
| Code Block | ||
|---|---|---|
| ||
{
"panel-identifier-1": {
"title": "First Panel",
"description": "Description of first panel",
"model": "events",
"filter": {
"field": "filter_expression"
}
},
"panel-identifier-2": {
"title": "Second Panel",
"description": "Description of second panel",
"model": "events",
"filter": {
"field": "filter_expression"
}
}
} |
...
Field | Type | Required | Description |
|---|---|---|---|
| string | Yes | The display name of the panel shown as the title |
| string | Yes | Description of the panel shown in navigation |
| string | Yes | Data model to use (currently "events") |
| object | Yes | Collection of field:filter_expression pairs |
| string | No | If you wish to use custom table schema. See Customising Table Schemas |
...
The filter object supports several types of matching, giving you flexibility in how you filter your events. You can choose the matching method that best suits your needs:
...
Exact value matches (e.g.,
state = "Up")Specific locations (e.g.,
nodeinfo.configuration_location = "Melbourne")
When to Use Regular Expressions
...
Choose the simplest matching method that meets your needs. Simple string matching is more straightforward to understand and maintain, so use it when possible. Save regular expressions for when you need their pattern-matching power.
Filter Examples
Some common filter examples to utilise:
“event”: Event Name
“node”: Node Name
“nodeinfo.configuration_group”: Group
“nodeinfo.configuration_location”: Location
“nodeinfo.configuration_customer”: Customer
"nodeinfo.configuration_role": Role