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.

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

Create Logs Guides #3097

Closed
2 tasks done
Tracked by #3302
mdbirnstiehl opened this issue Jul 24, 2023 · 0 comments
Closed
2 tasks done
Tracked by #3302

Create Logs Guides #3097

mdbirnstiehl opened this issue Jul 24, 2023 · 0 comments
Assignees

Comments

@mdbirnstiehl
Copy link
Contributor

mdbirnstiehl commented Jul 24, 2023

We want to create Logs Guides as a foundation for our logs documentation and will build off of the current resource guide that is essentially a list of links. The Logs Guides should improve on this by providing users with the following:

  • logs-specific context. For example, we should introduce the concept of data streams and how they apply specifically to logs and how to set them up for your logs. However, we shouldn't try to give users a comprehensive understanding of data streams. After providing them with the relevant information, we can link to more in-depth documentation should users want to learn more.
  • the "why" of each topic. For example, why should a user choose Elastic Agent over Filebeat, or why should a user install the agent in standalone mode vs. with Fleet.
  • real-life examples. For example, take a user with K8s through routing their system and app log data, creating an SLO for that log data, creating an SLO burn rate alert, and then creating a dashboard in Kibana.

There will be two Logs Guides. One for operations and one for developers. First stage will be the operations guide.

The outlines for the guides is located in this google doc.

Tasks

  1. Area:Logs+
    mdbirnstiehl
  2. Area:Logs+
    mdbirnstiehl
@mdbirnstiehl mdbirnstiehl self-assigned this Jul 24, 2023
@mdbirnstiehl mdbirnstiehl changed the title Create Log Guides Create Logs Guides Jul 24, 2023
@mdbirnstiehl mdbirnstiehl closed this as not planned Won't fix, can't repro, duplicate, stale Jun 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant