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

Include docs around entity expiration time #14055

Closed
danielgblanco opened this issue Jul 31, 2023 · 5 comments
Closed

Include docs around entity expiration time #14055

danielgblanco opened this issue Jul 31, 2023 · 5 comments
Assignees
Labels
content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers)

Comments

@danielgblanco
Copy link
Contributor

Is your feature request related to a problem? Please describe

In Kubernetes deployments, New Relic entities are relatively ephemeral. For instance, pod entities expire after 4 hours of not sending data. This can affect navigation in the UI (i.e. an engineer trying to find a past pod) or in alerts (i.e. past alerts on pods that were deleted no longer attached to an entity).

There is a doc in Github around expiration for entities:
https://github.com/newrelic/entity-definitions/blob/main/docs/entities/lifecycle.md

And another configuring the default expiration times:
https://github.com/newrelic/entity-definitions/tree/main/entity-types

Describe the solution you'd like

I'd love to have a doc in docs.newrelic.com that explains how entities work, what their expiration time is, and how that affects things like UI navigation or alerts.

Describe why this important to you

It helps solve questions about entities disappearing from the UI or alerts.

Additional context

N/A

@danielgblanco danielgblanco added eng issues related to site functionality that requires engineering enhancement New feature or request labels Jul 31, 2023
@github-actions
Copy link

Hi @danielgblanco 👋

Thank you for filing an issue! We'll triage your issue and let you know if we have questions, and then route it to the appropriate team so we can get it solved.

@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues Jul 31, 2023
@zuluecho9 zuluecho9 added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) and removed enhancement New feature or request eng issues related to site functionality that requires engineering labels Jul 31, 2023
@zuluecho9
Copy link
Contributor

@danielgblanco Thanks Daniel. Could you give us a little more detail about what the problem you were trying to solve was? Was it specifically for K8s data that you were having issues? Or was it more general, for other types of data outside K8s? Maybe you could explain the specific challenge that led you to reporting this (and we thank you for that).

@zuluecho9 zuluecho9 self-assigned this Jul 31, 2023
@zuluecho9 zuluecho9 moved this from Hero to triage to In progress in Docs PRs and Issues Jul 31, 2023
@danielgblanco
Copy link
Contributor Author

Hi there! The problem came mainly from two areas:

  1. Alerts firing on a Kubernetes pod getting OOM killed, for example. It's super useful when an entity is attached to an alert, as it takes service owners directly into the pod view and start debugging. If the pod was killed more than 4 hours ago, the entity will not be attached, making the owner have to go to logs or other metrics via the query explorer. Not necessarily an issue with the expiration time, but it'd be good for service owners to know when entities expire.
  2. When using the Kubernetes cluster view, it'd be good for service owners to know what pods they can expect to find in those views (e.g. if they go back 6 hours their pod that was not there would not be found)

@zuluecho9
Copy link
Contributor

@danielgblanco Thank you, Daniel. I'm adding some info about this in this PR, if you'd like to check it out. #14101

@danielgblanco
Copy link
Contributor Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers)
Projects
Development

No branches or pull requests

2 participants