From: Pieter Lexis Date: Thu, 14 Feb 2019 10:46:38 +0000 (+0100) Subject: Update webserver-loglevel docs X-Git-Tag: dnsdist-1.4.0-alpha1~39^2~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a0badc0b52cbcc1e2a0af82a0501a86f59fc3b27;p=thirdparty%2Fpdns.git Update webserver-loglevel docs --- diff --git a/docs/settings.rst b/docs/settings.rst index 43b07de246..a893099041 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -1622,30 +1622,30 @@ Webserver/API access is only allowed from these subnets. The amount of logging the webserver must do. "none" means no useful webserver information will be logged. When set to "normal", the webserver will log a line per request that should be familiar:: - [webserver] 127.0.0.1:55376 "GET /api/v1/servers/localhost/bla HTTP/1.1" 404 196 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e 127.0.0.1:55376 "GET /api/v1/servers/localhost/bla HTTP/1.1" 404 196 When set to "detailed", all information about the request and response are logged:: - [webserver] Request Details: - [webserver] Headers: - [webserver] accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 - [webserver] accept-encoding: gzip, deflate - [webserver] accept-language: en-US,en;q=0.5 - [webserver] connection: keep-alive - [webserver] dnt: 1 - [webserver] host: 127.0.0.1:8081 - [webserver] upgrade-insecure-requests: 1 - [webserver] user-agent: Mozilla/5.0 (X11; Linux x86_64; rv:64.0) Gecko/20100101 Firefox/64.0 - [webserver] No body - [webserver] Response details: - [webserver] Headers: - [webserver] Connection: close - [webserver] Content-Length: 49 - [webserver] Content-Type: text/html; charset=utf-8 - [webserver] Server: PowerDNS/0.0.15896.0.gaba8bab3ab - [webserver] Full body: - [webserver] Not Found

Not Found

- [webserver] 127.0.0.1:55376 "GET /api/v1/servers/localhost/bla HTTP/1.1" 404 196 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Request Details: + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Headers: + [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept-encoding: gzip, deflate + [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept-language: en-US,en;q=0.5 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e connection: keep-alive + [webserver] e235780e-a5cf-415e-9326-9d33383e739e dnt: 1 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e host: 127.0.0.1:8081 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e upgrade-insecure-requests: 1 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e user-agent: Mozilla/5.0 (X11; Linux x86_64; rv:64.0) Gecko/20100101 Firefox/64.0 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e No body + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Response details: + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Headers: + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Connection: close + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Content-Length: 49 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Content-Type: text/html; charset=utf-8 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Server: PowerDNS/0.0.15896.0.gaba8bab3ab + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Full body: + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Not Found

Not Found

+ [webserver] e235780e-a5cf-415e-9326-9d33383e739e 127.0.0.1:55376 "GET /api/v1/servers/localhost/bla HTTP/1.1" 404 196 The value between the hooks is a UUID that is generated for each request. This can be used to find all lines related to a single request. diff --git a/pdns/recursordist/docs/settings.rst b/pdns/recursordist/docs/settings.rst index 5d44334fdb..2e4503ba97 100644 --- a/pdns/recursordist/docs/settings.rst +++ b/pdns/recursordist/docs/settings.rst @@ -1512,6 +1512,47 @@ IP address for the webserver to listen on. These subnets are allowed to access the webserver. +.. _setting-webserver-loglevel: + +``webserver-loglevel`` +---------------------- +.. versionadded:: 4.2.0 + +- String, one of "none", "normal", "detailed" + +The amount of logging the webserver must do. "none" means no useful webserver information will be logged. +When set to "normal", the webserver will log a line per request that should be familiar:: + + [webserver] e235780e-a5cf-415e-9326-9d33383e739e 127.0.0.1:55376 "GET /api/v1/servers/localhost/bla HTTP/1.1" 404 196 + +When set to "detailed", all information about the request and response are logged:: + + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Request Details: + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Headers: + [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept-encoding: gzip, deflate + [webserver] e235780e-a5cf-415e-9326-9d33383e739e accept-language: en-US,en;q=0.5 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e connection: keep-alive + [webserver] e235780e-a5cf-415e-9326-9d33383e739e dnt: 1 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e host: 127.0.0.1:8081 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e upgrade-insecure-requests: 1 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e user-agent: Mozilla/5.0 (X11; Linux x86_64; rv:64.0) Gecko/20100101 Firefox/64.0 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e No body + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Response details: + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Headers: + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Connection: close + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Content-Length: 49 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Content-Type: text/html; charset=utf-8 + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Server: PowerDNS/0.0.15896.0.gaba8bab3ab + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Full body: + [webserver] e235780e-a5cf-415e-9326-9d33383e739e Not Found

Not Found

+ [webserver] e235780e-a5cf-415e-9326-9d33383e739e 127.0.0.1:55376 "GET /api/v1/servers/localhost/bla HTTP/1.1" 404 196 + +The value between the hooks is a UUID that is generated for each request. This can be used to find all lines related to a single request. + +.. note:: + The webserver logs these line on the NOTICE level. The :ref:`settings-loglevel` seting must be 5 or higher for these lines to end up in the log. + .. _setting-webserver-password: ``webserver-password``