Skip to content

OBSDOCS-1166-Loki Statement of Purpose #78822

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 26, 2024
Merged

OBSDOCS-1166-Loki Statement of Purpose #78822

merged 1 commit into from
Jul 26, 2024

Conversation

shreyasiddhartha
Copy link
Contributor

@shreyasiddhartha shreyasiddhartha commented Jul 12, 2024 •
edited
Loading

@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 12, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jul 12, 2024 •
edited
Loading

🤖 Fri Jul 26 14:23:12 - Prow CI generated the docs preview:

https://78822--ocpdocs-pr.netlify.app/
https://78822--ocpdocs-pr.netlify.app/openshift-dedicated/latest/observability/logging/log_storage/about-log-storage.html
https://78822--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/log_storage/about-log-storage.html
https://78822--ocpdocs-pr.netlify.app/openshift-rosa/latest/observability/logging/log_storage/about-log-storage.html

libander
libander suggested changes Jul 22, 2024
View reviewed changes
@jparker-rh
Copy link

LGTM

@openshift-ci openshift-ci bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 22, 2024
@kabirbhartiRH
Copy link

LGTM

@shreyasiddhartha
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Jul 24, 2024
@aspauldi
Copy link

/label peer-review-in-progress

@openshift-ci openshift-ci bot added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Jul 24, 2024
aspauldi
aspauldi reviewed Jul 24, 2024
View reviewed changes
@aspauldi
Copy link

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Jul 24, 2024
@shreyasiddhartha
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Jul 26, 2024
@jeana-redhat jeana-redhat added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Jul 26, 2024
jeana-redhat
jeana-redhat reviewed Jul 26, 2024
View reviewed changes
Copy link
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

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

I'm not certain about some of the use of terms in here and have solicited help from @libander for her expertise here 🙇

libander
libander reviewed Jul 26, 2024
View reviewed changes
snippets/logging-loki-statement-snip.adoc Outdated
//
:_mod-docs-content-type: SNIPPET

Loki is a horizontally scalable, highly available, multi-tenant log aggregation system offered as a log store for the {logging}. OpenShift {logging-uc} provides Loki as a GA log store that can be visualized with the OpenShift {ObservabilityShortName} UI. The Loki configuration provided by OpenShift {logging-uc} is a short-term log store designed to enable users to perform fast troubleshooting with the collected logs. For that purpose, the OpenShift {logging-uc} configuration of Loki has short-term storage, and is optimized for very recent queries. For long-term storage or queries over a long time period, users should look to log stores external to their OpenShift cluster.
Copy link
Contributor

@libander libander Jul 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

"Loki is a horizontally scalable, highly available, multi-tenant log aggregation system offered as a log store for {logging}. {logging-uc} {for} provides Loki as a GA log store that can be visualized with the OpenShift {ObservabilityShortName} UI. The Loki configuration provided by {logging} {for} is a short-term log store designed to enable users to perform fast troubleshooting with the collected logs. For that purpose, the {logging} {for} configuration of Loki has short-term storage, and is optimized for very recent queries. For long-term storage or queries over a long time period, users should look to log stores external to their cluster."

The official name of logging (logging for Red Hat Openshift) can be rendered in attributes using {logging} {for} - The official name is lower case, and should only be uppercase when its grammatically appropriate.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestion @libander. @jeana-redhat made the change suggested by Libby. :)

libander
libander reviewed Jul 26, 2024
View reviewed changes
snippets/logging6x-loki-statement-snip.adoc Outdated
//
:_mod-docs-content-type: SNIPPET

Loki is a horizontally scalable, highly available, multi-tenant log aggregation system offered as a log store for {logging}. {logging-uc} {for} provides Loki as a GA log store that can be visualized with the OpenShift {ObservabilityShortName} UI. The Loki configuration provided by OpenShift {logging-uc} is a short-term log store designed to enable users to perform fast troubleshooting with the collected logs. For that purpose, the {logging} {for} configuration of Loki has short-term storage, and is optimized for very recent queries. For long-term storage or queries over a long time period, users should look to log stores external to their cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

Loki is a horizontally scalable, highly available, multi-tenant log aggregation system offered as a GA log store for {logging} {for} that can be visualized with the OpenShift {ObservabilityShortName} UI. The Loki configuration provided by OpenShift {logging-uc} is a short-term log store designed to enable users to perform fast troubleshooting with the collected logs. For that purpose, the {logging} {for} configuration of Loki has short-term storage, and is optimized for very recent queries. For long-term storage or queries over a long time period, users should look to log stores external to their cluster.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Made this change. Thanks!

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Jul 26, 2024

@shreyasiddhartha: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

jeana-redhat
jeana-redhat approved these changes Jul 26, 2024
View reviewed changes
Copy link
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

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

TYSM @libander for your help!

Output LGTM

/remove-label merge-review-in-progress
/remove-label merge-review-needed

@openshift-ci openshift-ci bot removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Jul 26, 2024
@jeana-redhat jeana-redhat added this to the Continuous Release milestone Jul 26, 2024
@jeana-redhat jeana-redhat merged commit 867f048 into openshift:logging-docs-6.0 Jul 26, 2024
2 checks passed
@jeana-redhat
Copy link
Contributor

/cherrypick enterprise-4.17

@jeana-redhat
Copy link
Contributor

/cherrypick enterprise-4.16

@jeana-redhat
Copy link
Contributor

/cherrypick enterprise-4.15

@jeana-redhat
Copy link
Contributor

/cherrypick enterprise-4.14

@openshift-cherrypick-robot
Copy link

@jeana-redhat: new pull request created: #79581

In response to this:

/cherrypick enterprise-4.17

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

This was referenced Jul 26, 2024
Merged
Merged
@openshift-cherrypick-robot
Copy link

@jeana-redhat: new pull request created: #79582

In response to this:

/cherrypick enterprise-4.16

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot
Copy link

@jeana-redhat: new pull request created: #79583

In response to this:

/cherrypick enterprise-4.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Jul 26, 2024
Merged
@openshift-cherrypick-robot
Copy link

@jeana-redhat: new pull request created: #79584

In response to this:

/cherrypick enterprise-4.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Jul 26, 2024
Merged
smunje1 pushed a commit to smunje1/openshift-docs that referenced this pull request Aug 12, 2024
@jeana-redhat @smunje1
Merge pull request openshift#78822 from shreyasiddhartha/OBSDOCS-1166
8eacedb 
OBSDOCS-1166-Loki Statement of Purpose
smunje1 added a commit to smunje1/openshift-docs that referenced this pull request Aug 12, 2024
@smunje1
Revert "Merge pull request openshift#78822 from shreyasiddhartha/OBSD…
77cb6f4 
…OCS-1166"

This reverts commit 8eacedb, reversing
changes made to bd06147.
smunje1 added a commit to smunje1/openshift-docs that referenced this pull request Aug 12, 2024
@smunje1
Reapply "Merge pull request openshift#78822 from shreyasiddhartha/OBS…
2dfdefb 
…DOCS-1166"

This reverts commit 77cb6f4.
smunje1 pushed a commit to smunje1/openshift-docs that referenced this pull request Aug 12, 2024
@jeana-redhat @smunje1
Merge pull request openshift#78822 from shreyasiddhartha/OBSDOCS-1166
543a9ea 
OBSDOCS-1166-Loki Statement of Purpose
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aspauldi aspauldi aspauldi left review comments

@libander libander libander requested changes

@jeana-redhat jeana-redhat jeana-redhat approved these changes

Assignees
No one assigned
Labels
branch/enterprise-4.14 branch/enterprise-4.15 branch/enterprise-4.16 branch/enterprise-4.17 peer-review-done Signifies that the peer review team has reviewed this PR size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
Continuous Release
Development

Successfully merging this pull request may close these issues.
8 participants
@shreyasiddhartha @ocpdocs-previewbot @jparker-rh @kabirbhartiRH @aspauldi @jeana-redhat @openshift-cherrypick-robot @libander