Kouhei Sutou
null+****@clear*****
Fri Apr 28 14:15:05 JST 2017
Kouhei Sutou 2017-04-28 14:15:05 +0900 (Fri, 28 Apr 2017) New Revision: a0d3482f5d13b094c8dff28119ca125103d63888 https://github.com/groonga/groonga/commit/a0d3482f5d13b094c8dff28119ca125103d63888 Message: doc groonga-httpd: document groonga_cache_base_path Modified files: doc/source/news.rst doc/source/news/1.2.x.rst doc/source/news/3.x.rst doc/source/reference/command/request_timeout.rst doc/source/reference/executables/groonga-httpd.rst doc/source/reference/executables/groonga.rst Modified: doc/source/news.rst (+3 -2) =================================================================== --- doc/source/news.rst 2017-04-28 12:14:27 +0900 (5689911) +++ doc/source/news.rst 2017-04-28 14:15:05 +0900 (a9fd730) @@ -36,8 +36,9 @@ Improvements * [:option:`groonga --cache-base-path`] Added a new option to use persistent cache. -* [:doc:`/reference/executables/groonga-httpd`] Supported - ``groonga_cache_base_path`` option to use persistent cache. +* [:doc:`/reference/executables/groonga-httpd`] + [:ref:`groonga-httpd-cache-base-path`] Added new configuration to + use persistent cache. * [windows] Updated bundled msgpack to 2.1.1. Modified: doc/source/news/1.2.x.rst (+1 -1) =================================================================== --- doc/source/news/1.2.x.rst 2017-04-28 12:14:27 +0900 (82975cf) +++ doc/source/news/1.2.x.rst 2017-04-28 14:15:05 +0900 (6f24ffc) @@ -293,7 +293,7 @@ Improvements * document: Started English support. (not completed yet.) * groonga-suggest-httpd: Added --disable-max-fd-check option. * groonga: Renamed :option:`groonga -a` and :option:`groonga ---address` options to :option:`groonga --bind-address` option. + --address` options to :option:`groonga --bind-address` option. * groonga-suggest-httpd: Renamed --address option to --bind-address. * Changed admin HTML install directory to $PREFIX/share/groonga/html/admin/ from Modified: doc/source/news/3.x.rst (+4 -4) =================================================================== --- doc/source/news/3.x.rst 2017-04-28 12:14:27 +0900 (74cc00f) +++ doc/source/news/3.x.rst 2017-04-28 14:15:05 +0900 (7cce3df) @@ -131,8 +131,8 @@ Release 3.0.9 - 2013-10-29 Improvements ^^^^^^^^^^^^ -* [doc][httpd] Added documentation about :ref:`groonga-database-auto-create` directive. -* [httpd] Added :ref:`groonga-cache-limit` directive. +* [doc][httpd] Added documentation about :ref:`groonga-httpd-groonga-database-auto-create` directive. +* [httpd] Added :ref:`groonga-httpd-groonga-cache-limit` directive. * [doc] Added description why zlib/lzo compression are disabled by default. [groonga-dev, 01845] [Suggested by Naoya Murakami] * Remove a restriction related to RLIMIT_NOFILE on HTTP server. It enables HTTP server process to handle over 4096 files. @@ -163,7 +163,7 @@ Fixes reference columns fails. [Reported by Eito Katagiri] [GitHub Rroonga #13] * Fixed a bug that removing database which uses DAT key may remain garbage. * [http] Fixed a small memory leak which is caused by shared HTTP header buffer in the same worker thread. -* [httpd] Fixed a bug that :ref:`groonga-database-auto-create` parameter +* [httpd] Fixed a bug that :ref:`groonga-httpd-groonga-database-auto-create` parameter isn't inherited. It means that these parameters are just ignored in non location blocks. * Fixed a bug that status command may returns invalid cache hit rate. * Fix a bug that casting to Time may causes overflow issue. @@ -190,7 +190,7 @@ Improvements * [admin] Improved to submit search form with the enter key. [Patch by orangain] * [admin] Improved to show placeholder in search form. This change shows usage examples. [Patch by orangain] -* [httpd] Supported :ref:`groonga-query-log-path` directive +* [httpd] Supported :ref:`groonga-httpd-groonga-query-log-path` directive * [doc] Updated :doc:`/reference/commands/select` documentation about the number of hits in select response. * Improved to ignore an empty token which is generated by continuous spaces from tokenizer. Modified: doc/source/reference/command/request_timeout.rst (+1 -1) =================================================================== --- doc/source/reference/command/request_timeout.rst 2017-04-28 12:14:27 +0900 (5dad5ec) +++ doc/source/reference/command/request_timeout.rst 2017-04-28 14:15:05 +0900 (ae4ba9f) @@ -60,7 +60,7 @@ Enable request timeout by default :doc:`/reference/executables/groonga` supports enabling request timeout by default. You can specify the default request timeout by -:option:`--default-request-timeout`. +:option:`groonga --default-request-timeout`. If the default request timeout is larger than 0 second, the default request timeout is used as request timeout for all requests. Modified: doc/source/reference/executables/groonga-httpd.rst (+71 -23) =================================================================== --- doc/source/reference/executables/groonga-httpd.rst 2017-04-28 12:14:27 +0900 (d1f33d7) +++ doc/source/reference/executables/groonga-httpd.rst 2017-04-28 14:15:05 +0900 (cba6e25) @@ -20,8 +20,8 @@ by nginx is also available in groonga-httpd. groonga-httpd has an Web-based administration tool implemented with HTML and JavaScript. You can access to it from http://hostname:port/. -Synopsis --------- +Syntax +------ :: @@ -121,7 +121,7 @@ by groonga-httpd to configure groonga-httpd specific configurations. ``groonga`` """"""""""" -Synopsis:: +Syntax:: groonga on | off; @@ -144,12 +144,12 @@ Examples:: groonga off; # Disables groonga under /d/... path } -.. _groonga-database: +.. _groonga-httpd-groonga-database: ``groonga_database`` """""""""""""""""""" -Synopsis:: +Syntax:: groonga_database /path/to/groonga/database; @@ -162,12 +162,12 @@ Context Specifies the path to a Groonga database. This is the required directive. -.. _groonga-database-auto-create: +.. _groonga-httpd-groonga-database-auto-create: ``groonga_database_auto_create`` """""""""""""""""""""""""""""""" -Synopsis:: +Syntax:: groonga_database_auto_create on | off; @@ -179,9 +179,9 @@ Context Specifies whether Groonga database is created automatically or not. If the value is ``on`` and the Groonga database specified by -:ref:`groonga-database` doesn't exist, the Groonga database is created -automatically. If the Groonga database exists, groonga-httpd does -nothing. +:ref:`groonga-httpd-groonga-database` doesn't exist, the Groonga +database is created automatically. If the Groonga database exists, +groonga-httpd does nothing. If parent directory doesn't exist, parent directory is also created recursively. @@ -193,7 +193,7 @@ changed. ``groonga_base_path`` """"""""""""""""""""" -Synopsis:: +Syntax:: groonga_base_path /d/; @@ -237,12 +237,12 @@ Here is an example configuration to add authorization to # Because location name is the base path. } -.. _groonga-log-path: +.. _groonga-httpd-groonga-log-path: ``groonga_log_path`` """"""""""""""""""""" -Synopsis:: +Syntax:: groonga_log_path path | off; @@ -264,12 +264,12 @@ Examples:: groonga_log_path off; } -.. _groonga-log-level: +.. _groonga-httpd-groonga-log-level: ``groonga_log_level`` """"""""""""""""""""" -Synopsis:: +Syntax:: groonga_log_level none | emergency | alert | ciritical | error | warning | notice | info | debug | dump; @@ -290,12 +290,12 @@ Examples:: groonga_log_level notice; } -.. _groonga-query-log-path: +.. _groonga-httpd-groonga-query-log-path: ``groonga_query_log_path`` """""""""""""""""""""""""" -Synopsis:: +Syntax:: groonga_query_log_path path | off; @@ -349,19 +349,17 @@ see http://wiki.nginx.org/CoreModule#worker_processes. By default, this is set to 1. It is nginx's default. -.. _groonga-cache-limit: +.. _groonga-httpd-groonga-cache-limit: ``groonga_cache_limit`` """"""""""""""""""""""" -This directive is introduced to customize cache limit for each worker process. +Syntax:: -Synopsis:: - - groonga_cache_limit CACHE_LIMIT; + groonga_cache_limit limit; Default - 100 + ``groonga_cache_limit 100;`` Context ``http``, ``server``, ``location`` @@ -378,6 +376,56 @@ Examples:: groonga_cache_limit 100; } +.. _groonga-httpd-groonga-cache-base-path: + +``groonga_cache_base_path`` +""""""""""""""""""""""""""" + +Syntax:: + + groonga_cache_base_path path | off; + +Default + ``groonga_cache_base_path off;`` + +Context + ``http``, ``server``, ``location`` + +Specifies the base path of query cache in the ``http``, ``server`` or +``location`` block. + +It's recommended that you specify this configuration when you use +multi-workers configuration. + +If the base path is specified, you can use persistent cache instead of +on memory cache. If you use persistent cache, workers share query +cache. It's efficient for multi-workers configuration because the same +response is cached only once in multiple workers. + +There is one more merit for persistent cache. You don't need to warm +up cache after groonga-httpd is restarted. Persistent cache isn't +cleared when groonga-httpd is down. groonga-httpd can use existing +persistent cache again. + +The default value is ``off``. It means that persistent cache is +disabled. On memory cache is used. On memory cache is independent in +each worker. It's not efficient for multi-workers configuration +because two or more workers may keeps the same response separately. + +Persistent cache is a bit slower than on memory cache. Normally, the +difference has little influence on performance. + +You must specify the base path on memory file system. If you specify +the base path on disk, your cache will be slow. It's not make sense. + +Examples:: + + location /d/ { + groonga on; + # You can customize query cache limit for groonga. + groonga_cache_base_path /dev/shm/groonga-httpd-cache; + } + ``proxy_cache`` """"""""""""""" Modified: doc/source/reference/executables/groonga.rst (+2 -0) =================================================================== --- doc/source/reference/executables/groonga.rst 2017-04-28 12:14:27 +0900 (5de4a41) +++ doc/source/reference/executables/groonga.rst 2017-04-28 14:15:05 +0900 (77b4970) @@ -350,6 +350,8 @@ Options The default is nothing. It means that persistent cache is disabled. On memory cache is used. + Persistent cache is a bit slower than on memory cache. Normally, + the difference has little influence on performance. Command line parameters ----------------------- -------------- next part -------------- HTML����������������������������...Descargar
