add instructions for handling large log files

[avinal]

Changes

• log size is limited by the LOGS_BUFFER_SIZE and it is not logical to increase it too high
• Reaching this limit causes the response to be broken in chunks where each chunk is a valid JSON/proto response but the complete response is no longer a valid JSON/proto
• This must be handled from the client size by parsing each chunk and then combining the data field to retrieve the complete log
• Added example for handling such case using bash commands

Signed-off-by: Avinal Kumar avinal@redhat.com

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you review them:

• [x] Has Docs included if any changes are user facing
• [ ] Has Tests included if any functionality added or changed
• [x] Tested your changes locally (if this is a code change)
• [x] Follows the commit message standard
• [x] Meets the Tekton contributor standards (including functionality, content, code)
• [x] Has a kind label. You can add a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
• [x] Release notes block below has been updated with any user-facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
• [ ] Release notes contain the string "action required" if the change requires additional action from users switching to the new release

Release Notes

none

[avinal]

/kind documentation /ok-to-test

[avinal]

cc: @khrm @enarha @sayan-biswas

[tekton-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: khrm

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/tektoncd/results/blob/main/OWNERS)~~ [khrm] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

[adambkaplan]

/lgtm

This suggests that we need a better mechanism for serving large logs as a stream of text. Requiring all of the data to be streamed before base64 decoding will not scale to mutli-gigabyte log files.