iksaif / opsgenie-notification Goto Github PK

Use this notification plugin to send alert events to your OpsGenie service.

The plugin requires one parameter:

• subject: This string will be set as the description for the generated incident.

Context variables usable in the subject line:

• ${job.id}: Job ID.
• ${job.status}: Job execution status (eg, FAILED, SUCCESS).
• ${job.project}: Job project name.
• ${job.name}: Job name.
• ${job.group}: Job group name.
• ${job.username}: User that executed the job.
• ${job.user.email}: Email address of user that executed the job.
• ${job.execid}: Job execution ID.
• ${job.retryAttempt}: Retry attempt number.
• ${job.wasRetry}: True if execution is retry.

Copy the groovy script to the plugins directory:

cp src/OpsGenieNotification.groovy to $RDECK_BASE/libext

and start using it!

The plugin only requires the 'api_key' configuration entry. There are also a few optional configurations.

• api_key: This is the API Key to your service.

Configure the api_key in your project configuration by adding an entry like so: $RDECK_BASE/projects/{project}/etc/project.properties

project.plugin.Notification.OpsGenieNotification.api_key=xx123049e89dd45f28ce35467a08577yz

Or configure it at the instance level: $RDECK_BASE/etc/framework.properties

framework.plugin.Notification.OpsGenieNotification.api_key=xx123049e89dd45f28ce35467a08577yz