Skip to content
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

Add the OTel quickstart #4615

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add the OTel quickstart #4615

wants to merge 7 commits into from
+135 −0

Conversation

mdbirnstiehl
Copy link
Contributor

Description

This PR adds docs for the OTel quickstart to the o11y docs.

Documentation sets edited in this PR

Check all that apply.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #250

@mdbirnstiehl mdbirnstiehl added backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify labels Dec 3, 2024
@mdbirnstiehl mdbirnstiehl self-assigned this Dec 3, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 3, 2024

A documentation preview will be available soon.

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.

@mdbirnstiehl mdbirnstiehl marked this pull request as ready for review December 4, 2024 21:26
@mdbirnstiehl mdbirnstiehl requested a review from a team as a code owner December 4, 2024 21:26
akhileshpok
akhileshpok reviewed Dec 5, 2024
View reviewed changes
Copy link

@akhileshpok akhileshpok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The configuration of OTel collectors in the values.yaml file will be updated in 8.18. The doc should reflect the latest configuration. Please verify the latest configuration with @rogercoll. Thanks

@mdbirnstiehl
Copy link
Contributor Author

The configuration of OTel collectors in the values.yaml file will be updated in 8.18. The doc should reflect the latest configuration. Please verify the latest configuration with @rogercoll. Thanks

Hi @akhileshpok, isn't the values file only related to the K8s quickstart?

eedugon
eedugon approved these changes Jan 2, 2025
View reviewed changes
Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
I like the Get value out of your data section. It might be interesting to add something similar to the k8s-otel related quickstart guide.

akhileshpok
akhileshpok approved these changes Jan 3, 2025
View reviewed changes
Copy link

@akhileshpok akhileshpok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi,
Looks good to me. Minor comment below.
Line 36 - "Copy the command under Step 2 and <missing 'run'> it in your terminal to start the EDOT Collector."
Thanks

mlunadia
mlunadia reviewed Jan 3, 2025
View reviewed changes
Copy link

@mlunadia mlunadia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General comment for these docs is that we should add more insights that could be useful but is stuff that we don't have in the UI. eg. what does a command do, common issues, where to find config and where to edit it with examples etc..

docs/en/observability/quickstarts/monitor-hosts-with-otel.asciidoc
[role="screenshot"]
image::images/quickstart-monitor-hosts-otel-entry-point.png[Host monitoring entry point]
. Select the appropriate platform.
. Copy the command, open a terminal on your host, and run the command to download and configure the OpenTelemetry collector.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should be a little bit more detailed on what the commands do, otherwise our documentation become a narration of what a user can already see in the UI.

I'd expect these docs to explain things that are useful but that don't belong in the UI.

docs/en/observability/quickstarts/monitor-hosts-with-otel.asciidoc
. Copy the command under Step 2 and it in your terminal to start the EDOT Collector.

Logs are collected from setup onward, so you won't see logs that occurred before starting the EDOT Collector.
The default log path is `/var/log/*`. To update the path, modify `otel.yml`.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add more detail on how to find to the otel.yml

docs/en/observability/quickstarts/monitor-hosts-with-otel.asciidoc
Under **Visualize your data**, you'll see links to **Logs Explorer** to view your logs and **Hosts** to view your host metrics.

[discrete]
== Get value out of your data
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets make this title more specific to things user want to do described in this paragraph. eg. Monitor Key metrics and explore logs.

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

@mlunadia mlunadia mlunadia left review comments

@akhileshpok akhileshpok akhileshpok approved these changes

@eedugon eedugon eedugon approved these changes

@rogercoll rogercoll Awaiting requested review from rogercoll

Assignees

@mdbirnstiehl mdbirnstiehl

Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify needs-product-review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@mdbirnstiehl @eedugon @rogercoll @mlunadia @akhileshpok