-
Notifications
You must be signed in to change notification settings - Fork 164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Quickstart k8s otel doc added #4488
base: main
Are you sure you want to change the base?
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
This pull request does not have a backport label. Could you fix it @eedugon? 🙏
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good! A few grammar things
@akhileshpok , @mlunadia : would you please review this PR? It will be the official Note that this doc aims to not be too long, neither to provide / duplicate the same information we already have in our For example about instrumenting applications I've just referenced the GH repo @mdbirnstiehl : feel free to review also if you like! |
This pull request is now in conflict. Could you fix it @eedugon? 🙏
|
conflict solved (hopefully) :-D |
@akhileshpok : I've talked with @bmorelli25 and we are going to add the information about being able to use For serverless we will port this new doc to the serverless documentation as soon as it's approved. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Just had a couple of suggestions.
[role="screenshot"] | ||
image::images/quickstart-k8s-otel-entry-point.png[Kubernetes-OTel entry point] | ||
|
||
. Follow the on-screen instructions to perform the installation of all needed components. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
. Follow the on-screen instructions to perform the installation of all needed components. | |
. Follow the on-screen instructions to install all needed components. |
* 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 showed in {kib}. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Optionally, for instrumenting applications, apply the corresponding `annotations` as showed in {kib}. | |
* Optionally, for instrumenting applications, apply the corresponding `annotations` as shown in {kib}. |
* `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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. | |
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. |
|
||
. In {kib}, go to **Observability** and click **Add Data**. | ||
|
||
. Under the question *`What do you want to monitor?`* select **Kubernetes**, and then select the **OpenTelemetry: Full Observability** option. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
. Under the question *`What do you want to monitor?`* select **Kubernetes**, and then select the **OpenTelemetry: Full Observability** option. | |
. Under *`What do you want to monitor?`*, select **Kubernetes**, and then select the **OpenTelemetry: Full Observability** option. |
== Troubleshooting and more | ||
|
||
* For troubleshooting deployment and installation, refer to https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator#installation-verification[installation verification]. | ||
* For applications instrumentation details, refer to https://github.com/elastic/opentelemetry/blob/main/docs/kubernetes/operator/instrumenting-applications.md[Instrumenting applications with EDOT SDKs on Kubernetes]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* For applications 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 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]. |
Description
Adding a quickstart document for Unified Kubernetes Observability with EDOT.
Preview: https://observability-docs_bk_4488.docs-preview.app.elstc.co/guide/en/observability/master/monitor-k8s-otel-edot.html
The objective of this doc is to be a good entry point for this use case, considering that we have all details and detailed documents in elastic/opentelemetry repo: https://github.com/elastic/opentelemetry/tree/main/docs/kubernetes/operator
If possible I'd like to get a review by @mdbirnstiehl or @bmorelli25 before requesting the review by @mlunadia and @akhileshpok .
Initial concerns:
Documentation sets edited in this PR
Check all that apply.
docs/en/observability/*
)docs/en/serverless/*
)docs/en/integrations/*
)Related issue
Closes #4428
Checklist
Follow-up tasks
Select one.