Clarify watcher action uses PagerDuty API v2 #90800
Conversation
Specify which PagerDuty integration to select (given there isn't one called simply "API" any more). Also add a note to help avoid the confusion stemming from the fact that the watcher attributes still have names which seem to match the PagerDuty Events API v1 despite the fact that Elastic is actually now using v2 of that API. For reference: a ticket which I replied to, with a classic example of such confusion: elastic/kibana#63933 (comment)
|
Documentation preview: |
elasticsearchmachine
added
v8.6.0
needs:triage
kingherc
added
>docs
elasticsearchmachine
added
Team:Docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-data-management (Team:Data Management) |
kingherc
left a comment
kingherc
left a comment
There was a problem hiding this comment.
Looks good to me, have just one minor comment. It would also be nice if someone from the Data Management team reviews as well.
| . Log in to http://pagerduty.com[pagerduty.com] as an account administrator. | ||
| . Go to **Configuration > Services** and select the PagerDuty service. The | ||
| service must use the API integration. | ||
| service must use the **Events API V2** integration. |
There was a problem hiding this comment.
Would it be possible to update the below screenshot as well?
There was a problem hiding this comment.
Good point - to be honest I wonder if we should just remove both of the pagerduty UI screenshots on this page, given (a) they'll only go out of date again before long, and (b) they don't add that much really, the textual description should be sufficient.
I'll expand the written steps a bit to make sure it's super clear.
There was a problem hiding this comment.
That sounds good to me as well since the steps look straight forward.
There was a problem hiding this comment.
Fab, see latest commits (sorry for not doing it all in 1, I'm being lazy and doing this via the web UI given the machine I'm currently on)
There was a problem hiding this comment.
Thanks! I'll wait a couple of days before approving, just in case the Data Management team chips in their opinion.
...to match the current PagerDuty UI
kingherc
left a comment
kingherc
left a comment
There was a problem hiding this comment.
LGTM. I did not see any comments from the mentioned teams, so assuming this is fine to approve & merge.
Add a note to help avoid the confusion stemming from the fact that the watcher attributes still have names which seem to match the PagerDuty Events API v1 despite the fact that we are actually now using v2 of that API. Delete outdated screenshots Co-authored-by: Iraklis Psaroudakis <kingherc@gmail.com>
Add a note to help avoid the confusion stemming from the fact that the watcher attributes still have names which seem to match the PagerDuty Events API v1 despite the fact that we are actually now using v2 of that API. Delete outdated screenshots Co-authored-by: Iraklis Psaroudakis <kingherc@gmail.com>
Add a note to help avoid the confusion stemming from the fact that the watcher attributes still have names which seem to match the PagerDuty Events API v1 despite the fact that we are actually now using v2 of that API. Delete outdated screenshots Co-authored-by: Iraklis Psaroudakis <kingherc@gmail.com> Co-authored-by: Tom Sparrow <793763+sparrowt@users.noreply.github.com>
Add a note to help avoid the confusion stemming from the fact that the watcher attributes still have names which seem to match the PagerDuty Events API v1 despite the fact that we are actually now using v2 of that API. Delete outdated screenshots Co-authored-by: Iraklis Psaroudakis <kingherc@gmail.com> Co-authored-by: Tom Sparrow <793763+sparrowt@users.noreply.github.com>
5 participants
Specify which integration to choose in the PagerDuty UI (there isn't one called simply "API" any more).
Also add a note to help avoid the confusion stemming from the fact that the watcher attributes still have names which seem to match the PagerDuty Events API v1, despite the fact that Elastic is actually now using Events API v2 behind the scenes.
Closes #90799