Collect data with Elastic Cloud Native OpenTelemetry Endpoint #4854

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.

Sign up for GitHub

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

Jump to bottom

Merged

bmorelli25 merged 6 commits into do-not-delete_legacy-docs from motel-docs

Apr 1, 2025

Member

bmorelli25 commented Mar 21, 2025 •

edited by jlind23

Loading

Description

This is a very rough outline of a potential Getting Started with Elastic Cloud Native OpenTelemetry Endpoint Guide. After we come to a consensus on the final guide, I will port to Markdown and our new documentation system.

Important

Reviewers: I've left comments and questions in the Asciidoc files. Please take a look and leave feedback.

Issues, People, etc.

cc @jlind23 @mlunadia @vigneshshanmugam

closes #4851


          add very rough draft

1e9bfb4

Contributor

github-actions bot commented Mar 21, 2025

A documentation preview will be available soon.

🔨 Buildkite builds
📚 HTML diff
📙 Preview page

Request a new doc build by commenting

Rebuild this PR: run docs-build
Rebuild this PR and all Elastic docs: run docs-build rebuild

_{run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.}

_{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.}

bmorelli25 mentioned this pull request

[Request]: Document Public Tech Preview: Managed OTLP Endpoint for Serverless Users #4851

Closed

jlind23 linked an issue

that may be closed by this pull request

[Request]: Document Public Tech Preview: Managed OTLP Endpoint for Serverless Users #4851

Closed

jlind23 reviewed

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated

+              ** Traces
+              ** Dependencies
+              // screenshots here?

Contributor

jlind23 Mar 21, 2025

Maybe the APM workflow is the first one we should call out here? @mlunadia thoughts?

Member Author

bmorelli25 Mar 25, 2025

++ need some input on what to do with this section. Added a brief overview on our APM UI for now.

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated

+              * Kubernetes
+              ** (Optional) Install the OpenTelemetry Assets integrations to access the ‘[OTEL][Metrics Kubernetes] Cluster Overview’ dashboard.
+              // screenshots here?

Contributor

jlind23 Mar 21, 2025

We should show a screenshot of the k8S assets that are included in the new OTel compatible content pack.

Member Author

bmorelli25 Mar 25, 2025

Is there a cluster with relevant data that I can use to take this screenshot?

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/native-otlp-tabs.asciidoc Outdated Show resolved Hide resolved

mlunadia commented Mar 21, 2025

@raultorrecilla @vigneshshanmugam can we get someone from the team to review and fill in the gaps?

mlunadia reviewed

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc

+              +
+              NOTE: Follow this flow for all use cases, including logs and infrastructure monitoring.
+              . Copy the `OTEL_EXPORTER_OTLP_ENDPOINT` URL. Replace `.apm` with `.ingest` and save this value for later.

mlunadia Mar 21, 2025

Users will no longer have to edit the endpoint, the actual endpoint url will be displayed in the cloud console and also in the application onboarding. I recommend we guide users to obtain the endpoint from cloud console.

mlunadia Mar 21, 2025

Member Author

bmorelli25 Mar 25, 2025

To clarify: We should recommend users go to the cloud console for both the Endpoint and API key, not the onboarding flow?

Should we doc both?

Member Author

bmorelli25 Mar 25, 2025 •

edited

Loading

Update to: "Managed OTLP endpoint"
Update to use Cloud Console to reduce confusion about what type of data is supported

Member Author

bmorelli25 Mar 27, 2025

@mlunadia I'm not able to replicate this page in the cloud console.

When I click on "Manage project API keys" I'm taken to this page

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Show resolved Hide resolved

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/native-otlp-tabs.asciidoc Outdated Show resolved Hide resolved

vigneshshanmugam reviewed

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

bmorelli25 and others added 2 commits

March 24, 2025 15:40


          Apply suggestions from code review

f86a176

Co-authored-by: Miguel Luna <39376769+mlunadia@users.noreply.github.com>


          address feedback

9ff8e57

bmorelli25 marked this pull request as ready for review

March 25, 2025 02:10

bmorelli25 requested a review from a team as a code owner

March 25, 2025 02:10

bmorelli25 commented

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

bmorelli25 commented

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated

+              In your {obs-serverless} project, go to **Integrations** and toggle **Display beta integrations**.
+              Search for "OpenTelemetry" and select and install **Kubernetes OpenTelemetry Assets**.
+              // Does anyone have a cluster with relevant data that we can use to take a screenshot of this dashboard?

Member Author

bmorelli25 Mar 25, 2025

Asked above too

Does anyone have a cluster with relevant data that we can use to take a screenshot of this dashboard?

Member

vigneshshanmugam Mar 25, 2025

@mlunadia ^^ could you provide it since you have already have one running. Thanks

bmorelli25 commented

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Show resolved Hide resolved


          fix bad link

7acb227

bmorelli25 commented

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Show resolved Hide resolved

bmorelli25 commented

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated

+              * https://elastic.github.io/opentelemetry/quickstart/serverless/k8s.html[Kubernetes Quickstart]
+              * https://elastic.github.io/opentelemetry/quickstart/serverless/hosts_vms.html[Hosts & VMs Quickstart]
+              // Commenting out Docker until the docs are ready

Member Author

bmorelli25 Mar 25, 2025 •

edited

Loading

Other is focussed on on infra. This will focus on use case
APM coming soon here: https://elastic.github.io/opentelemetry/use-cases/application/

bmorelli25 commented

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

bmorelli25 commented

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated Show resolved Hide resolved

bmorelli25 commented

View reviewed changes

docs/en/serverless/quickstarts/collect-data-with-native-otlp.asciidoc Outdated

+              // * https://elastic.github.io/opentelemetry/quickstart/serverless/docker.html[Docker Quickstart]
+              [discrete]
+              == Get creative with Discover

Member Author

bmorelli25 Mar 25, 2025

Move this to a new page in apps and services

Make for ANY otlp data

Member Author

bmorelli25 Mar 25, 2025

End goal is analysis of OTLP data in one place


          more updates

4c24c8a

jlind23 approved these changes

View reviewed changes

Contributor

jlind23 commented Apr 1, 2025

@elastic/obs-docs Could we please get some expert eyes on this?


          clean up

16330ef

Member Author

bmorelli25 commented Apr 1, 2025

I'll merge this. Would still be good to get:

The screenshot mentioned above
Input on what to do with the APM section
Clarification on why I can't access the endpoint from the cloud console like @mlunadia suggests
Clarification on when the APM docs will be available

bmorelli25 merged commit ffa8978 into do-not-delete_legacy-docs

5 checks passed

bmorelli25 deleted the motel-docs branch

April 1, 2025 23:13

bmorelli25 mentioned this pull request

Collect data with Elastic Cloud Native OpenTelemetry Endpoint elastic/docs-content#1000

Merged

bmorelli25 added the backport-8.x label

bmorelli25 added backport-8.17 backport-8.18 labels

mergify bot pushed a commit that referenced this pull request


          Collect data with Elastic Cloud Native OpenTelemetry Endpoint (#4854)

007559d

* add very rough draft

* Apply suggestions from code review

Co-authored-by: Miguel Luna <39376769+mlunadia@users.noreply.github.com>

* address feedback

* fix bad link

* more updates

* clean up

---------

Co-authored-by: Miguel Luna <39376769+mlunadia@users.noreply.github.com>
(cherry picked from commit ffa8978)

# Conflicts:
#	docs/en/serverless/index.asciidoc

mergify bot mentioned this pull request

[8.x](backport #4854) Collect data with Elastic Cloud Native OpenTelemetry Endpoint #4864

Closed

mergify bot pushed a commit that referenced this pull request


          Collect data with Elastic Cloud Native OpenTelemetry Endpoint (#4854)

609e6d8

* add very rough draft

* Apply suggestions from code review

Co-authored-by: Miguel Luna <39376769+mlunadia@users.noreply.github.com>

* address feedback

* fix bad link

* more updates

* clean up

---------

Co-authored-by: Miguel Luna <39376769+mlunadia@users.noreply.github.com>
(cherry picked from commit ffa8978)

# Conflicts:
#	docs/en/serverless/index.asciidoc

mergify bot mentioned this pull request

[8.17](backport #4854) Collect data with Elastic Cloud Native OpenTelemetry Endpoint #4865

Closed

mergify bot pushed a commit that referenced this pull request


          Collect data with Elastic Cloud Native OpenTelemetry Endpoint (#4854)

120e1f6

* add very rough draft

* Apply suggestions from code review

Co-authored-by: Miguel Luna <39376769+mlunadia@users.noreply.github.com>

* address feedback

* fix bad link

* more updates

* clean up

---------

Co-authored-by: Miguel Luna <39376769+mlunadia@users.noreply.github.com>
(cherry picked from commit ffa8978)

# Conflicts:
#	docs/en/serverless/index.asciidoc

mergify bot mentioned this pull request

[8.18](backport #4854) Collect data with Elastic Cloud Native OpenTelemetry Endpoint #4866

Closed

bmorelli25 added a commit to elastic/docs-content that referenced this pull request


           Collect data with Elastic Cloud Native OpenTelemetry Endpoint (#1000)

69a4249

### Summary

Ports elastic/observability-docs#4854 to V3.

---------

Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>

mlunadia commented Apr 3, 2025

@bmorelli25 the endpoint is behind the edit connection alias, not a very intuitive UI unfortunately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-8.x backport-8.17 backport-8.18