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

feat(instrumentation): add trace level logging of request CLI-325 #5244

Merged
merged 1 commit into from
May 24, 2024

Conversation

mgyorke
Copy link
Contributor

@mgyorke mgyorke commented May 17, 2024

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

This PR adds logging of the request at trace level.

Where should the reviewer start?

How should this be manually tested?

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

@mgyorke mgyorke marked this pull request as ready for review May 17, 2024 15:06
@mgyorke mgyorke requested a review from a team as a code owner May 17, 2024 15:06
cliv2/internal/proxy/proxy.go Outdated Show resolved Hide resolved
cliv2/internal/proxy/proxy_test.go Outdated Show resolved Hide resolved
cliv2/internal/proxy/proxy_test.go Show resolved Hide resolved
cliv2/pkg/basic_workflows/legacycli.go Outdated Show resolved Hide resolved
@PeterSchafer
Copy link
Contributor

This PR relies on changes on the go-application-framework but there are no changes to the go.mod. This means the changes will never build. please update to gaf link even if it is just a temporary commit hash, so that the CLI build can show issues.

@mgyorke mgyorke force-pushed the feat/trace-level-logging-of-the-user-interaction branch 2 times, most recently from 190b098 to 0cc3cda Compare May 20, 2024 14:13
.circleci/config.yml Outdated Show resolved Hide resolved
@mgyorke mgyorke force-pushed the feat/trace-level-logging-of-the-user-interaction branch 2 times, most recently from 0cc3cda to a328961 Compare May 22, 2024 09:31
@mgyorke mgyorke requested a review from PeterSchafer May 22, 2024 09:37
Copy link
Contributor

@PeterSchafer PeterSchafer left a comment

Choose a reason for hiding this comment

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

The logs now contain additional new lines, see screenshot. This is probably due to different behaviour of the logger functions.

image

@mgyorke mgyorke force-pushed the feat/trace-level-logging-of-the-user-interaction branch 3 times, most recently from 176d595 to 8d9dfe6 Compare May 24, 2024 07:09
@mgyorke mgyorke force-pushed the feat/trace-level-logging-of-the-user-interaction branch from 8d9dfe6 to 9d50e8d Compare May 24, 2024 07:34
@mgyorke mgyorke requested a review from PeterSchafer May 24, 2024 07:52
@PeterSchafer PeterSchafer merged commit 844f1b2 into main May 24, 2024
15 checks passed
@PeterSchafer PeterSchafer deleted the feat/trace-level-logging-of-the-user-interaction branch May 24, 2024 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants