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

Update infrastructure monitoring docs about containers #4186

Merged
merged 4 commits into from
Sep 3, 2024

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Aug 22, 2024

Copy link
Contributor

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 Aug 22, 2024

This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
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 Aug 22, 2024
@dedemorton dedemorton self-assigned this Aug 22, 2024
@dedemorton dedemorton added the backport-8.15 Automated backport with mergify label Aug 22, 2024
@mergify mergify bot removed the backport-skip Skip notification from the automated backport with mergify label Aug 22, 2024
@dedemorton dedemorton marked this pull request as ready for review August 22, 2024 16:26
@dedemorton dedemorton requested a review from a team as a code owner August 22, 2024 16:26
jennypavlova
jennypavlova previously approved these changes Aug 22, 2024
Copy link
Member

@jennypavlova jennypavlova left a comment

Choose a reason for hiding this comment

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

Nice 👏 thank you!
One note regarding the metrics - we also show Network and Disk now:

Screenshot 2024-08-22 at 19 05 41 Screenshot 2024-08-22 at 19 05 25

(Not sure if we want to include it in the screenshots - cc @roshan-elastic)
Overall LGTM but I am leaving the final review to @roshan-elastic

@dedemorton
Copy link
Contributor Author

One note regarding the metrics - we also show Network and Disk now

@jennypavlova Good point! I didn't see those tabs because I was looking at an environment that was all K8s. I think I should show those tabs.

@dedemorton
Copy link
Contributor Author

dedemorton commented Aug 22, 2024

@jennypavlova or @roshan-elastic I have a few follow-up questions after applying the Jenny's changes:

  • Can you point me to an environment that shows docker metrics? I've only been able to find oblt environments with K8s. I've temporarily used the screenshot that Jenny created to show all the metrics, but I think I might also need to redo the overview screenshot.
  • Are network and disk metrics shown in 8.15 as well as 8.16?
  • I don't see disk metrics listed for Docker in this document. Should it be? If so, I think we need to update the topic about docker metrics, too.

@roshan-elastic
Copy link
Contributor

Can you point me to an environment that shows docker metrics? I've only been able to find oblt environments with K8s. I've temporarily used the screenshot that Jenny created to show all the metrics, but I think I might also need to redo the overview screenshot.

Think I found something on edge:

image

Are network and disk metrics shown in 8.15 as well as 8.16?

Checking on the demo cluster (8.15), it doesn't look like it. Looks like 8.16 only.

I don't see disk metrics listed for Docker in this document. Should it be? If so, I think we need to update the topic about docker metrics, too.

Good catch. Added it now.

One note - it looks like the docker metrics are being used even for containerd containers - this looks like a bug so I'd ignore documenting Kubernetes network/disk metrics for now.

@jennypavlova - Could you confirm if this is a bug? I know we're going to clean all of this up in https://github.com/elastic/observability-dev/issues/3470

@dedemorton
Copy link
Contributor Author

dedemorton commented Aug 27, 2024

This PR targets 8.15, so I am going to remove mention of network and disk metrics for now.

I've opened a separate issue for 8.16 to make sure network and disk metrics get added when we're ready to document them.

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

Just a tiny suggestion.

Fix containerd references.

Co-authored-by: Colleen McGinnis <[email protected]>
Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

🐥

@dedemorton dedemorton merged commit 38b0630 into elastic:main Sep 3, 2024
4 checks passed
@dedemorton dedemorton deleted the issue#3745 branch September 3, 2024 17:51
mergify bot pushed a commit that referenced this pull request Sep 3, 2024
* Update infrastructure monitoring docs about containers

* Apply changes from review

* Revert to 8.15 level info about container metrics

* Apply suggestions from code review

Fix containerd references.

---------

Co-authored-by: Colleen McGinnis <[email protected]>
(cherry picked from commit 38b0630)
dedemorton added a commit to dedemorton/observability-docs that referenced this pull request Sep 3, 2024
dedemorton added a commit to dedemorton/observability-docs that referenced this pull request Sep 4, 2024
dedemorton added a commit that referenced this pull request Sep 5, 2024
* Port #4186 to serverless

* Fix attribute reference
dedemorton added a commit that referenced this pull request Sep 9, 2024
* Update infrastructure monitoring docs about containers

* Apply changes from review

* Revert to 8.15 level info about container metrics

* Apply suggestions from code review

Fix containerd references.

---------

Co-authored-by: Colleen McGinnis <[email protected]>
(cherry picked from commit 38b0630)

Co-authored-by: DeDe Morton <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.15 Automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request]: Update Containers docs for Infrastructure
4 participants