Structured logging about oauth2-proxy HOT 8 CLOSED

• { "client":"", "method":"", "username":"", "timestamp":"", "host":"", "upstream":"", "url":, "protocol":"", "user_agent":, "status":"", "length":"", "response-time":"", }

maybe the problem is the lack of space between the quotes #

from oauth2-proxy.

@AlexSins Unfortunately, it's not an input problem. The code itself isn't written to support JSON logging because there's no way to tell it to do the required escaping (e.g. double quotes). The problem is tracked here: #1057

from oauth2-proxy.

Logging has recently been improved with logging formats that will allow users to define their own structure, closing this

from oauth2-proxy.

I don't think this should be closed. json logging seems to be pretty standard these days and should be supported by oauth2-proxy

from oauth2-proxy.

We solved it in a hacky way for now, but using this logging format. Maybe this helps somebody, as long as this is not offically supported.

auth_logging_format = '{"client": "{{.Client}}", "username": "{{.Username}}", "timestamp": "{{.Timestamp}}", "status": {{.Status}}, "message": "{{.Message}}"}'
request_logging_format = '{"client": "{{.Client}}", "username": "{{.Username}}", "timestamp": "{{.Timestamp}}", "host": "{{.Host}}", "request_method": "{{.RequestMethod}}", "upstream": "{{.Upstream}}", "request_uri": {{.RequestURI}}, "protocol": "{{.Protocol}}", "user_agent": {{.UserAgent}}, "status_code": {{.StatusCode}}, "response_size": {{.ResponseSize}}, "request_duration": {{.RequestDuration}}}'
standard_logging_format = '{"timestamp": "{{.Timestamp}}", "file": "{{.File}}", "message": "{{.Message}}"}'

from oauth2-proxy.

One of the primary goals of introducing customisable logging formats was to allow people to use structured logging in exactly the way you have done in your comment above.

I can't recall if we have an example of a JSON logging template in the docs, but if not, perhaps we could update it to I could your example

from oauth2-proxy.

@max-wittig Thank you for this example. I'm trying to figure this out right now. The format you provide looks good, but I deploy oauth2-proxy with the helm chart and helm is choking on a value like that... I think because the format string is using the same variable syntax as helm. Have you (or anyone else, @JoelSpeed) configured structured log formatting using the Helm chart?

from oauth2-proxy.

For anyone coming along in the future, I actually figured out how to set this up in the Helm chart. Here's an example of what I'm doing in my values.yaml:

extraArgs:
  request-logging-format: >-
    {
    "client":"{{.Client}}",
    "method":"{{.RequestMethod}}",
    "username":"{{.Username}}",
    "timestamp":"{{.Timestamp}}",
    "host":"{{.Host}}",
    "upstream":"{{.Upstream}}",
    "url":{{.RequestURI}},
    "protocol":"{{.Protocol}}",
    "user_agent":{{.UserAgent}},
    "status":"{{.StatusCode}}",
    "length":"{{.ResponseSize}}",
    "response-time":"{{.RequestDuration}}",
    }

from oauth2-proxy.