From c35e8b321bbb85330e8875d6dfa6b9b6836fabce Mon Sep 17 00:00:00 2001 From: mdbirnstiehl Date: Wed, 17 Jan 2024 15:30:40 -0600 Subject: [PATCH] docs review updates --- .../profiling-self-managed-ops.asciidoc | 2 +- .../observability/profiling-self-managed.asciidoc | 14 ++++++-------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/en/observability/profiling-self-managed-ops.asciidoc b/docs/en/observability/profiling-self-managed-ops.asciidoc index 1cefbc598d..1a039d1182 100644 --- a/docs/en/observability/profiling-self-managed-ops.asciidoc +++ b/docs/en/observability/profiling-self-managed-ops.asciidoc @@ -88,7 +88,7 @@ Only enable debug logs when troubleshooting a failed deployment or when instruct Logs are formatted as "key=value" pairs, and {es} and {kib} can automatically parse them into fields. - A log collector, such as Filebeat, can collect and send logs to {es} for indexing and analysis. +A log collector, such as Filebeat, can collect and send logs to {es} for indexing and analysis. Depending on how it's installed, a Filebeat input of type `journald` (for OS packages), `log` (for binaries), or `container` can be used to process the logs. Refer to the {filebeat-ref}/configuring-howto-filebeat.html[filebeat documentation] for more information. diff --git a/docs/en/observability/profiling-self-managed.asciidoc b/docs/en/observability/profiling-self-managed.asciidoc index 27ba00d8fb..dd53e376d7 100644 --- a/docs/en/observability/profiling-self-managed.asciidoc +++ b/docs/en/observability/profiling-self-managed.asciidoc @@ -7,6 +7,8 @@ beta::[] +IMPORTANT: To run Universal Profiling on self-hosted Elastic stack, you need an {subscriptions}[appropriate license]. + Here you'll find information on running Universal Profiling when hosting the Elastic stack on your own infrastructure. Universal Profiling consists of a client part (the host-agent) and a server part (the backend). This documentation focuses on the server part. @@ -31,9 +33,6 @@ Currently, we do not have Profiling Operators and the CRDs necessary for running The following platforms were tested and successfully ran the Universal Profiling backend. -.Expand to see platform details. -[%collapsible] -==== |==== | Platform | OS | Details @@ -99,7 +98,6 @@ a| * ✅ Docker | Linux x86_64/ARM64 a| * ✅ Helm charts |==== -==== [discrete] [[profiling-self-managed-architecture-overview]] @@ -153,8 +151,8 @@ Update ECE to version 3.7.0 or higher, following the https://www.elastic.co/down WARNING: We don't currently support running the backend applications through Elastic Agent. -. Deploy a minimum version 8.12.0 of the Elastic stack (Elasticsearch, Kibana) -. Ensure the machines hosting the Universal Profiling backend run a Linux kernel version 4.x or higher +. Deploy a minimum version 8.12.0 of the Elastic stack (Elasticsearch, Kibana). +. Ensure the machines hosting the Universal Profiling backend run a Linux kernel version 4.x or higher. [discrete] [[profiling-self-managed-updating-k8s]] @@ -177,7 +175,7 @@ Configure {kib} to enable the Universal Profiling plugin with the following conf xpack.profiling.enabled: true ---- -For each platform, find below the steps to deploy this configuration change. +Refer to the steps for your platform to deploy update the configuration. [discrete] === ECE @@ -267,7 +265,7 @@ Install the backend applications using one of the following options: 1. <> 2. <> -3. <>: orchestrated with your configuration management system of choice (Ansible, Puppet, Chef, Salt, etc...) +3. <>: orchestrated with your configuration management system of choice (Ansible, Puppet, Chef, Salt, etc.) [discrete] [[profiling-self-managed-running-linux-configfile]]