Summary: | REST API: Log request and response content | ||
---|---|---|---|
Product: | Koha | Reporter: | Lari Taskula <lari.taskula> |
Component: | REST API | Assignee: | Lari Taskula <lari.taskula> |
Status: | BLOCKED --- | QA Contact: | |
Severity: | enhancement | ||
Priority: | P5 - low | CC: | johanna.raisa, josef.moravec |
Version: | unspecified | ||
Hardware: | All | ||
OS: | All | ||
Change sponsored?: | --- | Patch complexity: | --- |
Documentation contact: | Documentation submission: | ||
Text to go in the release notes: | Version(s) released in: | ||
Circulation function: | |||
Bug Depends on: | 18206 | ||
Bug Blocks: | |||
Attachments: |
Bug 19652: Debug-level logging for response JSON
Bug 19652: Debug-level logging for response JSON Bug 19652: REST API: Log request and response content Bug 19652: REST API: Log request and response content Bug 19652: REST API: Log request and response content |
Description
Lari Taskula
2017-11-20 11:59:22 UTC
Created attachment 69225 [details] [review] Bug 19652: Debug-level logging for response JSON This patch adds debug-level logging for response JSON. This is useful for viewing responses via REST API log file. To test: 1. prove t/db_dependent/api/v1.t 2. Configure log4perl configuration file for REST API and set log level to DEBUG 3. Make any request to existing REST API endpoint 4. Observe response JSON in your log file Created attachment 69233 [details] [review] Bug 19652: Debug-level logging for response JSON This patch adds debug-level logging for response JSON. This is useful for viewing responses via REST API log file. To test: 1. prove t/db_dependent/api/v1.t 2. Configure log4perl configuration file for REST API and set log level to DEBUG 3. Make any request to existing REST API endpoint 4. Observe response JSON in your log file Test plan step 2 example conf (in your log4perl.conf file): log4perl.logger.rest = DEBUG, REST log4perl.appender.REST=Log::Log4perl::Appender::File log4perl.appender.REST.filename=/home/koha/koha-dev/var/log/rest.log log4perl.appender.REST.create_at_logtime=true log4perl.appender.REST.syswrite=true log4perl.appender.REST.recreate=true log4perl.appender.REST.mode=append log4perl.appender.REST.layout=PatternLayout log4perl.appender.REST.layout.ConversionPattern=[%d] [%p] %m %l %n log4perl.appender.REST.utf8=1 Created attachment 69265 [details] [review] Bug 19652: REST API: Log request and response content This patch adds request and response logger to REST API. It is useful for viewing parameters that came within the request, and the content that is about to be rendered back. To test: 1. prove t/db_dependent/api/v1.t 2. Configure log4perl configuration file for REST API and set log level to DEBUG 3. Make any request to existing REST API endpoint 4. Observe response JSON in your log file Example configuration: log4perl.logger.rest = DEBUG, REST log4perl.appender.REST=Log::Log4perl::Appender::File log4perl.appender.REST.filename=/home/koha/koha-dev/var/log/rest.log log4perl.appender.REST.create_at_logtime=true log4perl.appender.REST.syswrite=true log4perl.appender.REST.recreate=true log4perl.appender.REST.mode=append log4perl.appender.REST.layout=PatternLayout log4perl.appender.REST.layout.ConversionPattern=[%d] [%p] %m %l %n log4perl.appender.REST.utf8=1 Created attachment 69267 [details] [review] Bug 19652: REST API: Log request and response content This patch adds request and response logger to REST API. It is useful for viewing parameters that came within the request, and the content that is about to be rendered back. To test: 1. prove t/db_dependent/api/v1.t 2. Configure log4perl configuration file for REST API and set log level to DEBUG 3. Make any request to existing REST API endpoint 4. Observe response JSON in your log file Example configuration: log4perl.logger.rest = DEBUG, REST log4perl.appender.REST=Log::Log4perl::Appender::File log4perl.appender.REST.filename=/home/koha/koha-dev/var/log/rest.log log4perl.appender.REST.create_at_logtime=true log4perl.appender.REST.syswrite=true log4perl.appender.REST.recreate=true log4perl.appender.REST.mode=append log4perl.appender.REST.layout=PatternLayout log4perl.appender.REST.layout.ConversionPattern=[%d] [%p] %m %l %n log4perl.appender.REST.utf8=1 Created attachment 85718 [details] [review] Bug 19652: REST API: Log request and response content This patch adds request and response logger to REST API. It is useful for viewing parameters that came within the request, and the content that is about to be rendered back. To test: 1. prove t/db_dependent/api/v1.t 2. Configure log4perl configuration file for REST API and set log level to DEBUG 3. Make any request to existing REST API endpoint 4. Observe response JSON in your log file Example configuration: log4perl.logger.rest = DEBUG, REST log4perl.appender.REST=Log::Log4perl::Appender::File log4perl.appender.REST.filename=/home/koha/koha-dev/var/log/rest.log log4perl.appender.REST.create_at_logtime=true log4perl.appender.REST.syswrite=true log4perl.appender.REST.recreate=true log4perl.appender.REST.mode=append log4perl.appender.REST.layout=PatternLayout log4perl.appender.REST.layout.ConversionPattern=[%d] [%p] %m %l %n log4perl.appender.REST.utf8=1 Just rebased on top of dependency tree This patch doesn't apply. Tested on master. Here is the fail message. Applying: Bug 19652: REST API: Log request and response content error: sha1 information is lacking or useless (Koha/REST/V1.pm). error: could not build fake ancestor Patch failed at 0001 Bug 19652: REST API: Log request and response content Missed the depedency, will try again. This patch fails to the first point. # Subtest: default_exception_handling() tests 1..5 # Subtest: Mojo::Exception 1..4 ok 1 - GET /default_exception_handling/mojo ok 2 - 500 Internal Server Error ok 3 - exact match for JSON Pointer "/error" # Looks like you planned 4 tests but ran 3. not ok 1 - Mojo::Exception # Failed test 'Mojo::Exception' Tried to continue anyhow but the rest.log file wasn't created. Not sure if the logging suppose to write individual files, seemed that all warnings went to koha-error_log file. |