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

Enhancement : add remote_addr in TCP access log #4694

Merged

Conversation

panpan0000
Copy link
Contributor

@panpan0000 panpan0000 commented Oct 18, 2019

What this PR does / why we need it:

because source IP is essential for access log , not only for http logs ,but also for TCP logs.

original:
[18/Oct/2019:00:47:53 +0000] TCP 200 4333 81 0.002
new:
[10.6.***.202] [18/Oct/2019:01:05:15 +0000] TCP 200 4333 81 0.002

Which issue this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close that issue when PR gets merged): fixes #
No GH issue so far , if it's required, I will fire one.

Special notes for your reviewer:

original:
[18/Oct/2019:00:47:53 +0000]  TCP 200 4333 81 0.002
new:
[10.6.124.202]  [18/Oct/2019:01:05:15 +0000]  TCP 200 4333  81 0.002
@k8s-ci-robot
Copy link
Contributor

Welcome @panpan0000!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


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.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Oct 18, 2019
@k8s-ci-robot
Copy link
Contributor

Hi @panpan0000. Thanks for your PR.

I'm waiting for a kubernetes 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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 18, 2019
@panpan0000
Copy link
Contributor Author

CLA is signed . @k8s-ci-robot

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 18, 2019
@panpan0000
Copy link
Contributor Author

/assign @bowei

@aledbf
Copy link
Member

aledbf commented Oct 19, 2019

/ok-to-test

@k8s-ci-robot k8s-ci-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 Oct 19, 2019
@aledbf
Copy link
Member

aledbf commented Oct 19, 2019

Please update the documentation about the format too https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#log-format-stream

@panpan0000 panpan0000 changed the title Enhancement : add remote_addr in layer 4 access log Enhancement : add remote_addr in TCP access log Oct 21, 2019
@codecov-io
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (master@a6815c3). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #4694   +/-   ##
=========================================
  Coverage          ?   58.68%           
=========================================
  Files             ?       88           
  Lines             ?     6762           
  Branches          ?        0           
=========================================
  Hits              ?     3968           
  Misses            ?     2357           
  Partials          ?      437

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a6815c3...ee24bf1. Read the comment docs.

@aledbf
Copy link
Member

aledbf commented Oct 21, 2019

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 21, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, panpan0000

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 21, 2019
@panpan0000
Copy link
Contributor Author

Thank you for your reminder, @aledbf .

(1) I've add this change in configmap doc, in my second commit : ee24bf1

(2) regarding the Live doc (https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#log-format-stream), the original live doc is only about "HTTP log-format". The "TCP log-format" is not mentioned although, so I cannot fit my change into that doc :-(

@k8s-ci-robot k8s-ci-robot merged commit bd4b620 into kubernetes:master Oct 21, 2019
@panpan0000 panpan0000 deleted the add-remote-addr-into-l4-logs branch October 22, 2019 02:54
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants