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.

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

Send start and completion time to external logs proxy #2909

Merged
merged 1 commit into from
May 10, 2023

Conversation

AverageMarcus
Copy link
Contributor

Changes

Fixes #2908

Include the startTime and completionTime of the TaskRun when calling out to the external logs proxy so that queries against the long-term log storage can be optimised to search a targeted timeframe if possible.

These are included as query parameters to allow for backwards-compatibility with existing route handling logic that might be being used.

/kind feature

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Docs included if any changes are user facing
    • No existing docs for external-logs aside from the walkthrough. This change doesn't cause a change to those docs.
  • Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (new features, significant UI changes, API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Include the TaskRun's `startTime` and `completionTime` as query parameters when making requests to the external-logs proxy.

@tekton-robot tekton-robot added kind/feature Categorizes issue or PR as related to a new feature. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 9, 2023
@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 May 9, 2023
@tekton-robot
Copy link
Contributor

Hi @AverageMarcus. 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.

@AlanGreene AlanGreene requested review from AlanGreene and removed request for LyndseyBu May 9, 2023 18:51
@AlanGreene
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 May 9, 2023
Copy link
Member

@AlanGreene AlanGreene left a comment

Choose a reason for hiding this comment

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

Hi @AverageMarcus, thanks for the contribution (including tests!). Overall this approach looks good, should be backwards compatible, and could be useful to other users, so it makes sense to include it 👍

I've made a few small suggestions below, let me know if you have any questions.

src/api/index.js Outdated Show resolved Hide resolved
src/api/index.js Outdated Show resolved Hide resolved
src/utils/index.js Show resolved Hide resolved
Include the TaskRuns start time and completion time as properties sent to the external logs proxy to allow for more fine-tuned queries to be run against a long-term log store.

Signed-off-by: Marcus Noble <github@marcusnoble.co.uk>
@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 9, 2023
Copy link
Member

@AlanGreene AlanGreene left a comment

Choose a reason for hiding this comment

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

Thanks Marcus
/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 10, 2023
@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: AlanGreene

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:

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 10, 2023
@tekton-robot tekton-robot merged commit 97b1549 into tektoncd:main May 10, 2023
@AverageMarcus AverageMarcus deleted the external-logs-timeframe branch May 10, 2023 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pass timeframe to external-logs service
3 participants