From f033530edc8c38e277c94419c123198b11a20348 Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Mon, 16 Dec 2024 15:37:46 -0500 Subject: [PATCH 1/4] Add placeholder for 'transform to OTel Collector' docs (#1550) * Add placeholder for 'transform to OTel Collector' docs * Add include statement (commented out) * Update docs/en/ingest-management/elastic-agent/otel-agent-transform.asciidoc Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --------- Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> (cherry picked from commit 6d32677cb0cdb737cac5a9b59af1ea824432ca1b) --- .../otel-agent-transform.asciidoc | 20 +++++++++++++++++++ .../elastic-agent/otel-agent.asciidoc | 2 ++ docs/en/ingest-management/index.asciidoc | 2 ++ 3 files changed, 24 insertions(+) create mode 100644 docs/en/ingest-management/elastic-agent/otel-agent-transform.asciidoc diff --git a/docs/en/ingest-management/elastic-agent/otel-agent-transform.asciidoc b/docs/en/ingest-management/elastic-agent/otel-agent-transform.asciidoc new file mode 100644 index 000000000..1c70cda60 --- /dev/null +++ b/docs/en/ingest-management/elastic-agent/otel-agent-transform.asciidoc @@ -0,0 +1,20 @@ +[[otel-agent-transform]] +== Transform an installed {agent} to run as an OTel Collector + +preview::[] + +If you have a currently installed {agent}, you change it to run as an <>. + +To transform {agent} to an OTel Collector: + +. Some instruction. + +. Some other instruction. Run the `elastic-agent -transform-otel` command: ++ +[source,shell] +---- +elastic-agent -switch-me-to-otel-please +---- + + + diff --git a/docs/en/ingest-management/elastic-agent/otel-agent.asciidoc b/docs/en/ingest-management/elastic-agent/otel-agent.asciidoc index 4defa6edd..99c79989c 100644 --- a/docs/en/ingest-management/elastic-agent/otel-agent.asciidoc +++ b/docs/en/ingest-management/elastic-agent/otel-agent.asciidoc @@ -8,3 +8,5 @@ The link:https://opentelemetry.io/docs/collector/[OpenTelemetry Collector] is a When you run {agent} in `otel` mode it supports the standard OTel Collector configuration format that defines a set of receivers, processors, exporters, and connectors. Logs, metrics, and traces can be ingested using OpenTelemetry data formats. For a full overview and steps to configure {agent} in `otel` mode, including a guided onboarding, refer to the link:https://github.com/elastic/opentelemetry/tree/main[Elastic Distributions for OpenTelemetry] repository in GitHub. You can also check the <> in the {fleet} and {agent} Command reference. + +// If you have a currently running {agent} you can <>. diff --git a/docs/en/ingest-management/index.asciidoc b/docs/en/ingest-management/index.asciidoc index 7190ee36f..dfcef8796 100644 --- a/docs/en/ingest-management/index.asciidoc +++ b/docs/en/ingest-management/index.asciidoc @@ -71,6 +71,8 @@ include::elastic-agent/configuration/env/container-envs.asciidoc[leveloffset=+3] include::elastic-agent/otel-agent.asciidoc[leveloffset=+2] +//include::elastic-agent/otel-agent-transform.asciidoc[leveloffset=+2] + include::elastic-agent/elastic-agent-unprivileged-mode.asciidoc[leveloffset=+2] include::elastic-agent/install-agent-msi.asciidoc[leveloffset=+2] From dc6fe9f7e7b76ee8043553d4598b262ad4e197b9 Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Thu, 2 Jan 2025 10:13:37 -0500 Subject: [PATCH 2/4] Update otel-agent-transform.asciidoc --- .../elastic-agent/otel-agent-transform.asciidoc | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/docs/en/ingest-management/elastic-agent/otel-agent-transform.asciidoc b/docs/en/ingest-management/elastic-agent/otel-agent-transform.asciidoc index 2cf0306be..581521f42 100644 --- a/docs/en/ingest-management/elastic-agent/otel-agent-transform.asciidoc +++ b/docs/en/ingest-management/elastic-agent/otel-agent-transform.asciidoc @@ -3,22 +3,6 @@ preview::[] -If you have a currently installed {agent}, you change it to run as an <>. - -To transform {agent} to an OTel Collector: - -. Some instruction. - -. Some other instruction. Run the `elastic-agent -transform-otel` command: -+ -[source,shell] ----- -elastic-agent -switch-me-to-otel-please ----- - - - -======= If you have a currently installed standalone {agent}, it can be configured to run as an <>. This allows you to run {agent} both as a service and in an OTel Collector mode. In order to configure an installed standalone {agent} to run as an OTel Collector, it's enough to include a valid <> configuration in the `elastic-agent.yml` file, as shown in the following example. From 7e390a4e8ac6bbadf0b48713186a03da086361b7 Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Thu, 2 Jan 2025 10:15:11 -0500 Subject: [PATCH 3/4] Update index.asciidoc --- docs/en/ingest-management/index.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/ingest-management/index.asciidoc b/docs/en/ingest-management/index.asciidoc index dfcef8796..2712b4685 100644 --- a/docs/en/ingest-management/index.asciidoc +++ b/docs/en/ingest-management/index.asciidoc @@ -71,7 +71,7 @@ include::elastic-agent/configuration/env/container-envs.asciidoc[leveloffset=+3] include::elastic-agent/otel-agent.asciidoc[leveloffset=+2] -//include::elastic-agent/otel-agent-transform.asciidoc[leveloffset=+2] +include::elastic-agent/otel-agent-transform.asciidoc[leveloffset=+2] include::elastic-agent/elastic-agent-unprivileged-mode.asciidoc[leveloffset=+2] From aa863875121371756da869f7305ddfdbd279866d Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Thu, 2 Jan 2025 10:15:27 -0500 Subject: [PATCH 4/4] Update otel-agent.asciidoc --- docs/en/ingest-management/elastic-agent/otel-agent.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/ingest-management/elastic-agent/otel-agent.asciidoc b/docs/en/ingest-management/elastic-agent/otel-agent.asciidoc index 99c79989c..177c73dc1 100644 --- a/docs/en/ingest-management/elastic-agent/otel-agent.asciidoc +++ b/docs/en/ingest-management/elastic-agent/otel-agent.asciidoc @@ -9,4 +9,4 @@ When you run {agent} in `otel` mode it supports the standard OTel Collector conf For a full overview and steps to configure {agent} in `otel` mode, including a guided onboarding, refer to the link:https://github.com/elastic/opentelemetry/tree/main[Elastic Distributions for OpenTelemetry] repository in GitHub. You can also check the <> in the {fleet} and {agent} Command reference. -// If you have a currently running {agent} you can <>. +If you have a currently running {agent} you can <>.