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

[Alerting] Add list of valid connectors to alerting rules docs #3690

Merged
merged 3 commits into from
Mar 22, 2024

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Mar 20, 2024

Updates stateful docs for #3659.

This change needs to be ported to serverless, too. I'm going to wait on porting this to serverless because I need to cleanup inconsistencies first and sync with Lisa on how to best handle the connector links.

TODOs:

  • Add list of supported connectors.
  • Verify that all connectors in the list are supported for each rule.

@dedemorton dedemorton self-assigned this Mar 20, 2024
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented Mar 20, 2024

This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Mar 20, 2024
@dedemorton
Copy link
Contributor Author

@lcawl I need you input on a couple of things:

  • What do you think of providing links to the connector docs (as I've done in this PR)? The benefit is that it shows all valid connectors for the observability alerting rules. The downside (as always) is maintenance, but since all the observability alerts seem to support the same set of connectors, it doesn't seem like a big challenge, and it helps users find the info in the Kibana docs.
  • It seems like the docs have diverged a lot in how we introduce the concept of connectors (obs guide vs serverless vs Kibana). What do you prefer? I don't have time to do a lot of reconciling/consistifying right now.

@lcawl
Copy link
Contributor

lcawl commented Mar 20, 2024

  • What do you think of providing links to the connector docs (as I've done in this PR)? The benefit is that it shows all valid connectors for the observability alerting rules. The downside (as always) is maintenance, but since all the observability alerts seem to support the same set of connectors, it doesn't seem like a big challenge, and it helps users find the info in the Kibana docs.

I think like you said the trick will be keeping that list up-to-date. Connectors come into the platform from many directions (e.g. user-contributed or initiated by the responseOps team or by one of the solution teams), so they sometimes sneak up on me. As long as this Observability-specific list is somewhere we know to update every time a new connector is added, it shouldn't be too bad, however.

  • It seems like the docs have diverged a lot in how we introduce the concept of connectors (obs guide vs serverless vs Kibana). What do you prefer? I don't have time to do a lot of reconciling/consistifying right now.

I think it's more divergent than ever now because (at least the last time I checked) in Serverless, each solution/project has a different subset of connectors that it supports. So this will definitely require some thinking once we get our connector pages migrated into docsmobile (i.e. are there some that apply to multiple projects, will this change over time, how does this affect their placement in the navigation?). Connectors are also used by cases, so we don't want to tie connectors exclusively to our rule-related content.

It used to be that after you'd chosen a connector, the action-related options you'd see would also vary depending on your rule type (e.g. can you do action summaries, can you specify a time filter or additional KQL filters, etc) but that disparity is disappearing as we roll out the "alerts as data" features across all the solutions. I think we still won't be able to cut and paste the same info across all rules (or if we do, we'll still need rule-specific screenshots), however, because the default message that appears in each rule (and the specific action variables it contains) differs for each rule. If you want to chat further about the short-term and long-term ways we can improve on this, I'm game.

@dedemorton dedemorton changed the title Add list of valid connectors to alerting rules docs [Alerting] Add list of valid connectors to alerting rules docs Mar 21, 2024
@dedemorton
Copy link
Contributor Author

I should have clarified that my main goal here is to remove the screen capture and replace it with a list because the screen capture doesn't show anything unique about the UI. It seems like the main purpose is to identify the list of valid connectors, but that means the info isn't accessible for the visually impaired. So, I've added a list with links and removed the screenshots.

After we have a clear content strategy for shared content, we'll probably need to revisit this decision. I'm going to mark this as ready for review with the understanding that we may take a different tack after we've had a chance to put more thought into how all the Alerting docs should work together and be supported by shared info (like the connector docs).

@dedemorton dedemorton marked this pull request as ready for review March 21, 2024 01:22
@dedemorton dedemorton requested a review from a team as a code owner March 21, 2024 01:22
@dedemorton dedemorton added the backport-8.13 Automated backport with mergify label Mar 21, 2024
@mergify mergify bot removed the backport-skip Skip notification from the automated backport with mergify label Mar 21, 2024
@dedemorton dedemorton merged commit 5aee599 into elastic:main Mar 22, 2024
3 checks passed
@dedemorton dedemorton deleted the issue#3659 branch March 22, 2024 19:39
mergify bot pushed a commit that referenced this pull request Mar 22, 2024
* Add list of valid connectors to alerting rules docs

* Resolve and remove reviewer questions

(cherry picked from commit 5aee599)
dedemorton added a commit that referenced this pull request Mar 22, 2024
* Add list of valid connectors to alerting rules docs

* Resolve and remove reviewer questions
bmorelli25 pushed a commit that referenced this pull request Mar 22, 2024
#3703)

* Add list of valid connectors to alerting rules docs

* Resolve and remove reviewer questions

Co-authored-by: DeDe Morton <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.13 Automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants