Add the error code in the logs

[steve-chavez]

Problem

Currently the logs show errors (on log-level=error or warn) as:

127.0.0.1 - postgrest_test_anonymous [16/Apr/2024:14:11:52 -0500] "GET /designers?select=x(id) HTTP/1.1" 400 - "" "curl/7.81.0"

When doing:

curl 'localhost:3000/designers?select=x(id)'

{"code":"PGRST200","details":"Searched for a foreign key relationship between 'designers' and 'x' in the schema 'test', but no matches were found.","hint":null,"message":"Could not find a relationship between 'designers' and 'x' in the schema cache"}

But the status code on the log line is not enough to identify the error. Considering that 400 is used for various errors (ref)

Solution

Add the error code next to the status code on the logs:

127.0.0.1 - postgrest_test_anonymous [16/Apr/2024:14:11:52 -0500] "GET /designers?select=x(id) HTTP/1.1" 400 (PGRST200) - "" "curl/7.81.0"

[wolfgangwalther]

This breaks the convention of the "Combined Log Format", that we are using, so far.

To do such things we should change the log format entirely, for example produce JSON logs or so.

[steve-chavez]

Are we really complying to http://justsolve.archiveteam.org/wiki/Combined_Log_Format? Right now we're not adding the "Number of bytes transferred in requested object" field.

To do such things we should change the log format entirely, for example produce JSON logs or so.

I wouldn't be opposed to json logs but that seems like another feature.

Nginx for example allows configuring its plain text log format: https://docs.nginx.com/nginx/admin-guide/monitoring/logging/#setting-up-the-access-log

So maybe we could add a config for this?

[steve-chavez]

Btw, it shouldn't be hard to implement a json logger. We already have all the logic centralized in Logger.hs, some of the required functions are already there too. We would just need to stop using the Logger.middleware.

Maybe we can have a config similar to pg:

log_destination = 'jsonlog' # Valid values are combinations of
# stderr, csvlog, jsonlog, syslog, and
# eventlog, depending on platform.
# csvlog and jsonlog require
# logging_collector to be on.

Like:

log_format = "combined" ## default
# combined-w-error-code
# jsonlog

[steve-chavez]

Maybe OTel will supersede this #3140