[DOCS] Alerting PagerDuty benefits #63652

gchaps · 2020-04-16T00:07:47Z

Summary

This PR adds information about integrating PagerDuty with Elastic Alerts.

Preview
http://kibana_63652.docs-preview.app.elstc.co/diff

alexfrancoeur

Just ran through these instructions in Kibana and added a two comments. With those changes, this LGTM! Any chance we can get this merged by end of week? cc: @arisonl

alexfrancoeur · 2020-04-16T20:32:18Z

docs/user/alerting/action-types/pagerduty.asciidoc

+* Alternatively, create a connector by navigating to Management from the {kib} navbar and selecting
+*Alerts and Actions*. Then select the *Connectors* tab, click on the *Create connector* button, and select the PagerDuty option.
+
+. Enter a name for the connector, the API URL, and the Routing Key.


The API URL seems to be optional. Maybe we call that out what the default is here?

docs/user/alerting/action-types/pagerduty.asciidoc

alexfrancoeur

The changes look good to me @gchaps. I dropped in a few suggestions as well. Given that the changes are a little larger than originally expected, I added @arisonl as a reviewer. Aris, let us know what you think.

alexfrancoeur · 2020-04-17T00:58:16Z

docs/user/alerting/action-types/pagerduty.asciidoc

+[[pagerduty-how-it-works]]
+==== How it works
+
+{kib} allows you to create threshold alerts to notify you of a significant move


To avoid continual updates in the docs, I'd vote to keep a few of these sentences more generic than they are right now. {kib} allows you to create alerts to notify you of a significant move. What do you think @arisonl ?

alexfrancoeur · 2020-04-17T00:59:49Z

docs/user/alerting/action-types/pagerduty.asciidoc

+
+{kib} allows you to create threshold alerts to notify you of a significant move
+in your datasets. You can create alerts of a generic type that you can use for all your indices.
+You can also create specific alerts for Observability and SIEM.


In a similar vein, what about replacing

in your datasets. You can create alerts of a generic type that you can use for all your indices. You can also create specific alerts for Observability and SIEM.

with

You can create alerts for all your Observability, Security and Stack use cases

@gchaps @arisonl

alexfrancoeur · 2020-04-17T01:02:44Z

docs/user/alerting/action-types/pagerduty.asciidoc

+* Alternatively, create a connector by navigating to *Management* from the {kib} navbar and selecting
+*Alerts and Actions*. Then, select the *Connectors* tab, click the *Create connector* button, and select the PagerDuty option.
+
+. Configure the connector by giving it a name and entering the API URL and Routing Key.


I've learned that the API URL is optional, so it might be worth calling out here.

Configure the connector by giving it a name, using the default or optional API URL and Routing Key.

@arisonl @gchaps probably not the best phrasing, but does it make sense to call out that it's optional without having to click into the config docs? I actually opened an issue for this to fix in product: #63768

@alexfrancoeur are both the API URL and Routing Key optional, or just the API URL?

arisonl

Only question for me at this point is whether we should replace "Elastic Alerts" references with "Kibana Alerts".

mikecote

LGTM! Thanks for enhancing the docs!

docs/user/alerting/action-types/pagerduty.asciidoc

Co-Authored-By: Mike Côté <[email protected]>

alexfrancoeur

@gchaps @arisonl I added suggestions to replace "Elastic Alerts" with more generic alerting references. It feels more natural to have in our docs vs. explicitly calling out Elastic or Kibana. If you come from our documentation, you already have context that you're looking at Elastic and Kibana documentation. The title for alerting is "Alerting and actions", not "Kibana / Elastic alerting and actions". It felt redundant and I propose we simplify. If you're coming direction from PagerDuty's integration, you'll have full context as the integration will be called "Elastic Alerts" to describe the company and functionality. Taking this approach also aligns with the subscription page and "Kibana alerts" syntax as the alerting documentation is nested under Kibana.

alexfrancoeur · 2020-04-18T17:16:40Z

docs/user/alerting/action-types/pagerduty.asciidoc

+[[pagerduty-benefits]]
+=== PagerDuty + Elastic integration benefits
+
+By integrating PagerDuty with Elastic Alerts, you can:


"By integrating PagerDuty with alerting, you can"

alexfrancoeur · 2020-04-18T17:16:54Z

docs/user/alerting/action-types/pagerduty.asciidoc

+
+By integrating PagerDuty with Elastic Alerts, you can:
+
+* Route your Elastic Alerts to the right PagerDuty responder within your team, based on your structure, escalation policies, and workflows.


"Route your alerts to the right PagerDuty responder within your team, based on your "

alexfrancoeur · 2020-04-18T17:17:32Z

docs/user/alerting/action-types/pagerduty.asciidoc

+{kib} allows you to create alerts to notify you of a significant move
+in your dataset.
+You can create alerts for all your Observability, Security, and Elastic Stack use cases.
+Elastic Alerts triggers a new incident on the corresponding PagerDuty service.


"Alerts will trigger a new incident on the corresponding PagerDuty service"

alexfrancoeur · 2020-04-18T17:17:47Z

docs/user/alerting/action-types/pagerduty.asciidoc

+application privileges to access Metrics, APM, Uptime, or SIEM.
+* If you are using a self-managed deployment with security, you must have
+Transport Security Layer (TLS) enabled for communication <<configuring-tls-kib-es, between Elasticsearch and Kibana>>.
+Elastic Alerts uses API keys to secure background alert checks and actions,


"Alerting uses API keys to secure background alert checks and actions,"

elasticmachine · 2020-04-20T15:38:38Z

Pinging @elastic/kibana-docs (Team:Docs)

* [DOCS] Alerting PagerDuty benefits * [DOCS] Fixes broken link * [DOCS] Organization changes * [DOCS] Changes to meet template and incorporate review comments * [DOCS] Fixed formatting of bulleted list * [DOCS] Incorporates review comments * Update docs/user/alerting/action-types/pagerduty.asciidoc Co-Authored-By: Mike Côté <[email protected]> * [DOCS] Fixes naming and other formatting issues Co-authored-by: Mike Côté <[email protected]>

* [DOCS] Alerting PagerDuty benefits * [DOCS] Fixes broken link * [DOCS] Organization changes * [DOCS] Changes to meet template and incorporate review comments * [DOCS] Fixed formatting of bulleted list * [DOCS] Incorporates review comments * Update docs/user/alerting/action-types/pagerduty.asciidoc Co-Authored-By: Mike Côté <[email protected]> * [DOCS] Fixes naming and other formatting issues Co-authored-by: Mike Côté <[email protected]> Co-authored-by: Mike Côté <[email protected]>

gchaps added 3 commits April 15, 2020 17:04

[DOCS] Alerting PagerDuty benefits

1e00e34

[DOCS] Fixes broken link

834a680

[DOCS] Organization changes

b0b78a6

alexfrancoeur approved these changes Apr 16, 2020

View reviewed changes

gchaps added 2 commits April 16, 2020 15:18

[DOCS] Changes to meet template and incorporate review comments

f3a1c3f

[DOCS] Fixed formatting of bulleted list

a0c330e

alexfrancoeur requested review from arisonl and mikecote April 17, 2020 00:55

alexfrancoeur approved these changes Apr 17, 2020

View reviewed changes

[DOCS] Incorporates review comments

85781c3

arisonl approved these changes Apr 17, 2020

View reviewed changes

mikecote approved these changes Apr 17, 2020

View reviewed changes

docs/user/alerting/action-types/pagerduty.asciidoc Outdated Show resolved Hide resolved

Update docs/user/alerting/action-types/pagerduty.asciidoc

203660d

Co-Authored-By: Mike Côté <[email protected]>

alexfrancoeur approved these changes Apr 18, 2020

View reviewed changes

gchaps added 2 commits April 20, 2020 08:07

[DOCS] Fixes naming and other formatting issues

b4ae889

[DOCS] Fixes problem in doc

a80c31b

gchaps marked this pull request as ready for review April 20, 2020 15:37

gchaps added release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.7.0 v7.8.0 v8.0.0 labels Apr 20, 2020

gchaps merged commit d45d780 into elastic:master Apr 20, 2020

gchaps deleted the docs/pagerduty branch April 20, 2020 16:09

gchaps mentioned this pull request Apr 20, 2020

[7.x] [DOCS] Alerting PagerDuty benefits (#63652) #63973

Merged

gchaps mentioned this pull request Apr 20, 2020

[7.7] [DOCS] Alerting PagerDuty benefits (#63652) #63975

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS] Alerting PagerDuty benefits #63652

[DOCS] Alerting PagerDuty benefits #63652

gchaps commented Apr 16, 2020 •

edited

Loading

alexfrancoeur left a comment

alexfrancoeur Apr 16, 2020

alexfrancoeur left a comment

alexfrancoeur Apr 17, 2020

alexfrancoeur Apr 17, 2020

gchaps Apr 17, 2020

alexfrancoeur Apr 17, 2020

gchaps Apr 17, 2020

arisonl left a comment

mikecote left a comment

alexfrancoeur left a comment

alexfrancoeur Apr 18, 2020

alexfrancoeur Apr 18, 2020 •

edited

Loading

alexfrancoeur Apr 18, 2020

alexfrancoeur Apr 18, 2020

elasticmachine commented Apr 20, 2020


		By integrating PagerDuty with Elastic Alerts, you can:

		* Route your Elastic Alerts to the right PagerDuty responder within your team, based on your structure, escalation policies, and workflows.

[DOCS] Alerting PagerDuty benefits #63652

[DOCS] Alerting PagerDuty benefits #63652

Conversation

gchaps commented Apr 16, 2020 • edited Loading

Summary

alexfrancoeur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexfrancoeur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arisonl left a comment

Choose a reason for hiding this comment

mikecote left a comment

Choose a reason for hiding this comment

alexfrancoeur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexfrancoeur Apr 18, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Apr 20, 2020

gchaps commented Apr 16, 2020 •

edited

Loading

alexfrancoeur Apr 18, 2020 •

edited

Loading