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

[apm] Clarify how data is populated in the APM Infrastructure tab #4692

Merged
merged 3 commits into from
Jan 29, 2025

Conversation

colleenmcginnis
Copy link
Contributor

Description

Clarifies how data is populated in the Infrastructure tab for a selected service in the Applications UI. This PR also attempts to provide guidance on how to self-diagnose / troubleshoot when the Infrastructure tab does not have any data.

I searched through some GitHub issues and discussion threads in addition to the resources @lucabelluccini linked to in #4359, but I wasn't able to find much information on troubleshooting.

This PR definitely needs more work, but I thought I'd open it to have something for the product/dev teams to respond to. @roshan-elastic can you help me find a technical reviewer? @lucabelluccini does this align with what you were expecting when you opened #4359?

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 #4359

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

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.

@colleenmcginnis colleenmcginnis added backport-8.x Automated backport to the 8.x branch with mergify backport-8.15 Automated backport with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify needs-dev-review needs-product-review labels Dec 13, 2024
@roshan-elastic
Copy link
Contributor

Hey @colleenmcginnis,

Thanks for this. Let me ask some of the team how this works - it was made a fair while ago.

@kpatticha / @jasonrhodes - Do you know who might be able to evaluate these docs which are explaining how the 'infrastructure' tab works in the service views?

Preview - Infrastructure Tab
Preview - No data shown in the infrastructure tab

@kpatticha
Copy link
Contributor

@roshan-elastic

@MiriamAparicio would you be able to take a look at these documents? I believe you’re the best person to provide input since you worked on the infrastructure tab in the service views.

If your availability is limited, I’m happy to dig into the code and help out

@colleenmcginnis
Copy link
Contributor Author

👋 @MiriamAparicio are you available to take a look at this PR? If not, @smith can you help me find a reviewer? Thanks!

@MiriamAparicio
Copy link

Hi @colleenmcginnis, sorry I missed this, I'll take a look tomorrow first thing

MiriamAparicio
MiriamAparicio previously approved these changes Jan 15, 2025
Copy link

@MiriamAparicio MiriamAparicio left a comment

Choose a reason for hiding this comment

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

LGTM, thanks 🌟

@colleenmcginnis colleenmcginnis changed the title [work in progress] [apm] Clarify how data is populated in the APM Infrastructure tab [apm] Clarify how data is populated in the APM Infrastructure tab Jan 16, 2025
@colleenmcginnis colleenmcginnis marked this pull request as ready for review January 16, 2025 17:15
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner January 16, 2025 17:15
Copy link
Contributor

@roshan-elastic roshan-elastic left a comment

Choose a reason for hiding this comment

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

LGTM!

@colleenmcginnis colleenmcginnis merged commit 6a482ac into elastic:main Jan 29, 2025
3 checks passed
mergify bot pushed a commit that referenced this pull request Jan 29, 2025
)

* first draft

* remove code comments

* remove code comment

(cherry picked from commit 6a482ac)
@colleenmcginnis colleenmcginnis deleted the issue-4359 branch January 29, 2025 20:56
mergify bot pushed a commit that referenced this pull request Jan 29, 2025
)

* first draft

* remove code comments

* remove code comment

(cherry picked from commit 6a482ac)
mergify bot pushed a commit that referenced this pull request Jan 29, 2025
)

* first draft

* remove code comments

* remove code comment

(cherry picked from commit 6a482ac)
mergify bot pushed a commit that referenced this pull request Jan 29, 2025
)

* first draft

* remove code comments

* remove code comment

(cherry picked from commit 6a482ac)
colleenmcginnis added a commit that referenced this pull request Jan 29, 2025
) (#4806)

* first draft

* remove code comments

* remove code comment

(cherry picked from commit 6a482ac)

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
colleenmcginnis added a commit that referenced this pull request Jan 29, 2025
) (#4807)

* first draft

* remove code comments

* remove code comment

(cherry picked from commit 6a482ac)

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
colleenmcginnis added a commit that referenced this pull request Jan 29, 2025
) (#4805)

* first draft

* remove code comments

* remove code comment

(cherry picked from commit 6a482ac)

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.15 Automated backport with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify needs-dev-review needs-product-review needs-writer-review
Projects
None yet
5 participants