fix: disable auth access logs

[johanneswuerbach]

What this PR does / why we need it:

Currently nginx logs requests twice when external authentication is enabled, which is fairly confusing as the $request and $upstream_addr etc. are the same, but only $bytes_sent and $request_length are 0 and the $status_code might be different.

While this logging could be made conditional, I wonder in which use-case both logs would be expected looking at the fact that the logged information is kind of broken.

The main benefit seems to be that the $status_code of the auth response is visible in the first log line and not in the second, but I wonder whether this justifies the cost of logging every request with all details twice (troubleshooting request details seems more like a job for tracing).

Related #3040

At the moment we use:

controller:
  config:
    ...
    http-snippet: |
      map $uri $loggable {
          volatile;
          "~^\/_external-auth.*" 0;
          default 1;
      }

To disable logs for external auth requests.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• CVE Report (Scanner found CVE and adding report)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation only

Which issue/s this PR fixes

How Has This Been Tested?

Manually.

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I've read the CONTRIBUTION guide
• I have added unit and/or e2e tests to cover my changes.
• All new and existing tests passed.
• Added Release Notes.

Does my pull request need a release note?

Any user-visible or operator-visible change qualifies for a release note. This could be a:

• CLI change
• API change
• UI change
• configuration schema change
• behavioral change
• change in non-functional attributes such as efficiency or availability, availability of a new platform
• a warning about a deprecation
• fix of a previous Known Issue
• fix of a vulnerability (CVE)

No release notes are required for changes to the following:

• Tests
• Build infrastructure
• Fixes for unreleased bugs

For more tips on writing good release notes, check out the Release Notes Handbook

Fixed: Requests with external auth enabled are only logged once.

[k8s-ci-robot]

@johanneswuerbach: This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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]

Welcome @johanneswuerbach!

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]

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

[johanneswuerbach]

/assign @rikatz

[rikatz]

/ok-to-test

[rikatz]

/lgtm
/approve
Thanks

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: johanneswuerbach, rikatz

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:

• OWNERS [rikatz]

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

[gevaeshcoli-microsoft]

Hi johanneswuerbach,

In case we do want to log this access logs - how can we do it?(is there a configuration that we can use?)

Thanks.

[johanneswuerbach]

Could you elaborate which details you want to log in your case?

[gevaeshcoli-microsoft]

If I understand you correctly - this PR will eliminate the extra auth calls access logs.

I want to understand if:

1. can I use another access log property of the original access log to understand what happened in the auth request flow?(performance/status)
2. can I set a config property to keep the current behavior?

The use case is tracking the auth flow - performance and status.

[johanneswuerbach]

This is currently not configurable, but it might be possible to includes those details in your logs using a snippet:

nginx.ingress.kubernetes.io/configuration-snippet: |
  auth_request_set $auth_status $upstream_status;
  auth_request_set $auth_response_time $upstream_response_time;

Afterwards you should be able to include $auth_status and $auth_response_time in your log format.

[marcelocyreno]

@gevaeshcoli-microsoft, @rikatz : PTAL #10335