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

docs(readme): Adding docs for high prometheus memory usage, queue size and k8s support matrix #2967

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rnishtala-sumo
Copy link
Contributor

@rnishtala-sumo rnishtala-sumo commented Mar 31, 2023

Adding docs for high prometheus memory usage and otelcol enqueue failures

Checklist

  • Changelog updated or skip changelog label added
  • Documentation updated

@rnishtala-sumo rnishtala-sumo requested a review from a team as a code owner March 31, 2023 20:06
@github-actions github-actions bot added the documentation documentation label Mar 31, 2023

Please consult this when diagnosing issues before diving into Kubernetes directly.

[Zaidan Collection](https://stagdata.long.sumologic.net/ui/#/library/folder/20836981)
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not accessible

Copy link
Contributor Author

Choose a reason for hiding this comment

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

right! I was thinking about support when I added this, but we should probably only add links here that the customer can access.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, it's not an internal documentation

Comment on lines +292 to +293
When memory usage is higher than ~`95%` of Prometheus container's memory limit, (in the above case it's not: none of the containers exceeded
`95% * 20 = 19Gi` of used memory) remove WAL from within the container:
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this is proper solution. I would rather say that customer should increase memory requests/limits for Prometheus or reduce number of metrics being scraped by the Prometheus. Removing WAL is more like temporary solution

Copy link
Contributor Author

Choose a reason for hiding this comment

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

should we list removing WAL as the last resort, if increasing memory or reducing metrics isn't feasible?

Copy link
Contributor

Choose a reason for hiding this comment

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

yes, especially because it is temporary solution or clean up after/during metrics spike

Comment on lines +474 to +477
### Otelcol enqueue failures

Enqueue failures happen when otelcol can't write to its persistent queue. They signify data loss, as otelcol is unable to locally buffer the
data, and is forced to drop it.
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add snippet with example error message here?

@rnishtala-sumo rnishtala-sumo changed the title docs(troubleshooting): Adding docs for high prometheus memory usage and queue size docs(readme): Adding docs for high prometheus memory usage, queue size and k8s support matrix Apr 14, 2023
@@ -86,7 +86,7 @@ The following table displays the tested Kubernetes and Helm versions.

| Name | Version |
| ------------- | ---------------------------------------- |
| K8s with EKS | 1.21<br/>1.22<br/>1.23<br/>1.24 |
| K8s with EKS | 1.21<br/>1.22<br/>1.23<br/>1.24<br/>1.25 |
Copy link
Contributor

Choose a reason for hiding this comment

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

@rnishtala-sumo can we move that one out to a separate commit and/or PR? 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants