Skip to content

[Enterprise-4.12] OBSDOCS-845 - Logging API Reference Updates #74922

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
Closed
wants to merge 1 commit into from
Closed

[Enterprise-4.12] OBSDOCS-845 - Logging API Reference Updates #74922

wants to merge 1 commit into from

Conversation

libander
Copy link
Contributor

@libander libander commented Apr 20, 2024 •
edited
Loading

Version(s): 4.12

Issue: OBSDOCS-845

Link to docs preview: https://74922--ocpdocs-pr.netlify.app/openshift-enterprise/latest/logging/api_reference/logging-5-6-reference
https://74922--ocpdocs-pr.netlify.app/openshift-enterprise/latest/logging/api_reference/logging-5-7-reference.html
https://74922--ocpdocs-pr.netlify.app/openshift-enterprise/latest/logging/api_reference/logging-5-8-reference.html

QE review:

  • QE has approved this change.

Additional information:
Logging Version | Supported OCP Versions Matrix
5.9 | 4.15, 4.14, 4.13
5.8 | 4.12, 4.13, 4.14, 4.15
5.7 | 4.12, 4.13, 4.14
5.6 | 4.12, 4.13

PRs by branch:
#74925
#74924
#74923
#74922

@openshift-ci openshift-ci bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Apr 20, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Apr 20, 2024 •
edited
Loading

🤖 Fri Apr 26 15:57:42 - Prow CI generated the docs preview:

https://74922--ocpdocs-pr.netlify.app/
https://74922--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/api_reference/logging-5-8-reference.html

@libander libander force-pushed the OBSDOCS-845-5.6 branch 2 times, most recently from 3af7515 to 3e2d3bf Compare April 20, 2024 15:38
@libander libander mentioned this pull request Apr 20, 2024
Closed
@libander libander changed the title OBSDOCS-845 - Logging API Reference Updates [Enterprise-4.12] OBSDOCS-845 - Logging API Reference Updates Apr 20, 2024
This was referenced Apr 20, 2024
Closed
Closed
@libander
Copy link
Contributor Author

@anpingli / @kabirbhartiRH - lgtm please.

@libander
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 Apr 22, 2024
@anpingli
Copy link

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 23, 2024
@GroceryBoyJr
Copy link
Contributor

/assign @GroceryBoyJr
/remove-label peer-review-needed
/label peer-review-in-progress

@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Apr 23, 2024
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Apr 26, 2024
@anpingli
Copy link

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 26, 2024
@GroceryBoyJr
Copy link
Contributor

https://74922--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/api_reference/logging-5-6-reference

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Apr 26, 2024
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Apr 26, 2024

New changes are detected. LGTM label has been removed.

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Apr 26, 2024

@libander: 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/test-infra repository. I understand the commands that are listed here.

GroceryBoyJr
GroceryBoyJr reviewed Apr 29, 2024
View reviewed changes
Copy link
Contributor

@GroceryBoyJr GroceryBoyJr left a comment

Choose a reason for hiding this comment

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

@libander peer review done, the same issues occurred repeatedly in each of the 5.6, 5.7 and 5.8 logging reference .adoc files. I called out everything I could find in the 5.6 file, then used what I found there to search in the 5.7 and 5.8 files. If the remaining PR's feature the same issues, I will summarize rather than going through the entire PR and repeating what I've already done.

observability/logging/api_reference/logging-5-6-reference.adoc
|======================
|Property|Type|Description

|enableStructuredContainerLogs|bool| *(optional)* EnableStructuredContainerLogs enables multi-container structured logs to allow
Copy link
Contributor

Choose a reason for hiding this comment

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

It appears the end of this statement is missing

observability/logging/api_reference/logging-5-6-reference.adoc
|Property|Type|Description

|enableStructuredContainerLogs|bool| *(optional)* EnableStructuredContainerLogs enables multi-container structured logs to allow
|structuredTypeKey|string| *(optional)* StructuredTypeKey specifies the metadata key to be used as name of elasticsearch index
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
|structuredTypeKey|string| *(optional)* StructuredTypeKey specifies the metadata key to be used as name of elasticsearch index
|structuredTypeKey|string| *(optional)* StructuredTypeKey specifies the metadata key to be used as name of the elasticsearch index

observability/logging/api_reference/logging-5-6-reference.adoc

|enableStructuredContainerLogs|bool| *(optional)* EnableStructuredContainerLogs enables multi-container structured logs to allow
|structuredTypeKey|string| *(optional)* StructuredTypeKey specifies the metadata key to be used as name of elasticsearch index
|structuredTypeName|string| *(optional)* StructuredTypeName specifies the name of elasticsearch schema
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
|structuredTypeName|string| *(optional)* StructuredTypeName specifies the name of elasticsearch schema
|structuredTypeName|string| *(optional)* StructuredTypeName specifies the name of the elasticsearch schema

observability/logging/api_reference/logging-5-6-reference.adoc
|nodeSelector|object| *(optional)* Define which Nodes the Pods are scheduled on.
|tolerations|array| *(optional)* Define the tolerations the Pods will accept
|fluentd|object| *(optional)* Fluentd represents the configuration for forwarders of type fluentd.
|logs|object| **(DEPRECATED)** *(optional)* Deprecated. Specification of Log Collection for the cluster
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
|logs|object| **(DEPRECATED)** *(optional)* Deprecated. Specification of Log Collection for the cluster
|logs|object| **(DEPRECATED)** *(optional)* Specification of Log Collection for the cluster

observability/logging/api_reference/logging-5-6-reference.adoc
|buffer|object|
|inFile|object|
|======================

Copy link
Contributor

Choose a reason for hiding this comment

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

No description text for "buffer" or "inFile". Just flagging because it is unusual, I cannot say if this is in error.

observability/logging/api_reference/logging-5-8-reference.adoc
|======================
|Property|Type|Description

|chunkLimitSize|string| *(optional)* ChunkLimitSize represents the maximum size of each chunk. Events will be
Copy link
Contributor

Choose a reason for hiding this comment

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

Truncated sentence

observability/logging/api_reference/logging-5-8-reference.adoc
|Property|Type|Description

|chunkLimitSize|string| *(optional)* ChunkLimitSize represents the maximum size of each chunk. Events will be
|flushInterval|string| *(optional)* FlushInterval represents the time duration to wait between two consecutive flush
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
|flushInterval|string| *(optional)* FlushInterval represents the time duration to wait between two consecutive flush
|flushInterval|string| *(optional)* FlushInterval represents the time duration to wait between two consecutive flushes

observability/logging/api_reference/logging-5-8-reference.adoc

|chunkLimitSize|string| *(optional)* ChunkLimitSize represents the maximum size of each chunk. Events will be
|flushInterval|string| *(optional)* FlushInterval represents the time duration to wait between two consecutive flush
|flushMode|string| *(optional)* FlushMode represents the mode of the flushing thread to write chunks. The mode
Copy link
Contributor

Choose a reason for hiding this comment

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

Truncated sentence

observability/logging/api_reference/logging-5-8-reference.adoc
|flushInterval|string| *(optional)* FlushInterval represents the time duration to wait between two consecutive flush
|flushMode|string| *(optional)* FlushMode represents the mode of the flushing thread to write chunks. The mode
|flushThreadCount|int| *(optional)* FlushThreadCount reprents the number of threads used by the fluentd buffer
|overflowAction|string| *(optional)* OverflowAction represents the action for the fluentd buffer plugin to
Copy link
Contributor

Choose a reason for hiding this comment

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

Truncated sentence

observability/logging/api_reference/logging-5-8-reference.adoc
|overflowAction|string| *(optional)* OverflowAction represents the action for the fluentd buffer plugin to
|retryMaxInterval|string| *(optional)* RetryMaxInterval represents the maximum time interval for exponential backoff
|retryTimeout|string| *(optional)* RetryTimeout represents the maximum time interval to attempt retries before giving up
|retryType|string| *(optional)* RetryType represents the type of retrying flush operations. Flush operations can
Copy link
Contributor

Choose a reason for hiding this comment

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

Truncated sentence

@GroceryBoyJr
Copy link
Contributor

/remove-label peer-review-in-progress
/label peer-review-done
/unassign GroceryBoyJr

@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 labels Apr 29, 2024
@GroceryBoyJr
Copy link
Contributor

Also, be aware, @libander you need to re-create the three previews for this one since the section was moved under "observability".

@openshift-bot
Copy link

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-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 29, 2024
@openshift-bot
Copy link

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-ci openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Aug 28, 2024
@openshift-bot
Copy link

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

@openshift-ci openshift-ci bot closed this Sep 28, 2024
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Sep 28, 2024

@openshift-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/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.

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

Reviewers

1 more reviewer

@GroceryBoyJr GroceryBoyJr GroceryBoyJr left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@anpingli anpingli

Labels

lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. peer-review-done Signifies that the peer review team has reviewed this PR size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@libander @ocpdocs-previewbot @anpingli @GroceryBoyJr @openshift-bot