Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for pagerduty watcher action needs updating re PagerDuty Events API v2 #90799

Closed
sparrowt opened this issue Oct 11, 2022 · 3 comments · Fixed by #90800
Closed
Labels
:Data Management/Watcher >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team

Comments

@sparrowt
Copy link
Contributor

Elasticsearch Version

7.17.1

Installed Plugins

No response

Java Version

bundled

OS Version

Cloud hosted linux but N/A as bug is documentation only

Problem Description

The documentation for the "Watcher PagerDuty action" says:

The service must use the API integration.

However on PagerDuty there is no longer any integration called simply "API", but rather various including "Events API v1" and "Events API v2".

It took me a long time to figure out which one was actually being used, especially because many of the attributes for the pagerduty watcher action have names which still match the PagerDuty Events API v1 (which Elastic originally used) even though Elastic now translates these and uses the PagerDuty Events API v2 behind the scenes (since #32285).

Steps to Reproduce

Visit the documentation here and try to follow it:
https://www.elastic.co/guide/en/elasticsearch/reference/master/actions-pagerduty.html

We should update the content, and also ideally backport that to e.g:
https://www.elastic.co/guide/en/elasticsearch/reference/8.4/actions-pagerduty.html
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/actions-pagerduty.html

Logs (if relevant)

No response

@sparrowt sparrowt added >bug needs:triage Requires assignment of a team area label labels Oct 11, 2022
@sparrowt
Copy link
Contributor Author

I've opened #90800 and (hopefully successfully!) signed the CLA.

@kingherc kingherc added >docs General docs changes :Data Management/Watcher Team:Data Management Meta label for data/management team and removed >bug labels Oct 11, 2022
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team and removed needs:triage Requires assignment of a team area label labels Oct 11, 2022
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-data-management (Team:Data Management)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Watcher >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants