Skip to content
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

Resolved the different log output issue for tkn p logs and tkn pr logs. #2235

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Resolved the different log output issue for tkn p logs and tkn pr logs. #2235

wants to merge 2 commits into from

Conversation

Senjuti256
Copy link
Contributor

Changes

Added additional formatting options such as --prefix for tkn p logs, which prefixes each log line with the task name and step name to match the output format of tkn pr logs. This is done to resolve issue #2223 .

Submitter Checklist

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

  • Includes tests (if functionality changed/added)
  • Run the code checkers with make check
  • Regenerate the manpages, docs and go formatting with make generated
  • Commit messages follow commit message best practices

See the contribution guide
for more details.

Release Notes

@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Feb 1, 2024
@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign pradeepitm12 after the PR has been reviewed.
You can assign the PR to them by writing /assign @pradeepitm12 in a comment when ready.

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

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 1, 2024
@tekton-robot
Copy link
Contributor

Hi @Senjuti256. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 1, 2024
@Senjuti256 Senjuti256 changed the title Resolved the different log output issue #2223 for tkn p logs and tkn pr logs. Resolved the different log output issue for tkn p logs and tkn pr logs. Feb 1, 2024
piyush-garg
piyush-garg reviewed Feb 5, 2024
View reviewed changes
pkg/cmd/pipeline/logs.go Outdated
@@ -95,8 +95,10 @@ Show logs for given Pipeline and PipelineRun:
c.Flags().BoolVarP(&opts.Last, "last", "L", false, "show logs for last PipelineRun")
c.Flags().BoolVarP(&opts.AllSteps, "all", "a", false, "show all logs including init steps injected by tekton")
c.Flags().BoolVarP(&opts.Follow, "follow", "f", false, "stream live logs")
c.Flags().BoolVarP(&opts.Timestamps, "timestamps", "t", false, "show logs with timestamp")
c.Flags().BoolVarP(&opts.Timestamps, "timestamps", "", false, "show logs with timestamp")
Copy link
Contributor

Choose a reason for hiding this comment

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

This is breaking change

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should I remove the functionality of filtering out and printing only the mentioned tasks? If not then what flag should I use for it @piyush-garg ?

vinamra28
vinamra28 requested changes Feb 6, 2024
View reviewed changes
pkg/cmd/pipeline/logs.go Outdated
c.Flags().IntVarP(&opts.Limit, "limit", "", 5, "lists number of PipelineRuns")
c.Flags().BoolVarP(&opts.Prefixing, "prefix", "", true, "prefix each log line with the log source (task name and step name)")
c.Flags().StringSliceVarP(&opts.Tasks, "task", "t", []string{}, "show logs for mentioned Tasks only")
Copy link
Member

Choose a reason for hiding this comment

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

why do we need this flag? is this a related change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@vinamra28 Are you talking about the line no. 101 ? I added that in order to ensure that we can filter out and show logs for a specific/required task only. This functionality exists in tkn pr logs . Now that we are formatting the output of tkn p logs to look like tkn pr logs I felt that this functionality should also be there else the logs for both the commands might be different in some cases.

@tekton-robot tekton-robot 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 Feb 6, 2024
@tekton-robot tekton-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 8, 2024
@vdemeester
Copy link
Member

/ok-to-test

@tekton-robot tekton-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 19, 2024
@Senjuti256
Copy link
Contributor Author

Senjuti256 commented Feb 19, 2024 •
edited
Loading

/retest

@piyush-garg
Copy link
Contributor

@Senjuti256 Can you please add some tests for it?

@piyush-garg
Copy link
Contributor

/retest

@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 11, 2024
@tekton-robot tekton-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 19, 2024
@tekton-robot
Copy link
Contributor

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

Test name Commit Details Required Rerun command
pull-tekton-cli-unit-tests 646caca link true /test pull-tekton-cli-unit-tests
pull-tekton-cli-integration-tests 646caca link true /test pull-tekton-cli-integration-tests
pull-tekton-cli-build-tests 646caca link true /test pull-tekton-cli-build-tests

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.

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

@piyush-garg piyush-garg piyush-garg left review comments

@vinamra28 vinamra28 vinamra28 requested changes

@vdemeester vdemeester Awaiting requested review from vdemeester

Assignees
No one assigned
Labels
ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesnt merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Senjuti256 @tekton-robot @vdemeester @piyush-garg @vinamra28