- X-Pack Reference for 6.0-6.2 and 5.x:
- Introduction
- Setting Up X-Pack
- Breaking Changes
- X-Pack APIs
- Graphing Connections in Your Data
- Profiling your Queries and Aggregations
- Reporting from Kibana
- Securing the Elastic Stack
- Getting Started with Security
- How Security Works
- Setting Up User Authentication
- Configuring SAML Single-Sign-On on the Elastic Stack
- Configuring Role-based Access Control
- Auditing Security Events
- Encrypting Communications
- Restricting Connections with IP Filtering
- Cross Cluster Search, Tribe, Clients and Integrations
- Reference
- Monitoring the Elastic Stack
- Alerting on Cluster and Index Events
- Machine Learning in the Elastic Stack
- Troubleshooting
- Getting Help
- X-Pack security
- Can’t log in after upgrading to 6.2.4
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- X-Pack Watcher
- X-Pack monitoring
- X-Pack machine learning
- Limitations
- License Management
- Release Notes
WARNING: Version 6.2 of the Elastic Stack has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
PagerDuty Action
editPagerDuty Action
editUse the PagerDuty action to create events in
PagerDuty. To create PagerDuty events, you must configure at least one PagerDuty account in elasticsearch.yml
.
Configuring PagerDuty Actions
editYou configure PagerDuty actions in the actions
array. Action-specific attributes
are specified using the pagerduty
keyword.
The following snippet shows a simple PagerDuty action definition:
Adding Meta Information to a PagerDuty Incident
editTo give the PagerDuty incident some more context, you can attach the payload as well as an array of contexts to the action.
"actions" : { "notify-pagerduty" : { "throttle_period" : "5m", "pagerduty" : { "account" : "team1", "description" : "Main system down, please check! Happened at {{ctx.execution_time}}" "attach_payload" : true, "client" : "/foo/bar/{{ctx.watch_id}}", "client_url" : "http://www.example.org/", "contexts" : [ { "type": "link", "href": "http://acme.pagerduty.com" },{ "type": "link", "href": "http://acme.pagerduty.com", "text": "View the incident on {{ctx.payload.link}}" } ] } } }
Pagerduty Action Attributes
editName | Required | Description |
---|---|---|
|
no |
The account to use, falls back to the default one.
The account needs a |
Table 32. Pagerduty Event Trigger Incident Attributes
Name | Required | Description |
---|---|---|
|
yes |
A quick description for this event |
|
no |
The event type to sent. Must be one of |
|
no |
The incident key on the pagerduty side, also used for de-duplication and allows to resolve or acknowledge incidents. |
|
no |
Name of the client triggering the incident, i.e.
|
|
no |
A client URL to visit to get more detailed information. |
|
no |
If set to |
|
no |
An array of objects, that allow you to provide additional links or images in order to provide more context to the trigger. |
|
no |
The proxy host to use (only in combination with |
|
no |
The proxy port to use (only in combination with |
You can configure defaults for the above values for the whole service using the
xpack.notification.pagerduty.event_defaults.*
properties as well as
per account using xpack.notification.pagerduty.account.your_account_name.event_defaults.*
All of those objects have templating support, so you can use data from the context and the payload as part of all the fields.
Configuring PagerDuty Accounts
editYou configure the accounts Watcher uses to communicate with PagerDuty in
the xpack.notification.pagerduty
namespace in elasticsearch.yml
.
To configure a PagerDuty account, you need the API integration key for the PagerDuty service you want to send notifications to. To get the key:
- Log in to pagerduty.com as an account administrator.
-
Go to Configuration > Services and select the PagerDuty service. The service must use the API integration.
-
Click the Integrations tab and copy the API integration key.
To configure a PagerDuty account in elasticsearch.yml
, at a minimum you
must specify an account name and integration key:
xpack.notification.pagerduty: account: my_pagerduty_account: service_api_key: d3b07384d113edec49eaa6238ad5ff0
You can also specify defaults for the PagerDuty event attributes: .
xpack.notification.pagerduty: account: my_pagerduty_account: service_api_key: d3b07384d113edec49eaa6238ad5ff0 event_defaults: description: "Watch notification" incident_key: "my_incident_key" client: "my_client" client_url: http://www.example.org event_type: trigger attach_payload: true
If you configure multiple PagerDuty accounts, you either need to set a default
account or specify which account the event should be sent with in the
pagerduty
action.
xpack.notification.pagerduty: default_account: team1 account: team1: ... team2: ...
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now