openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

Logging 6x - Docs Outline / Planning

Open libander opened this issue 1 year ago • 5 comments

Version(s): 4.16+

Issue: https://issues.redhat.com/browse/OBSDOCS-1099

Link to docs previews:

https://76623--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-about.html https://76623--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-clf.html https://76623--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-loki.html https://76623--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-start.html

Additional information: Not intended to merge, this PR is for planning & collaboration.

libander avatar May 29 '24 00:05 libander

🤖 Fri Jun 28 15:54:19 - Prow CI generated the docs preview:

https://76623--ocpdocs-pr.netlify.app/ https://76623--ocpdocs-pr.netlify.app/openshift-dedicated/latest/observability/logging/performance_reliability/logging-content-filtering.html https://76623--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-about.html https://76623--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-clf.html https://76623--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-loki.html https://76623--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-start.html https://76623--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/performance_reliability/logging-content-filtering.html https://76623--ocpdocs-pr.netlify.app/openshift-rosa/latest/observability/logging/performance_reliability/logging-content-filtering.html

ocpdocs-previewbot avatar May 29 '24 00:05 ocpdocs-previewbot

/retest

libander avatar Jun 12 '24 03:06 libander

@r2d2rnd

libander avatar Jun 26 '24 09:06 libander

@libander: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/validate-portal aef31f56d277faa45b7fea986c0ed957fc93ba04 link true /test validate-portal

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.

openshift-ci[bot] avatar Jun 28 '24 15:06 openshift-ci[bot]

Hello Libby,

I want to add a comment only about the scheleton and in the code I will put some notes about my findings but as you commented, the priority is that it is well organized.

  • The following sections are under Performance and reliability tuning and also under Configuring log Forwarding.: Filtering logs by content Filtering logs by metadata

In the latest versions, they are under Performance and reliability.

From my perspective I think of two options.

  1. Leave it as in the latest versions and also add Forwarding application logs from specific projects and Forwarding application logs from specific pods sections or,

  2. Leave it under Configuring log Forwarding and create a new content inside this section adding these filters and Forwarding application logs from specific projects and Forwarding application logs from specific pods sections (Don't forget to add how to send the logs to an external third-party).

  • Configuring LokiStack storage section is fine but inside Log Storage section we found a section called Configuring the LokiStack log store and installing log storage. Maybe for the customer should be easy to have only one section with different contents that matches all the information from the three points.

These points may have been taken into consideration but I preferred to leave them reflected here. I will update and confirm that the review is progressing.

Thank you very much for your hard work on the documentation

acandelp avatar Jul 01 '24 10:07 acandelp

/assign @anpingli

anpingli avatar Jul 23 '24 07:07 anpingli

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot avatar Nov 24 '24 09:11 openshift-bot

PR needs rebase.

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-merge-robot avatar Nov 24 '24 09:11 openshift-merge-robot

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten /remove-lifecycle stale

openshift-bot avatar Dec 25 '24 00:12 openshift-bot

/close

libander avatar Dec 25 '24 21:12 libander

@libander: Closed this PR.

In response to this:

/close

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-ci[bot] avatar Dec 25 '24 21:12 openshift-ci[bot]