Opsgenie

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

Configuration

The following configuration can be used to access the Opsgenie API.

plugins:
  opsgenie:
    - name: opsgenie
      displayName: Opsgenie
      description: On-call and alert management to keep services always on.
      apiUrl: api.eu.opsgenie.com
      apiKey: ${OPSGENIE_API_KEY}
      url: https://<your-organisation>.app.eu.opsgenie.com
      permissionsEnabled: false

Field	Type	Description	Required
name	string	Name of the Opsgenie instance.	Yes
displayName	string	Name of the Opsgenie instance as it is shown in the UI.	Yes
description	string	Description of the Opsgenie instance.	No
home	boolean	When this is true the plugin will be added to the home page.	No
apiKey	string	API Key for the Opsgenie API. More information can be found at API key management.	Yes
apiUrl	string	API URL for the Opsgenie API. Must be api.opsgenie.com or api.eu.opsgenie.com.	Yes
url	string	The address for the Opsgenie account of your organisation.	No
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

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. The default value is alerts.	No
query	string	The Opsgenie query. The documentation for the query language can be found in the Opsgenie Documentation.	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

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>.

Usage

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:
  id: team1@kobs.io
  permissions:
    plugins:
      - name: "opsgenie"
        permissions:
          - acknowledgeAlert
          - snoozeAlert
          - closeAlert