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(thanos): add more context and quick start guide #477

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

richardtief
Copy link
Member

@richardtief richardtief commented Nov 4, 2024

Part of #356

@richardtief richardtief requested review from a team as code owners November 4, 2024 11:53
Copy link
Contributor

@viennaa viennaa left a comment

Choose a reason for hiding this comment

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

Thanks for taking the time to enhance the documentation. Especially the pictures are going to help understanding the topic.

I have some remarks, especially about the first section.

thanos/README.md Outdated

## Overview

Observability is often required for operation and automation of service offerings. To get the insights provided by an application and the container runtime environment, you need telemetry data in the form of _metrics_ or _logs_ sent to backends such as _Prometheus_ or _OpenSearch_. With the **Thanos** plugin you can scale the _metric_ part of the observability stack horizontally by hooking into the Prometheus provided by the **kube-monitoring** plugin and optionally save your data in the object storage.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Observability is often required for operation and automation of service offerings. To get the insights provided by an application and the container runtime environment, you need telemetry data in the form of _metrics_ or _logs_ sent to backends such as _Prometheus_ or _OpenSearch_. With the **Thanos** plugin you can scale the _metric_ part of the observability stack horizontally by hooking into the Prometheus provided by the **kube-monitoring** plugin and optionally save your data in the object storage.
Observability is required for monitoring the lifecycle of service offerings. To get the insights provided by an application and the container runtime environment, you need telemetry data in the form of _metrics_ or _logs_ which are made accessible through backends such as _Prometheus_ or _OpenSearch_.
With the **Thanos** plugin you can enhance the _metric_ part of the observability stack to scale horizontally and leverage object storage for a long retention setup.

What explicitly do you mean with container runtime environment?

To me this is/was somehow hard to read and grasp. I rewrote it, not sure if this is understandable - or even needed. The following section (In general, Thanos is...)is more to the point, while this is too generic. I would wipe it entirely. Similar wording could go in an overall metrics architecture document.

Furthermore, I don't see why logs w/ need to be mentioned here, this also would rather be part of an overarching document.

Copy link
Member Author

Choose a reason for hiding this comment

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

Kubernetes. 🤣

What explicitly do you mean with container runtime environment?

You're right, I admit. We don't have space for such a general document. That's why it's included in every plugin at the moment. We can also remove it and I will find a place for it.

To me this is/was somehow hard to read and grasp. I rewrote it, not sure if this is understandable - or even needed. The following section (In general, Thanos is...)is more to the point, while this is too generic. I would wipe it entirely. Similar wording could go in an overall metrics architecture document.
Furthermore, I don't see why logs w/ need to be mentioned here, this also would rather be part of an overarching document.

thanos/README.md Outdated Show resolved Hide resolved
thanos/README.md Outdated Show resolved Hide resolved
thanos/README.md Outdated Show resolved Hide resolved
thanos/README.md Show resolved Hide resolved
thanos/README.md Outdated

Observability is often required for operation and automation of service offerings. To get the insights provided by an application and the container runtime environment, you need telemetry data in the form of _metrics_ or _logs_ sent to backends such as _Prometheus_ or _OpenSearch_. With the **Thanos** plugin you can scale the _metric_ part of the observability stack horizontally by hooking into the Prometheus provided by the **kube-monitoring** plugin and optionally save your data in the object storage.

In general, Thanos is a set of components that can be used to extend the storage and retrieval of metrics in Prometheus. It allows you to store metrics in a remote object store and query them across multiple Prometheus servers and Greenhouse clusters. This Plugin is intended to provide a set of pre-configured Thanos components that enable a proven composition. At the core, a set of Thanos components is installed that adds long-term storage capability to a single **kube-monitoring** Plugin and makes both current and historical data available again via one Thanos Query component.
Copy link
Contributor

Choose a reason for hiding this comment

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

I am now asking myself, if this is sort of a repetition of the very first sentence

Learn more about the Thanos Plugin. Use it to enable extended metrics retention and querying across Prometheus servers and Greenhouse clusters.

This part could easily go there:

This Plugin is intended to provide a set of pre-configured Thanos components that enable a proven composition. At the core, a set of Thanos components is installed that adds long-term storage capability to a single kube-monitoring Plugin and makes both current and historical data available again via one Thanos Query component.

We could however add some prose on how the components are acting together here?

Copy link
Member Author

Choose a reason for hiding this comment

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

You are right. We can improve.

I am now asking myself, if this is sort of a repetition of the very first sentence

Good idea. I'm open for a contribution from your side.

We could however add some prose on how the components are acting together here?

@richardtief richardtief force-pushed the polish-plugin-docs-thanos-edition branch from 38bf357 to d67df12 Compare November 4, 2024 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants