Supersede log-format-escape-json with log-format-params

[mattoberle]

Background

The ConfigMap currently supports a boolean option named log-format-escape-json.

• "false" sets log_format escape=default
• "true" sets log_format escape=json

Nginx's log_format directive offers a third option, none, which is not represented by the boolean config value.

Proposal

Introduce a new ConfigMap option to support all available parameters:

• log-format-params

The access_log directive parameters are configurable via access-log-params which was introduced in #3702.
Using a similar option here is more consistent than the parameter-specific boolean and removes the need to create additional ConfigMap keys if additional log_format parameters are introduced in the future.

Example Use Case

Let's say I want to construct a lua plugin to write JSON log lines that are more complex than flat key/value pairs.
eg.

-- Where log-format-upstream="$log_record"
_M.log()
    ngx.var.log_record = cjson.encode({
        status = ngx.var.status,
        request_query = ngx.decode_args(ngx.var.request_query)
        -- etc
     })
end

With escape=json:

{\"status\":\"200\",\"request_query\":{\"foo\":\"bar\"}}

With escape=default:

{\x22status\x22:\x22request_query\x22:{\x22foo\x22:\x22bar\x22}}

With escape=none:

{"status":"200","request_query":{"foo":"bar"}}

[k8s-ci-robot]

@mattoberle: 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.

[mattoberle]

I wanted to open this issue for discussion to gauge interest before putting together a PR.
If this is a change individuals are receptive to there is an obvious conflict between log-format-params and log-format-escape-json.
Is there precedent for this type of conflict?

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue or PR with /reopen
• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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.