-
Notifications
You must be signed in to change notification settings - Fork 158
Edit and restructure time series docs #3461
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
base: main
Are you sure you want to change the base?
Conversation
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.
Note for reviewers: The OTLP page was added in #3360 (written by @felixbarny)
Slated for more improvements in #3179
I really like seeing advanced topics explicitly gathered together 👏 |
manage-data/data-store/data-streams/time-series-data-stream-tsds.md
Outdated
Show resolved
Hide resolved
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.
LGTM! 🦕
This looks great @marciw! The new layout is a big improvement.
applies_to: | ||
stack: preview 9.2 | ||
deployment: | ||
self: |
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.
is this accurate? the endpoint only works for self-managed deployments? I see references to elastic cloud below but I'm not sure what the relationship is between the note and the page
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.
@theletterf did you happen to check this when reviewing the original PR? #3360
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.
Yes, we specifically want to document that the ES OLTP endpoint is for self-managed only. For Cloud, we link to the Cloud OTLP Endpoint in the important
section.
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.
@marciw might be worth explaining a little in the important
note the takeaway for self-managed folks
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.
@felixbarny I'm thinking about moving the Best practices
to the top of this page and restructuring the intro a bit.
But in the meantime, can you help clarify:
-
does the Elastic Cloud Managed OTLP endpoint work for both Elastic Cloud Hosted and Serverless?
-
are there basically 3 options?
- collector in gateway mode (recommended)
- Elastic Cloud Managed OTLP endpoint
- the OTLP/HTTP endpoint for self-managed, as described on your new page
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.
Sounds good.
- Yes. See also https://www.elastic.co/docs/reference/opentelemetry/motlp#send-data-to-elastic, which lists instructions for serverless and ECH
- It's more like 2 options:
- For ECH/Serverless there's the managed OTLP Endpoint that users can send data to directly from their applications or from another OTel collector. (if you will, the managed OTLP Endpoint is a managed gateway collector)
- For self-managed, it's recommended that applications send their metrics to a gateway collector rather than directly to ES. The gateway collector may use the new OTLP Endpoint using the
otlphttp
exporter rather than theelasticsearch
exporter for metrics (but at this point not for other signals).
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.
@felixbarny when we say self-managed, do we mean ECE/ECK/vanilla cluster?
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.
💅 I had to dig very deep for the nittiest of nits :)
Co-authored-by: David Kilfoyle <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
Co-authored-by: David Kilfoyle <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
(Replaces #3222, which was an ominshambles)
This PR restructures and edits time series data stream docs as part of #1502.
❗ Notes for reviewers:
applies_to
thingies could probably be better; I am committed to maintaining the thinnest of grasps onapplies_to
metadataSummary of changes: