Skip to content

Support custom text for Pagerduty ChangeEvent “Summary” field #2

@akrapfl

Description

@akrapfl

Currently, a change event can be triggered anywhere in a pipeline job (even multiple times). It would be nice if the pipeline developer could pass alternate text for the Summary, so that a PagerDuty user can easily see what ChangeEvent occurred, not just a generic summary based on the job.

To further explain, consider the following use case:

Developer maintains a deployment pipeline that deploys to a production environment. The deployment takes about 10 minutes to complete. Developer wants a change event posted before AND after the deployment.

For example:

stage(‘production-deploy’){
  steps{
    pagerdutyChangeEvent(integrationKey: 'REDACTED', summaryText: 'DEPLOY STARTED for ProjectX v1.2.3')
    sh """
      echo '***simulate deployment***'
      sleep 600
    """
    pagerdutyChangeEvent(integrationKey: 'REDACTED' summaryText: 'DEPLOY COMPLETED for ProjectX v1.2.3')
  }
}

The current implementation (without summaryText) posts two identical change events 10 minutes apart.

Benefits:

  • provides context to the “what” that a change event represents (including version info, or other relevant details) without navigating to Jenkins
  • If a pageable event occurs during or after the deployment window, the deployment itself could be identified as a problem
  • User can still get link to the Jenkins job for further info.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions