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 log data set monitoring docs #3960

Merged
merged 11 commits into from
Jul 3, 2024

Conversation

mdbirnstiehl
Copy link
Contributor

@mdbirnstiehl mdbirnstiehl commented Jun 3, 2024

Closes #3344

Because the system is set to accept all logs, users need to be able to monitor their data sets to find and fix any issues that occur in their log data. The information found on this page will serve as a foundation for the user to monitor the overall health of their data sets and find any data sets with issues and fix them. The data set quality page will available through Stack Management.

@mdbirnstiehl mdbirnstiehl self-assigned this Jun 3, 2024
Copy link
Contributor

github-actions bot commented Jun 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.

Copy link
Contributor

mergify bot commented Jun 3, 2024

This pull request does not have a backport label. Could you fix it @mdbirnstiehl? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Jun 3, 2024
@mdbirnstiehl mdbirnstiehl changed the title Create monitoring log datasets docs Create log data set monitoring docs Jun 5, 2024
@mdbirnstiehl mdbirnstiehl marked this pull request as ready for review June 10, 2024 20:33
@mdbirnstiehl mdbirnstiehl requested a review from a team as a code owner June 10, 2024 20:33
@mdbirnstiehl
Copy link
Contributor Author

@gbamparop I've update the data set monitoring docs here to provide some general information and tips on investigating issues. Is there any additional guidance you think we should provide users at this point?

@awahab07 I added the privilege requirements here

Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

Left a minor editing suggestion.

Copy link
Contributor

mergify bot commented Jun 12, 2024

This pull request is now in conflict. Could you fix it @mdbirnstiehl? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b monitor-datasets upstream/monitor-datasets
git merge upstream/main
git push upstream monitor-datasets

@yngrdyn
Copy link
Contributor

yngrdyn commented Jun 19, 2024

Hey @mdbirnstiehl thanks for creating this PR, I was not able to check the preview, it has like an old version (without the changes) is that expected?

@gbamparop
Copy link
Contributor

gbamparop commented Jun 19, 2024

@mdbirnstiehl will the stateful docs be added in another PR?

@mdbirnstiehl
Copy link
Contributor Author

@mdbirnstiehl will the stateful docs be added in another PR?

@gbamparop I was waiting until we finalized the serverless docs and then I was planning on basing the stateful docs off of them. I can either add them to this PR after the serverless docs are finalized or create a new PR.

One question is whether or not there will be significant changes between the two that would require any large rewrites.

@yngrdyn
Copy link
Contributor

yngrdyn commented Jun 19, 2024

One question is whether or not there will be significant changes between the two that would require any large rewrites.

Changes so far are not substancial, only around size column and summary, Size is not available on serverless at the moment, only stateful

@elasticdocs
Copy link

elasticdocs commented Jun 25, 2024

🚀 Built elastic-dot-co-docs-preview-docs successfully!

Issues? Visit #next-docs in Slack

@mdbirnstiehl
Copy link
Contributor Author

mdbirnstiehl commented Jun 25, 2024

Hey @mdbirnstiehl thanks for creating this PR, I was not able to check the preview, it has like an old version (without the changes) is that expected?

@yngrdyn sorry I missed this initially. You can view the preview for serverless here . I had forgotten to add the doc build label.

yngrdyn
yngrdyn previously approved these changes Jun 27, 2024
Copy link
Contributor

@yngrdyn yngrdyn left a comment

Choose a reason for hiding this comment

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

LGTM, the only thing is that screenshot is outdated.
It's showing logs-* instead of logs-*-*

Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

LGTM

@mdbirnstiehl mdbirnstiehl merged commit 8c2fdec into elastic:main Jul 3, 2024
4 checks passed
@mdbirnstiehl mdbirnstiehl deleted the monitor-datasets branch July 3, 2024 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify ci:doc-build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Document the dataset health management page
5 participants