Skip to content

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

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

Closed
mlunadia opened this issue Mar 19, 2025 · 7 comments · Fixed by #4854 or elastic/opentelemetry#200

Comments

@mlunadia
Copy link

Description

Description

We need to create documentation for the Public Tech Preview of the Managed OTLP Endpoint for serverless users. The public tech preview is scheduled for end of March 2025.

This documentation should serve as a go-to reference for users participating in the tech preview. It should include:

✅ What to include

  • Overview of the Managed OTLP Endpoint
  • Step-by-step instructions for sending data
  • Authentication or configuration requirements
  • Limitations of the tech preview
  • Troubleshooting section
  • Where to provide feedback

📍 Where it should live

  • Ideally under the Elastic Observability docs somewhere in https://www.elastic.co/guide/en/serverless/
  • Should be easily shareable with users during onboarding

📌 Why this matters

We need a centralized place to direct serverless users who want to try out the tech preview and ensure they’re set up for success, with clear expectations on what’s supported.

Resources

Please request our private tech preview doc.

Which documentation set does this change impact?

Serverless only

Feature differences

Managed OpenTelemetry endpoint is initially only available in serverless

What release is this request related to?

N/A

Collaboration model

Other (please describe below)

Point of contact.

Docs team to create the template and engineering/product to write the details

contacts: prod @mlunadia eng @raultorrecilla

@bmorelli25
Copy link
Member

A rough outline (based off of the internal tech preview doc) is available in #4854. I put my questions in comments in the source files. Please take a look and let me know what feedback you have.

@bturquet
Copy link

bturquet commented Apr 3, 2025

Live docs here: https://www.elastic.co/guide/en/serverless/current/collect-data-with-native-otlp.html
Some questions are still pending in the PR.

@axw
Copy link
Member

axw commented Apr 4, 2025

We don't need the "Copy the OTEL_EXPORTER_OTLP_ENDPOINT URL. Replace .apm with .ingest and save this value for later." instruction any more do we? Users should see the two options now in the UI.

@vigneshshanmugam
Copy link
Member

Its also relevant for https://elastic.github.io/opentelemetry/quickstart/serverless/ and we have some docs that are duplicated between these two pages, Maybe we can link to places where they are relevant instead /cc @AlexanderWert

@AlexanderWert
Copy link
Member

\cc @theletterf

It's something we should fix:

  1. replace "Copy the OTEL_EXPORTER_OTLP_ENDPOINT URL. Replace .apm with .ingest and save this value for later." in here with instructions based on the new UI
  2. In this page I think we can remove the content and just point to the fixed page mentioned in (1.)
  3. Also on https://www.elastic.co/guide/en/serverless/current/collect-data-with-native-otlp.html there's a broken link from application use-cases. We could instead point to the overview page of the EDOT SDKs

@theletterf
Copy link

@AlexanderWert As we agreed on executing the cleanup in #4843, I would say the these changes should be applied to the EDOT docs only for now. Do you agree? If that's the case, I'd close this issue.

@AlexanderWert
Copy link
Member

After discussing with @theletterf , we for now will proceed with:

Content to move:

Image Image Image

Content to update / change:

  • how to get the Managed OTLP endpoint
  • how to create the API key

(for both let's use the UI flow through onboarding Add Data --> Application --> OpenTelemetry´ --> Managed OTLP Endpoint` --> copy endpoint, create API key)

Content to ignore (because it's redundant)

This entire section:

Image

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