Universal Profiling: on-prem GA additions (#4508)

* profiling: clarify telemetry data configs Closes elastic/prodfiler/issues/5222 Signed-off-by: inge4pres <[email protected]> * profiling: correct symbolizer scaling Signed-off-by: inge4pres <[email protected]> * programmatic configuration of data ingestion Closes elastic/prodfiler/issues/5319. Signed-off-by: inge4pres <[email protected]> * remove beta banner in on-perm main page Signed-off-by: inge4pres <[email protected]> * Suggestions from code review Co-authored-by: Brandon Morelli <[email protected]> --------- Signed-off-by: inge4pres <[email protected]> Co-authored-by: Brandon Morelli <[email protected]> (cherry picked from commit aa45ec2)
elastic · Nov 8, 2024 · ec2011c · ec2011c
1 parent 8b2dfa2
commit ec2011c
Show file tree

Hide file tree

Showing 3 changed files with 96 additions and 7 deletions.
diff --git a/docs/en/observability/profiling-get-started.asciidoc b/docs/en/observability/profiling-get-started.asciidoc
@@ -81,6 +81,32 @@ NOTE: To configure data ingestion, you need elevated privileges, typically the `
 
 If you're upgrading from a previous version with Universal Profiling enabled, see the <<profiling-upgrade,upgrade guide>>.
 
+[discrete]
+[[profiling-configure-data-ingestion-programmatic]]
+=== Programmatic configuration
+
+If you prefer to configure data ingestion programmatically, you can use a Kibana API call.
+This call can be made either through the "Dev Tools" console in Kibana or with any standalone HTTP client (such as `curl` or `wget`).
+In both cases, the API call must be executed using the `elastic` user credentials to ensure the necessary permissions.
+
+A successful API call will return a `202 Accepted` response with an empty body.
+
+To configure data ingestion from the console, go to *Dev Tools* in the navigation menu and run the following command:
+
+[source,console]
+----
+POST kbn:/internal/profiling/setup/es_resources
+{}
+----
+
+To configure data ingestion programmatically using a standalone HTTP client (e.g., `curl`), run the following command:
+
+[source,console]
+----
+curl -u elastic:<PASSWORD> -H "kbn-xsrf: true" -H "Content-Type: application/json" \
+    --data "{}" "https://<kibana-host>:<kibana-port>/internal/profiling/setup/es_resources"
+----
+
 [discrete]
 [[profiling-install-profiling-agent]]
 == Install the Universal Profiling Agent

diff --git a/docs/en/observability/profiling-self-managed-ops.asciidoc b/docs/en/observability/profiling-self-managed-ops.asciidoc
@@ -172,15 +172,80 @@ This endpoint is configured through the application's `host` configuration optio
 
 For example, if the collector is configured with the default value `host: 0.0.0.0:8260`, you can check the health of the application by running `curl -i localhost:8260/live` and `curl -i localhost:8260/ready`.
 
+[discrete]
+[[profiling-scaling-external-telemetry]]
+== Profiling agent telemetry data
+
+The Universal Profiling collector receives telemetry data from profiling agents to help debug agent operations and gather product usage statistics.
+This data enables us to understand the demographics of profiled machines and aids in investigations when customers report issues.
+
+By default, telemetry data collected by all profiling agents is sent to the collector, which then forwards it to an Elastic endpoint over the internet.
+You can opt out by configuring the `agent_metrics` stanza in the collector configuration YAML file.
+If you opt out, any troubleshooting by customer service will require manually extracting and providing the telemetry data.
+
+The <<profiling-self-managed-running-linux-configfile-collector,"Collector configuration file">>
+allows you to configure whether telemetry data is forwarded to Elastic, stored internally, or discarded.
+If the collector is deployed in a network without internet access, telemetry data will not be forwarded to Elastic.
+
+Below are examples of configurations for each option:
+
+**Forward telemetry data to Elastic**
+
+This is the default configuration.
+When the `agent_metrics` stanza is absent from the collector configuration file, the collector forwards telemetry data to Elastic.
+
+Explicitly enabling it does not alter the default behavior.
+
+[source,yaml]
+----
+agent_metrics:
+  disabled: false
+----
+
+**Collect telemetry data internally and send it to Elastic**
+
+In this configuration, telemetry data from profiling agents is sent to Elastic **and** stored internally.
+The data is stored in the `profiling-metrics*` indices within the same Elasticsearch cluster as Universal Profiling data
+and follows the same data retention policies.
+
+[source,yaml]
+----
+agent_metrics:
+  disabled: false
+  write_all: true
+----
+
+**Collect telemetry data only internally**
+
+To collect telemetry data without forwarding it to Elastic, configure the collector to store the data internally.
+You can specify the Elasticsearch deployment for storing telemetry data by providing a list of Elasticsearch
+hosts and an API key for authentication.
+
+[source,yaml]
+----
+agent_metrics:
+  disabled: false
+  addresses: ["https://internal-telemetry-endpoint.es.company.org:9200"]
+  api_key: "internal-telemetry-api-key"
+----
+
+**Disable telemetry data collection entirely**
+
+[source,yaml]
+----
+agent_metrics:
+  disabled: true
+----
+
 [discrete]
 [[profiling-scaling-backend-resources]]
 == Scale resources
 
 In the <<profiling-self-managed-ops-sizing-guidance, resource guidance table>>, no options use more than one replica for the symbolizer.
-We do not recommend scaling the number of symbolizer replicas because of the technical limitations of the current implementation.
-We recommend scaling the symbolizer vertically, by increasing the memory and CPU cores it uses to process data.
+This is due to how multiple symbolizer replicas have to synchronize over identical frame records to be processed.
+While it still possible to scale horizontally, we recommend scaling the symbolizer vertically first, by increasing the memory and CPU cores it uses to process data.
 
-You can increase the number of collector replicas at will, keeping their vertical sizing smaller, if this is more convenient for your deployment use case.
+You can increase the number of collector replicas at will, keeping their vertical sizing smaller if this is more convenient for your deployment use case.
 The collector has a linear increase in memory usage and CPU threads with the number of Universal Profiling Agents that it serves.
 Keep in mind that since the Universal Profiling Agent/collector communication happens via gRPC, there may be long-lived TCP sessions that are bound to a single collector replica.
 When scaling out the number of replicas, depending on the load balancer that you have in place fronting the collector's endpoint, you may want to shut down the older replicas after adding new replicas.

diff --git a/docs/en/observability/profiling-self-managed.asciidoc b/docs/en/observability/profiling-self-managed.asciidoc
@@ -5,8 +5,6 @@
 <titleabbrev>Self-hosted infrastructure</titleabbrev>
 ++++
 
-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.
@@ -288,7 +286,7 @@ We also display the default application settings; you can refer to the comments
 
 [discrete]
 [[profiling-self-managed-running-linux-configfile-collector]]
-==== Collector Configuration file
+==== Collector configuration file
 
 Copy the content of the snippet below in the `/etc/Elastic/universal-profiling/pf-elastic-collector.yml` file.
 
@@ -457,7 +455,7 @@ output:
 
 [discrete]
 [[profiling-self-managed-running-linux-configfile-symbolizer]]
-==== Symbolizer Configuration file
+==== Symbolizer configuration file
 
 Copy the content of the snippet below in the `/etc/Elastic/universal-profiling/pf-elastic-symbolizer.yml` file.