[Bug 32716] New: update NGINX config examples
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Bug ID: 32716 Summary: update NGINX config examples Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: minor Priority: P5 - low Component: Architecture, internals, and plumbing Assignee: koha-bugs@lists.koha-community.org Reporter: gmcharlt@gmail.com QA Contact: testopia@bugs.koha-community.org We recently encountered a situation with a Starman --> Apache --> NGINX setup where responses from /api/v1/patrons (particularly when doing pagination) could fail with an NGINX error message like this: upstream sent too big header while reading response header from upstream We determined that on the proxy server in question, the default NGINX proxy_buffer_size value of 4096 (the PAGESIZE on that server) was a bit too small for the Link header returned by the API response. Consequently, example NGINX configs in the code and the wiki should include the following: proxy_buffer_size 8k; This is related to bug 31104, but its fix of splitting up the Link headers won't be sufficient, as NGINX will drop the response if the total size of the headers is greater than proxy_buffer_size. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Galen Charlton <gmcharlt@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|update NGINX config |update NGINX config |examples |examples to increase | |proxy_buffer_size -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 --- Comment #1 from Galen Charlton <gmcharlt@gmail.com> --- Created attachment 145633 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=145633&action=edit Bug 32716: larger proxy_buffer_size in NGINX example config This patch updates the example NGINX config to increase the proxy_buffer_size to 8k. The default value of 4k (on some platforms) has empirically been shown to be a bit too small for the Link headers emitted by the REST API when pagination is requested. To test ------- [1] Set up a Koha system with NGINX as a reverse proxy in front of it (either in front of Apache or in front of of Starman). [2] Perform a patron search that returns at least two pages of results and navigate to the second page. [3] Note that the navigation can fail with a 502 HTTP error and an "upstream sent too big header while reading response header from upstream" error in the NGINX log. The problem is most likely when the pagesize of the server running NGINX is 4096 bytes. [4] Update the NGINX configuration per this patch and restart NGINX. [5] This time, repeating step 2 should work. Signed-off-by: Galen Charlton <gmc@equinoxOLI.org> -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Galen Charlton <gmcharlt@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Galen Charlton <gmcharlt@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Text to go in the| |Set proxy_buffer_size in release notes| |the example NGINX | |configuration to reduce | |chances that REST API | |responses that use | |pagination get dropped by | |NGINX -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Galen Charlton <gmcharlt@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch complexity|--- |Trivial patch Change sponsored?|--- |Unsponsored -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Galen Charlton <gmcharlt@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #145633|0 |1 is obsolete| | --- Comment #2 from Galen Charlton <gmcharlt@gmail.com> --- Created attachment 145634 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=145634&action=edit Bug 32716: larger proxy_buffer_size in NGINX example config This patch updates the example NGINX config to increase the proxy_buffer_size to 8k. The default value of 4k (on some platforms) has empirically been shown to be a bit too small for the Link headers emitted by the REST API when pagination is requested. To test ------- [1] Set up a Koha system with NGINX as a reverse proxy in front of it (either in front of Apache or in front of of Starman). [2] Perform a patron search that returns at least two pages of results and navigate to the second page. [3] Note that the navigation can fail with a 502 HTTP error and an "upstream sent too big header while reading response header from upstream" error in the NGINX log. The problem is most likely when the pagesize of the server running NGINX is 4096 bytes. [4] Update the NGINX configuration per this patch and restart NGINX. [5] This time, repeating step 2 should work. Signed-off-by: Galen Charlton <gmc@equinoxOLI.org> -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Galen Charlton <gmcharlt@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #145634|0 |1 is obsolete| | --- Comment #3 from Galen Charlton <gmcharlt@gmail.com> --- Created attachment 145635 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=145635&action=edit Bug 32716: larger proxy_buffer_size in NGINX example config This patch updates the example NGINX config to increase the proxy_buffer_size to 16k. The default value of 4k (on some platforms) has empirically been shown to be a bit too small for the Link headers emitted by the REST API when pagination is requested. To test ------- [1] Set up a Koha system with NGINX as a reverse proxy in front of it (either in front of Apache or in front of of Starman). [2] Perform a patron search that returns at least two pages of results and navigate to the second page. [3] Note that the navigation can fail with a 502 HTTP error and an "upstream sent too big header while reading response header from upstream" error in the NGINX log. The problem is most likely when the pagesize of the server running NGINX is 4096 bytes. [4] Update the NGINX configuration per this patch and restart NGINX. [5] This time, repeating step 2 should work. Signed-off-by: Galen Charlton <gmc@equinoxOLI.org> -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Brendan Gallagher <brendan@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #145635|0 |1 is obsolete| | --- Comment #4 from Brendan Gallagher <brendan@bywatersolutions.com> --- Created attachment 148911 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=148911&action=edit Bug 32716: larger proxy_buffer_size in NGINX example config This patch updates the example NGINX config to increase the proxy_buffer_size to 16k. The default value of 4k (on some platforms) has empirically been shown to be a bit too small for the Link headers emitted by the REST API when pagination is requested. To test ------- [1] Set up a Koha system with NGINX as a reverse proxy in front of it (either in front of Apache or in front of of Starman). [2] Perform a patron search that returns at least two pages of results and navigate to the second page. [3] Note that the navigation can fail with a 502 HTTP error and an "upstream sent too big header while reading response header from upstream" error in the NGINX log. The problem is most likely when the pagesize of the server running NGINX is 4096 bytes. [4] Update the NGINX configuration per this patch and restart NGINX. [5] This time, repeating step 2 should work. Signed-off-by: Galen Charlton <gmc@equinoxOLI.org> Signed-off-by: Brendan Gallagher <brendan@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Brendan Gallagher <brendan@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |brendan@bywatersolutions.co | |m Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |gmc@esilibrary.com |ity.org | -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #148911|0 |1 is obsolete| | --- Comment #5 from Marcel de Rooy <m.de.rooy@rijksmuseum.nl> --- Created attachment 149641 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=149641&action=edit Bug 32716: larger proxy_buffer_size in NGINX example config This patch updates the example NGINX config to increase the proxy_buffer_size to 16k. The default value of 4k (on some platforms) has empirically been shown to be a bit too small for the Link headers emitted by the REST API when pagination is requested. To test ------- [1] Set up a Koha system with NGINX as a reverse proxy in front of it (either in front of Apache or in front of of Starman). [2] Perform a patron search that returns at least two pages of results and navigate to the second page. [3] Note that the navigation can fail with a 502 HTTP error and an "upstream sent too big header while reading response header from upstream" error in the NGINX log. The problem is most likely when the pagesize of the server running NGINX is 4096 bytes. [4] Update the NGINX configuration per this patch and restart NGINX. [5] This time, repeating step 2 should work. Signed-off-by: Galen Charlton <gmc@equinoxOLI.org> Signed-off-by: Brendan Gallagher <brendan@bywatersolutions.com> Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |m.de.rooy@rijksmuseum.nl QA Contact|testopia@bugs.koha-communit |m.de.rooy@rijksmuseum.nl |y.org | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)| |23.05.00 released in| | Status|Passed QA |Pushed to master -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 --- Comment #6 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Pushed to master for 23.05. Nice work everyone, thanks! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to master |Pushed to stable Version(s)|23.05.00 |23.05.00,22.11.05 released in| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 --- Comment #7 from Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com> --- Nice work everyone! Pushed to stable for 22.11.x -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Lucas Gass <lucas@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to stable |Pushed to oldstable Version(s)|23.05.00,22.11.05 |23.05.00,22.11.05,22.05.13 released in| | CC| |lucas@bywatersolutions.com --- Comment #8 from Lucas Gass <lucas@bywatersolutions.com> --- Backported to 22.05.x for upcoming 22.05.13. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=32716 Arthur Suzuki <arthur.suzuki@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)|23.05.00,22.11.05,22.05.13 |23.05.00,22.11.05,22.05.13, released in| |21.11.21 CC| |arthur.suzuki@biblibre.com --- Comment #9 from Arthur Suzuki <arthur.suzuki@biblibre.com> --- applied to 21.11 for 21.11.21 -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon@bugs.koha-community.org