From 1cd8c7bd5040cf273c23880fa02cfd4b28afb5c2 Mon Sep 17 00:00:00 2001 From: Francesco Gualazzi Date: Thu, 7 Sep 2023 15:21:21 +0200 Subject: [PATCH 1/4] Profiling: add upgrade notice of known issues for 8.9 versions --- docs/en/observability/profiling-upgrade.asciidoc | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/en/observability/profiling-upgrade.asciidoc b/docs/en/observability/profiling-upgrade.asciidoc index f461ba08e5..1bc04e350b 100644 --- a/docs/en/observability/profiling-upgrade.asciidoc +++ b/docs/en/observability/profiling-upgrade.asciidoc @@ -5,6 +5,16 @@ Upgrade ++++ +[discrete] +[[profiling-upgrade-known-issues]] +== Known issues + +If you created your {ecloud} deployment starting from a 7.x version or earlier, and you have upgraded it to 8.9.0, 8.9.1 or 8.9.2, you may encounter a problem while trying to enable Universal Profiling. + +Specifically, clicking the 'Set up Universal Profiling' button triggers an error message that reads **Error while setting up Universal Profiling**. + +To rectify this situation, an upgrade to version 8.9.3 or above is needed. + [discrete] [[profiling-upgrade-process]] == Upgrade process From 0f2b59e990e96b552a4c7682e2b7319ec05df58b Mon Sep 17 00:00:00 2001 From: inge4pres Date: Thu, 7 Sep 2023 15:56:12 +0200 Subject: [PATCH 2/4] move warning to get started page Signed-off-by: inge4pres --- .../profiling-get-started.asciidoc | 24 ++++++++++++------- .../observability/profiling-upgrade.asciidoc | 10 -------- 2 files changed, 16 insertions(+), 18 deletions(-) diff --git a/docs/en/observability/profiling-get-started.asciidoc b/docs/en/observability/profiling-get-started.asciidoc index a6b279f94c..0d68a3d9c4 100644 --- a/docs/en/observability/profiling-get-started.asciidoc +++ b/docs/en/observability/profiling-get-started.asciidoc @@ -63,9 +63,7 @@ Even if you're profiling a smaller fleet, we recommend configuring at least two [[profiling-set-up-on-cloud]] == Set up Universal Profiling on an {ecloud} deployment -To set up Universal Profiling on your {ecloud} deployment, you need to: - -. <> +To set up Universal Profiling on your {ecloud} deployment, you need to <> first. [discrete] [[profiling-configure-data-ingestion]] @@ -85,9 +83,19 @@ If you're upgrading from a previous version with Universal Profiling enabled, se IMPORTANT: When upgrading, you must remove all existing profiling data. We still recommend upgrading as the latest version contains several improvements and new features. -[discrete] -[[profiling-install-host-agent]] -== Install the host-agent +[discrete] +[[profiling-upgrade-known-issues]] +==== Known issue during the configuration of data ingestion + +If you created your {ecloud} deployment starting from a 7.x version or earlier, and you are currently running it to 8.9.0, 8.9.1 or 8.9.2, you may encounter a problem while trying to enable Universal Profiling. + +Specifically, clicking the 'Set up Universal Profiling' button triggers an error message that reads **Error while setting up Universal Profiling**. + +To rectify this situation, an upgrade to version 8.9.3 or above is needed. + +[discrete] +[[profiling-install-host-agent]] +== Install the host-agent You have the following options when installing the host-agent: . <> @@ -99,12 +107,12 @@ You have the following options when installing the host-agent: To install the host-agent using the {agent} and the Universal Profiling Agent integration, complete the following steps: -. Copy the `secret token` and `Universal Profiling Collector url` from the Elastic Agent Integration +. Copy the `secret token` and `Universal Profiling Collector url` from the Elastic Agent Integration + [role="screenshot"] image::images/profiling-elastic-agent.png[] + -. Click `Manage Universal Profiling Agent in Fleet` to complete the integration. +. Click `Manage Universal Profiling Agent in Fleet` to complete the integration. . On the Integrations page, click **Add Universal Profiling Agent**. . In **Universal Profiling Agent → Settings**, add the information you copied from the *Add profiling data* page: .. Add the Universal Profiling collector URL to the **Universal Profiling collector endpoint** field. diff --git a/docs/en/observability/profiling-upgrade.asciidoc b/docs/en/observability/profiling-upgrade.asciidoc index 1bc04e350b..f461ba08e5 100644 --- a/docs/en/observability/profiling-upgrade.asciidoc +++ b/docs/en/observability/profiling-upgrade.asciidoc @@ -5,16 +5,6 @@ Upgrade ++++ -[discrete] -[[profiling-upgrade-known-issues]] -== Known issues - -If you created your {ecloud} deployment starting from a 7.x version or earlier, and you have upgraded it to 8.9.0, 8.9.1 or 8.9.2, you may encounter a problem while trying to enable Universal Profiling. - -Specifically, clicking the 'Set up Universal Profiling' button triggers an error message that reads **Error while setting up Universal Profiling**. - -To rectify this situation, an upgrade to version 8.9.3 or above is needed. - [discrete] [[profiling-upgrade-process]] == Upgrade process From c08612a1b4dec7816f2886e555abb7e23ff8ac95 Mon Sep 17 00:00:00 2001 From: inge4pres Date: Thu, 7 Sep 2023 16:00:23 +0200 Subject: [PATCH 3/4] grammar fix Signed-off-by: inge4pres --- docs/en/observability/profiling-get-started.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/profiling-get-started.asciidoc b/docs/en/observability/profiling-get-started.asciidoc index 0d68a3d9c4..cb40c75472 100644 --- a/docs/en/observability/profiling-get-started.asciidoc +++ b/docs/en/observability/profiling-get-started.asciidoc @@ -87,7 +87,7 @@ We still recommend upgrading as the latest version contains several improvements [[profiling-upgrade-known-issues]] ==== Known issue during the configuration of data ingestion -If you created your {ecloud} deployment starting from a 7.x version or earlier, and you are currently running it to 8.9.0, 8.9.1 or 8.9.2, you may encounter a problem while trying to enable Universal Profiling. +If you created your {ecloud} deployment starting from a 7.x version or earlier, and you are currently running it on 8.9.0, 8.9.1 or 8.9.2, you may encounter a problem while trying to enable Universal Profiling. Specifically, clicking the 'Set up Universal Profiling' button triggers an error message that reads **Error while setting up Universal Profiling**. From 83e22d8c8cb17ad3ae276b984ccbff8c36b6c655 Mon Sep 17 00:00:00 2001 From: Francesco Gualazzi Date: Fri, 8 Sep 2023 15:21:05 +0200 Subject: [PATCH 4/4] Suggestions from code review Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --- docs/en/observability/profiling-get-started.asciidoc | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/en/observability/profiling-get-started.asciidoc b/docs/en/observability/profiling-get-started.asciidoc index cb40c75472..d5d958b3da 100644 --- a/docs/en/observability/profiling-get-started.asciidoc +++ b/docs/en/observability/profiling-get-started.asciidoc @@ -85,13 +85,16 @@ We still recommend upgrading as the latest version contains several improvements [discrete] [[profiling-upgrade-known-issues]] -==== Known issue during the configuration of data ingestion +==== Known issue when configuring data ingestion -If you created your {ecloud} deployment starting from a 7.x version or earlier, and you are currently running it on 8.9.0, 8.9.1 or 8.9.2, you may encounter a problem while trying to enable Universal Profiling. -Specifically, clicking the 'Set up Universal Profiling' button triggers an error message that reads **Error while setting up Universal Profiling**. +If your {ecloud} deployment originated from version 7.x or earlier and is currently running on version 8.9.0–8.9.2, you may encounter a problem while trying to enable Universal Profiling. + +Specifically, clicking the *Set up Universal Profiling* button triggers an error message that reads `Error while setting up Universal Profiling`. + + +Upgrade to version 8.9.3 or more recent to fix this issue. -To rectify this situation, an upgrade to version 8.9.3 or above is needed. [discrete] [[profiling-install-host-agent]]