Repository navigation
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3884 +/- ##
==========================================
+ Coverage 26.33% 27.75% +1.41%
==========================================
Files 465 477 +12
Lines 24951 25679 +728
==========================================
+ Hits 6572 7128 +556
- Misses 17661 17822 +161
- Partials 718 729 +11
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
/retest |
2 similar comments
|
/retest |
|
/retest |
|
/lgtm |
|
New changes are detected. LGTM label has been removed. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
29dd4dd to
d7f756f
Compare
|
Tide was flagging this as unmergeable because the branch had a merge commit from syncing upstream/main, which a clean rebase can't replay past a later commit ( |
|
/assign @jkhelil Rebased and green — let me know if anything else would help move this toward approval. |
khrm
left a comment
There was a problem hiding this comment.
Existing behaviour is correct. Watcher forwarder is not required, you can have a different forwarder like vector.
|
Fair point — if logs already land in storage some other way (an external forwarder, or a LokiStack-based viewer), pushing through the Watcher too would be redundant, and leaving watcher.logs_api off by default there is correct. The conflict is with #2600 itself and the PVC example in TektonResult.md: those only set the top-level logs_api with nothing else configured to get logs in, so the feature silently never stores anything. Would you rather I drop this default and instead fix the docs to have users set watcher.logs_api explicitly, so we don't risk flipping behavior on upgrade for anyone currently relying on the existing default (e.g. LokiStack users)? |
khrm
left a comment
There was a problem hiding this comment.
Yes, maybe update docs. Also, watcher forwarding logs would be removed in future. That point can also be added.
… logs Setting the top-level logs_api only enables the logs API on the Results API server. The watcher forwards TaskRun and PipelineRun logs to it only when its own logs_api flag is set, which defaults to false, so the documented File/PVC example stored no logs. Add watcher.logs_api to the TektonResult and TektonConfig examples, explain when to set it and when another forwarder makes it unnecessary, and note that log forwarding by the watcher is expected to be removed in a future release. Report: tektoncd#2600 Signed-off-by: Pujitha Paladugu <[email protected]>
d7f756f to
688febc
Compare
|
@khrm Done in 688febc, which replaces the original commit. The
Title and description are updated to match. |
Changes
Documents that setting the top-level
logs_api: trueon aTektonResult(orresult.logs_apionTektonConfig) only enables the logs API on the Results API server. Thetekton-results-watcherforwards TaskRun and PipelineRun logs to it only when its own-logs_apiflag is set throughwatcher.logs_api, which defaults tofalse. With only the top-level field set, as in the File/PVC example, no logs are stored (#2600).Per review, the existing default is kept: the watcher is not the only possible forwarder (Vector or Fluentd with LokiStack, for example), so this PR changes docs only:
docs/TektonResult.md: a note under the spec example explains the two settings, whenwatcher.logs_apican stay unset, and that log forwarding by the watcher is expected to be removed in a future release. The example setswatcher.logs_api: truewith a comment pointing to the note.docs/TektonConfig.md: theresult.watcherexample setslogs_api: truewith the same comment, and the watcher table'slogs_apirow says the same in short.An earlier revision of this PR defaulted
watcher.logs_apifrom the top-levellogs_apiinResult.setDefaults(); that was dropped after review.Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
make test lintbefore submitting a PR (n/a: docs only)See the contribution guide for more details.
Release Notes
AI assistance: this change was drafted with Claude Code.
Fixes #2600