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

[AutoOps] Reference AutoOps solution on troubleshooting pages #119630

Merged
merged 8 commits into from
Jan 9, 2025

Conversation

alaudazzi
Copy link
Contributor

@alaudazzi alaudazzi commented Jan 7, 2025

This PR updates the troubleshooting pages to reference AutoOps as the go-to solution.
Relates to https://github.com/elastic/obs-docs-projects/issues/279

@alaudazzi alaudazzi added >docs General docs changes Team:Docs Meta label for docs team labels Jan 7, 2025
@alaudazzi alaudazzi requested a review from arnonst January 7, 2025 09:04
@alaudazzi alaudazzi self-assigned this Jan 7, 2025
Copy link
Contributor

github-actions bot commented Jan 7, 2025

Documentation preview:

@elasticsearchmachine
Copy link
Collaborator

@alaudazzi please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation.

@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine added v9.0.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Jan 7, 2025
@leemthompo leemthompo removed the external-contributor Pull request authored by a developer outside the Elasticsearch team label Jan 7, 2025
@alaudazzi alaudazzi added auto-backport Automatically create backport pull requests when merged v8.17.0 v8.18.0 labels Jan 7, 2025
@alaudazzi alaudazzi requested a review from leemthompo January 7, 2025 11:12
Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will be automatically activated for your deployment, with no installation required.

these are elasticsearch docs, so this isn't true (AutoOps is cloud only).

this note is also very large and prominent. could we instead introduce autoops as an optional tool in the monitoring section instead of on all of the troubleshooting pages, with the caveat that it's available for cloud hosted only?

To avoid these docs needing an edit in future, it would be nice to not frame this as an announcement, and instead as one of the options we offer.

@alaudazzi
Copy link
Contributor Author

Thank you for your feedback, @shainaraskas.
I'll let @arnonst the Opex PM chime in, as they requested this change in https://github.com/elastic/opex-product/issues/490.

@arnonst
Copy link

arnonst commented Jan 7, 2025

@alaudazzi @shainaraskas -
Regarding your above points:

  1. AutoOps is now available for Cloud Hosted (in a few months for Self-managed as well).
  2. As this is a new solutions, we want to give more context to the user about what is Autoops, whats the benefits and where to check if it is already supported in CSP regions used by their deployment. We can try to make is shorter, as we already gave it a few tries, we can look at it again.
  3. Why having it on all pages, the reason is that user can go directly to a troubleshooting page and miss this announcment.

We want to make AutoOps the go-to solution for Elastic Cloud monitoring, it is free to use and available to all cloud users.

@shainaraskas
Copy link
Contributor

shainaraskas commented Jan 7, 2025

@arnonst

AutoOps is now available for Cloud Hosted (in a few months for Self-managed as well).

these pages are shared by all of the deployment types, so we need to be very careful to provide that context, especially using language like "automatically activated". I'd prefer that we cut this down to something like "If you're using Elastic Cloud Hosted, then you can use AutoOps to xyz", perhaps with one "benefit" sentence, then link out.

Why having it on all pages, the reason is that user can go directly to a troubleshooting page and miss this announcment.

My main concern is the size and lifespan of these notes. Ideally, we'd explain how AutoOps would help them to identify this issue specifically to hint that AutoOps is relevant to them.

We want to make AutoOps the go-to solution for Elastic Cloud monitoring, it is free to use and available to all cloud users.

I agree that this is a good goal to have, but given the audience of these docs, we need to be more deliberate with our messaging.

@arnonst
Copy link

arnonst commented Jan 8, 2025

Thanks @shainaraskas for your comments.
Here is a shorter version which points out in a clear way that AutoOps is for ECH customers.

If you're using Elastic Cloud Hosted, then you can use AutoOps to significantly simplifies cluster management with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths.
For more information, check Monitor with AutoOps, which is rolling out in phases across Elastic Cloud Hosted regions.

Can we go with this text?

@shainaraskas
Copy link
Contributor

Consider the following edit. I recommend not including the rollout info here but instead in the "Monitor with AutoOps" topic so we only have to remove it in one place.

I'd also prefer this note to be below the overview for each page so people can understand what the page is about

If you're using Elastic Cloud Hosted, then you can use AutoOps to monitor your cluster. AutoOps significantly simplifies cluster management with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. For more information, refer to Monitor with AutoOps.

@arnonst
Copy link

arnonst commented Jan 8, 2025

@shainaraskas I am OK with your suggestions.
I will work with @alaudazzi to adjust the text.

@alaudazzi
Copy link
Contributor Author

@shainaraskas @arnonst
I integrated your suggestions, if you can have another look.

@alaudazzi alaudazzi merged commit 70e5a67 into main Jan 9, 2025
6 checks passed
@alaudazzi alaudazzi deleted the opex-product-fix-490 branch January 9, 2025 15:24
@leemthompo
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.x
8.17

Questions ?

Please refer to the Backport tool documentation

leemthompo pushed a commit to leemthompo/elasticsearch that referenced this pull request Jan 15, 2025
…c#119630)

* Reference AutoOps on troubleshooting pages

* Integrate reviewer's feedback

(cherry picked from commit 70e5a67)

# Conflicts:
#	docs/reference/troubleshooting/common-issues/hotspotting.asciidoc
leemthompo pushed a commit to leemthompo/elasticsearch that referenced this pull request Jan 15, 2025
…c#119630)

* Reference AutoOps on troubleshooting pages

* Integrate reviewer's feedback

(cherry picked from commit 70e5a67)

# Conflicts:
#	docs/reference/troubleshooting/common-issues/circuit-breaker-errors.asciidoc
#	docs/reference/troubleshooting/common-issues/hotspotting.asciidoc
elasticsearchmachine pushed a commit that referenced this pull request Jan 15, 2025
… (#120181)

* Reference AutoOps on troubleshooting pages

* Integrate reviewer's feedback

(cherry picked from commit 70e5a67)

# Conflicts:
#	docs/reference/troubleshooting/common-issues/circuit-breaker-errors.asciidoc
#	docs/reference/troubleshooting/common-issues/hotspotting.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
elasticsearchmachine pushed a commit that referenced this pull request Jan 15, 2025
… (#120182)

* Reference AutoOps on troubleshooting pages

* Integrate reviewer's feedback

(cherry picked from commit 70e5a67)

# Conflicts:
#	docs/reference/troubleshooting/common-issues/hotspotting.asciidoc

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes Team:Docs Meta label for docs team v8.17.0 v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants