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(http-log): Add docs for logged header allow list #5984

Conversation

ItsKaleb
Copy link
Contributor

@ItsKaleb ItsKaleb commented Aug 21, 2023

This PR adds the supporting documentation for PR #11427. Functional changes are to implement an allow list for which request/response headers should be included in log entries.

Description

Add supporting documentation for
Kong/kong#11427

Testing instructions

Netlify link:

Checklist

  • Review label added
  • PR pointed to correct branch (main for immediate publishing, or a release branch: e.g. release/gateway-3.2, release/deck-1.17)

This PR adds the supporting documentation for PR #11427. Functional changes are to implement an allow list for which request/response headers should be included in log entries.
@ItsKaleb ItsKaleb requested a review from a team as a code owner August 21, 2023 03:02
@netlify
Copy link

netlify bot commented Aug 21, 2023

Deploy Preview for kongdocs failed.

Name Link
🔨 Latest commit d419d1d
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/64e40c21d0c51500075e0792

@acgoldsmith acgoldsmith added the review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? label Aug 22, 2023
@acgoldsmith acgoldsmith added this to the Gateway 3.5 milestone Aug 22, 2023
@acgoldsmith
Copy link
Contributor

Hi @ItsKaleb , thanks for this PR. Could you please point to release/gateway-3.5 rather than main? Thanks.

@ItsKaleb
Copy link
Contributor Author

Thanks @acgoldsmith, will do that, yep.

@ItsKaleb ItsKaleb changed the base branch from main to release/gateway-3.5 August 23, 2023 05:19
@ItsKaleb
Copy link
Contributor Author

Hey @acgoldsmith, Vale seemed to be flagging some of the config field names as potential spelling errors. I've never used Vale before, is there a way to ignore those checks? I've also just updated the PR to address some of the legit findings it reported.
Thanks

@cloudjumpercat cloudjumpercat added blocked:kong Issues/PRs waiting on Kong PRs to merge before it can be solved do not merge Issues/ PRs whose changes should not be merged at this time labels Aug 29, 2023
@cloudjumpercat
Copy link
Contributor

@ItsKaleb Thanks for fixing some of those Vale errors! I'm happy to help with the others.

I think maybe some extra commits were pulled in when the base branch was changed to release/gateway-3.5, so I think the easiest way to fix it would be for me to create a new PR for you and I can cherry pick the commits you specifically made. I think the only ones with doc changes you made were 8ca48b0 and 271cce1, correct? The rest were either rebases/updating the branch or commits accidentally pulled in, I think?

Then I can help by getting those config names added to our Vale ignore file so Vale ignores them.

@ItsKaleb
Copy link
Contributor Author

Ah yes, thanks @cloudjumpercat
My apologies, I'm more familiar with Bitbucket than Github, so not surprised that I messed that up.
I'll do as you suggested and raise a new PR, should be able to sort that soon.

@cloudjumpercat
Copy link
Contributor

@ItsKaleb No worries! If you'd like, I can always do the cherry pick to the new PR as well.

@ItsKaleb
Copy link
Contributor Author

ItsKaleb commented Sep 6, 2023

Just to provide an update, I'm currently working through some hiccups with the feature branch in the main repo. Once things are sorted there, I'll revisit this PR and get the docs for the new feature fixed up.

@Guaris Guaris self-assigned this Nov 1, 2023
@Guaris Guaris removed this from the Gateway 3.5 milestone Nov 1, 2023
@Guaris
Copy link
Contributor

Guaris commented Nov 1, 2023

I've removed the Gateway 3.5 milestone the corresponding PR does not look like it will be added to the 3.5 release
Kong/kong#11427

If I am incorrect please re-add the milestone and tag me.

@Guaris Guaris removed their assignment Nov 1, 2023
@mheap mheap deleted the branch Kong:release/gateway-3.5 January 23, 2024 09:11
@mheap mheap closed this Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked:kong Issues/PRs waiting on Kong PRs to merge before it can be solved do not merge Issues/ PRs whose changes should not be merged at this time review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants