Opsgenie

The Opsgenie plugin can be used to retrieve alerts and incidents from Opsgenie.

Configuration

To use the Opsgenie plugin the following configuration is needed in the satellites configuration file:

Field	Type	Description	Required
name	string	The name of the Opsgenie plugin instance.	Yes
type	opsgenie	The type for the Opsgenie plugin.	Yes
options.apiKey	string	API Key for the Opsgenie API. More information can be found at API key management.	Yes
options.apiUrl	string	API URL for the Opsgenie API. Must be api.opsgenie.com or api.eu.opsgenie.com.	Yes
options.permissionsEnabled	boolean	Enable / disable the permission handling for the Opsgenie plugin. More information regarding the permission handling can be found in the permissions section of the documentation.	No
frontendOptions.url	string	The address for the Opsgenie account of your organisation.	No

plugins:
  - name: opsgenie
    type: opsgenie
    options:
      apiKey:
      apiUrl:
      permissionsEnabled:
    frontendOptions:
      url:

Insight Options

Note

The Opsgenie plugin can not be used within the insights section of an application.

Variable Options

Note

The Opsgenie plugin can not be used to get a list of variable values.

Panel Options

The following options can be used for a panel with the Opsgenie plugin:

Field	Type	Description	Required
type	string	Specify if you want to show alerts or incidents.	Yes
query	string	The Opsgenie query. The documentation for the query language can be found in the Opsgenie Documentation.	No
queries	[]string	The Opsgenie queries. This can be used instead of the query field to display multiple queries within one panel.	No
interval	number	An optional interval in seconds, which should be used instead of the selected time range in the Dashboard to get the alerts / incidents for.	No

Notification Options

Field	Type	Description	Required
type	string	Specify if you want to show alerts or incidents.	Yes
query	string	The Opsgenie query. The documentation for the query language can be found in the Opsgenie Documentation.	Yes
interval	number	An optional interval in seconds, which should be used instead of the default interval of 90 days to get the alerts / incidents for.	No

Usage

Example Dashboard

For example the following dashboard shows all open alerts and incidents.

---
apiVersion: kobs.io/v1
kind: Dashboard
spec:
  rows:
    - size: -1
      panels:
        - title: Alerts
          colSpan: 6
          plugin:
            name: opsgenie
            options:
              type: alerts
              query: "status: open"
        - title: Incidents
          colSpan: 6
          plugin:
            name: opsgenie
            options:
              type: incidents
              query: "status: open"

Note

kobs automatically adds the createdAt >= <selected-start-time> AND createdAt <= <selected-end-time> to all Opsgenie queries, so that only results for the selected time range are shown.

This behaviour can be overwritten with the interval property. If the interval property is provided, we add createdAt >= <now - interval> AND createdAt <= <now>.

Permissions

When the auth middleware for kobs is enabled, it is possible to set the permissions for a user in the Opsgenie plugin. This way you can control if a user is allowed to use several actions for alerts / incidents, like closing alerts or resolving incidents.

For the Opsgenie plugin the following permissions can be set: acknowledgeAlert, snoozeAlert, closeAlert, resolveIncident and closeIncident. The specical value * can be used to allow all actions for a user / team.

For example all members of the following team can acknowledge, snooze and close alerts, but they are not allowed to resolve or close incidents.

---
apiVersion: kobs.io/v1
kind: Team
spec:
  group: team1@kobs.io
  permissions:
    plugins:
      - satellite: "*"
        name: opsgenie
        type: opsgenie
        permissions:
          - acknowledgeAlert
          - snoozeAlert
          - closeAlert