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: add link to RH docu VictoriaMetrics #59

Merged
merged 7 commits into from
Feb 22, 2024

Conversation

schwesig
Copy link
Contributor

Signed-off-by: ​/Thor(sten)?/ Schwesig <89909507+schwesig@users.noreply.github.com>
@schwesig schwesig added the documentation Improvements or additions to documentation label Feb 21, 2024
@schwesig schwesig self-assigned this Feb 21, 2024
architecture/observability/README.md Outdated Show resolved Hide resolved
architecture/observability/README.md Outdated Show resolved Hide resolved
schwesig and others added 2 commits February 21, 2024 14:38
Co-authored-by: Lars Kellogg-Stedman <lars@oddbit.com>
Co-authored-by: Lars Kellogg-Stedman <lars@oddbit.com>
@schwesig
Copy link
Contributor Author

@larsks thanks; I first didn't think a small chapter would be fair to "block" the headline. But we don't have any other links yet, so this makes sense. I am using your idea.

@schwesig schwesig requested a review from larsks February 21, 2024 13:45
@larsks
Copy link
Member

larsks commented Feb 21, 2024

I think the link to https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/observability/using-observability#exporting-metrics-to-external-endpoints doesn't really explain what VictoriaMetrics is. Maybe the link should go to https://victoriametrics.com/products/open-source/ instead?

Also, I am having a hard time parsing the description:

VictoriaMetrics offers an option it is configured to go to a Backup Object Bucket, and on the infra side, the metrics go to a separate metrics bucket with retention.

There are some grammar and clarity problems that need correcting there. I'm unable to offer a suggestion because I'm not entirely clear what this sentence is trying to say.

@schwesig
Copy link
Contributor Author

I think the link to https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/observability/using-observability#exporting-metrics-to-external-endpoints doesn't really explain what VictoriaMetrics is. Maybe the link should go to https://victoriametrics.com/products/open-source/ instead?

yes, I was thinking this, ... without opening a whole bucket and adding links to all mentioned services, apps, and operators.

@schwesig
Copy link
Contributor Author

Let me go through the text with Jeet and Harshil later and clarify a few things to make it easier to understand.

Turn the list of technology choices into an actual list, and add links to
products.
@larsks
Copy link
Member

larsks commented Feb 21, 2024

I've pushed up some suggested formatting changes. This doesn't address the language.

architecture/observability/README.md Outdated Show resolved Hide resolved
Review request computate; more clear explanation how VictoriaMetrics is
setup and can be used for our use case.
@schwesig schwesig requested a review from computate February 21, 2024 19:00
schwesig and others added 2 commits February 21, 2024 20:49
@schwesig schwesig requested a review from larsks February 21, 2024 20:08
@schwesig
Copy link
Contributor Author

@larsks thanks for all the links. I added some more benefits using VictoriaMetrics in the doc. I hope this answers the why a little bit better.

@schwesig schwesig merged commit de5950b into OCP-on-NERC:main Feb 22, 2024
1 check passed
@schwesig schwesig deleted the 20240221_updateObservability branch March 1, 2024 14:35
schwesig added a commit to schwesig/OCP-on-NERC_docs that referenced this pull request Jun 10, 2024
* docs: add link to RH docu VictoriaMetrics

Signed-off-by: ​/Thor(sten)?/ Schwesig <89909507+schwesig@users.noreply.github.com>

* Update architecture/observability/README.md

Co-authored-by: Lars Kellogg-Stedman <lars@oddbit.com>

* Update architecture/observability/README.md

Co-authored-by: Lars Kellogg-Stedman <lars@oddbit.com>

* Reformat observability documentation

Turn the list of technology choices into an actual list, and add links to
products.

* docs: updating VictoriaMetrics description

Review request computate; more clear explanation how VictoriaMetrics is
setup and can be used for our use case.

* Update architecture/observability/README.md

Co-authored-by: Lars Kellogg-Stedman <lars@oddbit.com>

* adding more details about VictoriaMetrics

---------

Signed-off-by: ​/Thor(sten)?/ Schwesig <89909507+schwesig@users.noreply.github.com>
Co-authored-by: Lars Kellogg-Stedman <lars@oddbit.com>
Co-authored-by: Lars Kellogg-Stedman <lars@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants