diff --git a/docs/en/observability/observability-get-started.asciidoc b/docs/en/observability/observability-get-started.asciidoc index 5f16c35b8e..7a06304b2b 100644 --- a/docs/en/observability/observability-get-started.asciidoc +++ b/docs/en/observability/observability-get-started.asciidoc @@ -54,7 +54,8 @@ Follow the steps in these guides to get started quickly: * <> * <> - +* <> +* <> [discrete] === Get started with other features diff --git a/docs/en/observability/quickstarts/monitor-k8s-otel.asciidoc b/docs/en/observability/quickstarts/monitor-k8s-otel.asciidoc index 8c50350bed..7462e0455f 100644 --- a/docs/en/observability/quickstarts/monitor-k8s-otel.asciidoc +++ b/docs/en/observability/quickstarts/monitor-k8s-otel.asciidoc @@ -60,7 +60,7 @@ image::images/quickstart-k8s-otel-dashboard.png[Kubernetes overview dashboard] [discrete] == Troubleshooting and more -* For troubleshooting deployment and installation, refer to https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#installation-verification[installation verification]. +* To troubleshoot deployment and installation, refer to https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#installation-verification[installation verification]. * For application instrumentation details, refer to https://github.com/elastic/opentelemetry/blob/main/docs/kubernetes/operator/instrumenting-applications.md[Instrumenting applications with EDOT SDKs on Kubernetes]. -* For customizing the configuration, refer to https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#custom-configuration[custom configuration]. +* To customize the configuration, refer to https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#custom-configuration[custom configuration]. * Refer to <> for a description of other useful features. diff --git a/docs/en/serverless/images/quickstart-k8s-otel-dashboard.png b/docs/en/serverless/images/quickstart-k8s-otel-dashboard.png new file mode 100644 index 0000000000..c3fae9ac09 Binary files /dev/null and b/docs/en/serverless/images/quickstart-k8s-otel-dashboard.png differ diff --git a/docs/en/serverless/images/quickstart-k8s-otel-entry-point.png b/docs/en/serverless/images/quickstart-k8s-otel-entry-point.png new file mode 100644 index 0000000000..e47fac646b Binary files /dev/null and b/docs/en/serverless/images/quickstart-k8s-otel-entry-point.png differ diff --git a/docs/en/serverless/index.asciidoc b/docs/en/serverless/index.asciidoc index 908c8a6b84..a57b20b546 100644 --- a/docs/en/serverless/index.asciidoc +++ b/docs/en/serverless/index.asciidoc @@ -25,6 +25,7 @@ include::./projects/create-an-observability-project.asciidoc[leveloffset=+3] // Quickstarts include::./quickstarts/monitor-hosts-with-elastic-agent.asciidoc[leveloffset=+3] include::./quickstarts/k8s-logs-metrics.asciidoc[leveloffset=+3] +include::./quickstarts/monitor-k8s-otel.asciidoc[leveloffset=+3] include::./quickstarts/collect-data-with-aws-firehose.asciidoc[leveloffset=+3] // Dashboards diff --git a/docs/en/serverless/observability-get-started.asciidoc b/docs/en/serverless/observability-get-started.asciidoc index 30defd72be..6d763af16e 100644 --- a/docs/en/serverless/observability-get-started.asciidoc +++ b/docs/en/serverless/observability-get-started.asciidoc @@ -57,6 +57,7 @@ Follow the steps in these guides to get started quickly: * <> * <> +* <> * <> [discrete] diff --git a/docs/en/serverless/quickstarts/monitor-k8s-otel.asciidoc b/docs/en/serverless/quickstarts/monitor-k8s-otel.asciidoc new file mode 100644 index 0000000000..21fd5c43d5 --- /dev/null +++ b/docs/en/serverless/quickstarts/monitor-k8s-otel.asciidoc @@ -0,0 +1,66 @@ +[[monitor-k8s-otel-edot]] += Quickstart: Unified Kubernetes Observability with Elastic Distributions of OpenTelemetry (EDOT) + +preview::[] + +In this quickstart guide, you'll learn how to send Kubernetes logs, metrics, and application traces to Elasticsearch, using the https://github.com/open-telemetry/opentelemetry-operator/[OpenTelemetry Operator] to orchestrate https://github.com/elastic/opentelemetry/tree/main[Elastic Distributions of OpenTelemetry] (EDOT) Collectors and SDK instances. + +All the components will be deployed through the https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-kube-stack[opentelemetry-kube-stack] helm chart. They include: + +* https://github.com/open-telemetry/opentelemetry-operator/[OpenTelemetry Operator]. +* `DaemonSet` EDOT Collector configured for node level metrics. +* `Deployment` EDOT Collector configured for cluster level metrics. +* `Instrumentation` object for applications https://opentelemetry.io/docs/kubernetes/operator/automatic/[auto-instrumentation]. + +For a more detailed description of the components and advanced configuration, refer to the https://github.com/elastic/opentelemetry/blob/main/docs/kubernetes/operator/README.md[elastic/opentelemetry] GitHub repository. + +[discrete] +== Prerequisites + +* An {obs-serverless} project. To learn more, refer to <>. +* A running Kubernetes cluster (v1.23 or newer). +* https://kubernetes.io/docs/reference/kubectl/[Kubectl]. +* https://helm.sh/docs/intro/install/[Helm]. +* (optional) https://cert-manager.io/docs/installation/[Cert-manager], if you opt for automatic generation and renewal of TLS certificates. + +[discrete] +== Collect your data + +. <>, or open an existing one. +. In your {obs-serverless} project, go to **Add Data**. +. Under **What do you want to monitor?** select **Kubernetes**, and then select **OpenTelemetry: Full Observability**. ++ +[role="screenshot"] +image::images/quickstart-k8s-otel-entry-point.png[Kubernetes-OTel entry point] + +. Follow the on-screen instructions to install all needed components. ++ +[NOTE] +==== +The default installation deploys the OpenTelemetry Operator with a self-signed TLS certificate valid for 365 days. This certificate **won't be renewed** unless the Helm Chart release is manually updated. Refer to the https://github.com/elastic/opentelemetry/blob/main/docs/kubernetes/operator/README.md#cert-manager[cert-manager integrated installation] guide to enable automatic certificate generation and renewal using https://cert-manager.io/docs/installation/[cert-manager]. +==== ++ +Deploy the OpenTelemetry Operator and EDOT Collectors using the kube-stack Helm chart with the provided `values.yaml` file. You will run a few commands to: ++ + * Add the helm chart repository needed for the installation. + * Create a namespace. + * Create a secret with an API Key and the {es} endpoint to be used by the collectors. + * Install the `opentelemetry-kube-stack` helm chart with the provided `values.yaml`. + * Optionally, for instrumenting applications, apply the corresponding `annotations` as shown in {kib}. + +[discrete] +== Visualize your data + +After installation is complete and all relevant data is flowing into Elastic, +the **Visualize your data** section provides a link to the *[OTEL][Metrics Kubernetes]Cluster Overview* dashboard used to monitor the health of the cluster. + +[role="screenshot"] +image::images/quickstart-k8s-otel-dashboard.png[Kubernetes overview dashboard] + +[discrete] +== Troubleshooting and more + +* To troubleshoot deployment and installation, refer to https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#installation-verification[installation verification]. +* For application instrumentation details, refer to https://github.com/elastic/opentelemetry/blob/main/docs/kubernetes/operator/instrumenting-applications.md[Instrumenting applications with EDOT SDKs on Kubernetes]. +* To customize the configuration, refer to https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#custom-configuration[custom configuration]. +* Refer to <> for a description of other useful features.