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

profiling: introduce self-managed beta for 8.12 #3379

Merged
merged 11 commits into from
Jan 24, 2024

Conversation

inge4pres
Copy link
Contributor

Reason for this PR

Addresses elastic/prodfiler/issues/4139.

Details

  • Create the documentation to install and run the Universal Profiling backend on various platforms: ECE, K8s, Linux.
  • Document operational practices to monitor and scale the backend components
  • Add a troubleshooting section to overcome known issues

To be refined

The operational and troubleshooting sections are still empty, working on it in the next days

Copy link
Contributor

A documentation preview will be available soon:

Copy link
Contributor

mergify bot commented Nov 22, 2023

This pull request does not have a backport label. Could you fix it @inge4pres? 🙏
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 Nov 22, 2023
@inge4pres inge4pres force-pushed the profiling/issues/4139 branch 2 times, most recently from 0f4b164 to dfec1fa Compare November 22, 2023 14:49
@inge4pres
Copy link
Contributor Author

@inge4pres inge4pres force-pushed the profiling/issues/4139 branch from dfec1fa to 4b4c6e0 Compare November 24, 2023 15:35
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

History

  • 💚 Build #104 succeeded 742a6d4ad31d42637cedba646a8cc0061a795fbe
  • 💔 Build #103 failed 742a6d4ad31d42637cedba646a8cc0061a795fbe
  • 💚 Build #101 succeeded 742a6d4ad31d42637cedba646a8cc0061a795fbe

cc @inge4pres

@colleenmcginnis colleenmcginnis added backport-8.12 Automated backport with mergify and removed backport-skip Skip notification from the automated backport with mergify labels Dec 8, 2023
@inge4pres inge4pres added backport-skip Skip notification from the automated backport with mergify and removed v8.12.0 8.12-candidate Request:8.12 backport-8.12 Automated backport with mergify labels Dec 18, 2023
@inge4pres inge4pres force-pushed the profiling/issues/4139 branch from 4b4c6e0 to f26667d Compare December 18, 2023 10:40
@inge4pres inge4pres force-pushed the profiling/issues/4139 branch from f26667d to 7d7816d Compare January 3, 2024 09:23
Signed-off-by: inge4pres <[email protected]>
@inge4pres inge4pres marked this pull request as ready for review January 3, 2024 09:28
@inge4pres inge4pres requested a review from a team as a code owner January 3, 2024 09:28
@inge4pres inge4pres added the 8.1.3 label Jan 3, 2024
@mdbirnstiehl mdbirnstiehl self-requested a review January 3, 2024 19:33
mdbirnstiehl
mdbirnstiehl previously approved these changes Jan 12, 2024
Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

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

I made some changes just for consistency and wording, and I think I have the document organization in a good place now, but please take a look and let me know if you have any questions or issues.

docs/en/observability/profiling-self-managed-ops.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed-ops.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed-ops.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed-ops.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed-ops.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed.asciidoc Outdated Show resolved Hide resolved
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Okay. Last review from me!

[[profiling-self-managed-supported-platforms]]
== Prerequisites

IMPORTANT: Running Universal Profiling on self hosted infrastructure requires an Elastic **Enterprise license**.
Copy link
Member

Choose a reason for hiding this comment

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

Is this reflected on https://www.elastic.co/subscriptions? For legal reasons, we don't name the license level required in the documentation and instead link to the source of truth (the subscriptions page). Here's an example from the SLO docs:

To create and manage SLOs, you need an {subscriptions}[appropriate license].

Can we do the same here? Will UP be added to the subscriptions page when 8.12 releaes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I summon @iogbole on this one as I have no clue about the other page.
I am only aware that for on-prem we need Enterprise... we have a check in the code to enforce that.

@bmorelli25 can suggest what should be the appropriate format here?
I guess

Suggested change
IMPORTANT: Running Universal Profiling on self hosted infrastructure requires an Elastic **Enterprise license**.
IMPORTANT: Running Universal Profiling on self hosted infrastructure requires an Elastic **{subscriptions}[Enterprise license]**.

Copy link
Contributor

Choose a reason for hiding this comment

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

I've moved this line to the top of the page here to be consistent with the rest of the obs docs.

If we are able to get the Profiling subscription info on the subscriptions page, we wouldn't want to explicitly say what kind of license users need in the docs. With this in mind, I phrased it this way:

IMPORTANT: To run Universal Profiling on self-hosted Elastic stack, you need an {subscriptions}[appropriate license].

If we aren't able to get the info on the subscriptions page, maybe we can rephrase to be specific in this instance.

docs/en/observability/profiling-self-managed.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed.asciidoc Outdated Show resolved Hide resolved
docs/en/observability/profiling-self-managed-ops.asciidoc Outdated Show resolved Hide resolved
mdbirnstiehl
mdbirnstiehl previously approved these changes Jan 23, 2024
Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

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

I think we can merge this now, I'll make a note to come back and check on the subscription statement when we get closer to the 8.13 release.

@mdbirnstiehl mdbirnstiehl self-requested a review January 23, 2024 23:13
@mdbirnstiehl mdbirnstiehl merged commit ffbeb1a into main Jan 24, 2024
5 checks passed
@mdbirnstiehl mdbirnstiehl deleted the profiling/issues/4139 branch January 24, 2024 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify Request:8.13
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants