You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by va...@apache.org on 2017/03/17 01:29:20 UTC
[couchdb-documentation] branch master updated (afcb3a2 -> c7f8645)
This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git.
from afcb3a2 Update description of GET /{db}/ response fields
new bcfc616 Document the log.writer option
new adefaac Fix a typo in the markup
new 33ae9ad Update logging references in _config section
new 0e7a95e Add additional logging levels
new 91e81ef Expand logging config documentation to include writer-specific parameters.
new c467369 Fix typo in option
new c7f8645 Render new options with more emphasis
The 7 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "adds" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/api/database/changes.rst | 2 +-
src/api/server/configuration.rst | 1 +
src/config/logging.rst | 78 +++++++++++++++++++++++++++++++++++++---
3 files changed, 76 insertions(+), 5 deletions(-)
--
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <co...@couchdb.apache.org>'].
[couchdb-documentation] 07/07: Render new options with more emphasis
Posted by va...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit c7f864524100418f1efec28ca461c9c6ea602852
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Thu Mar 16 08:47:24 2017 +0100
Render new options with more emphasis
---
src/config/logging.rst | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/src/config/logging.rst b/src/config/logging.rst
index d8d197a..c6c8c5e 100644
--- a/src/config/logging.rst
+++ b/src/config/logging.rst
@@ -36,7 +36,7 @@ Logging options
- ``syslog``: Logs are sent to the syslog daemon.
You can also specify a full module name here if implement your own
- writer.
+ writer::
[log]
writer = stderr
@@ -44,7 +44,7 @@ Logging options
.. config:option:: file :: Logging file path
Specifies the location of file for logging output. Only used by the
- ``file`` :option:`writer <log/writer>`.
+ ``file`` :option:`writer <log/writer>`::
[log]
file = /var/log/couchdb/couch.log
@@ -56,7 +56,7 @@ Logging options
Specifies the size of the file log write buffer in bytes, to enable
delayed log writes. Only used by the ``file``
- :option:`writer <log/writer>`.
+ :option:`writer <log/writer>`::
[log]
write_buffer = 0
@@ -65,7 +65,7 @@ Logging options
Specifies the wait in milliseconds before commiting logs to disk, to
enable delayed log writes. Only used by the ``file``
- :option:`writer <log/writer>`.
+ :option:`writer <log/writer>`::
[log]
write_delay = 0
@@ -109,34 +109,34 @@ Logging options
.. config:option:: syslog_host
Specifies the syslog host to send logs to. Only used by the
- ``syslog`` :option:`writer <log/writer>`.
+ ``syslog`` :option:`writer <log/writer>`::
- [log]
- syslog_host = localhost
+ [log]
+ syslog_host = localhost
.. config:option:: syslog_port
Specifies the syslog port to connect to when sending logs. Only used by
- the ``syslog`` :option:`writer <log/writer>`.
+ the ``syslog`` :option:`writer <log/writer>`::
- [log]
- syslog_port = 514
+ [log]
+ syslog_port = 514
.. config:option:: syslog_appid
Specifies application name to the ``syslog``
- :option:`writer <log/writer>`.
+ :option:`writer <log/writer>`::
- [log]
- syslog_appid = couchdb
+ [log]
+ syslog_appid = couchdb
.. config:option:: syslog_facility
Specifies the syslog facility to use with the ``syslog``
- :option:`writer <log/writer>`.
+ :option:`writer <log/writer>`::
- [log]
- syslog_facility = local2
+ [log]
+ syslog_facility = local2
.. _config/log_level_by_module:
--
To stop receiving notification emails like this one, please contact
"commits@couchdb.apache.org" <co...@couchdb.apache.org>.
[couchdb-documentation] 05/07: Expand logging config documentation
to include writer-specific parameters.
Posted by va...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit 91e81ef4b812c01b1bfc06897eac073632081c76
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Mon Mar 13 21:52:27 2017 +0100
Expand logging config documentation to include writer-specific parameters.
---
src/config/logging.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 52 insertions(+), 1 deletion(-)
diff --git a/src/config/logging.rst b/src/config/logging.rst
index 1884852..8488059 100644
--- a/src/config/logging.rst
+++ b/src/config/logging.rst
@@ -43,7 +43,8 @@ Logging options
.. config:option:: file :: Logging file path
- Specifies the location of file for logging output::
+ Specifies the location of file for logging output. Only used by the
+ ``file`` :option:`writer <log/writer>`.
[log]
file = /var/log/couchdb/couch.log
@@ -51,6 +52,24 @@ Logging options
This path should be readable and writable for user that runs CouchDB
service (`couchdb` by default).
+ .. config:option:: write_buffer
+
+ Specifies the size of the file log write buffer in bytes, to enable
+ delayed log writes. Only used by the ``file``
+ :option:`writer <log/writer>`.
+
+ [log]
+ write_buffer = 0
+
+ .. config:option:: write_delay
+
+ Specifies the wait in milliseconds before commiting logs to disk, to
+ enable delayed log writes. Only used by the ``file``
+ :option:`writer <log/writer>`.
+
+ [log]
+ write_delay = 0
+
.. config:option:: level :: Logging verbose level
.. versionchanged:: 1.3 Added ``warning`` level.
@@ -87,6 +106,38 @@ Logging options
.. _SASL: http://www.erlang.org/doc/apps/sasl/
+ .. config:option:: syslog_host
+
+ Specifies the syslog host to send logs to. Only used by the
+ ``syslog`` :option:`writer <log/writer>`.
+
+ [log]
+ syslog_host = localhost
+
+ .. config:optoin:: syslog_port
+
+ Specifies the syslog port to connect to when sending logs. Only used by
+ the ``syslog`` :option:`writer <log/writer>`.
+
+ [log]
+ syslog_port = 514
+
+ .. config:option:: syslog_appid
+
+ Specifies application name to the ``syslog``
+ :option:`writer <log/writer>`.
+
+ [log]
+ syslog_appid = couchdb
+
+ .. config:option:: syslog_facility
+
+ Specifies the syslog facility to use with the ``syslog``
+ :option:`writer <log/writer>`.
+
+ [log]
+ syslog_facility = local2
+
.. _config/log_level_by_module:
Per module logging
--
To stop receiving notification emails like this one, please contact
"commits@couchdb.apache.org" <co...@couchdb.apache.org>.
[couchdb-documentation] 03/07: Update logging references in _config
section
Posted by va...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit 33ae9addd54dcb4ce1432a3dbb72f3ea86a1d73b
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Mon Mar 13 20:36:46 2017 +0100
Update logging references in _config section
---
src/api/server/configuration.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/src/api/server/configuration.rst b/src/api/server/configuration.rst
index 4b120d2..13a54b3 100644
--- a/src/api/server/configuration.rst
+++ b/src/api/server/configuration.rst
@@ -129,6 +129,7 @@ the various configuration values within a running CouchDB instance.
"favicon.ico": "{couch_httpd_misc_handlers, handle_favicon_req, \"/usr/share/couchdb/www\"}"
},
"log": {
+ "writer": "file",
"file": "/var/log/couchdb/couch.log",
"include_sasl": "true",
"level": "info"
--
To stop receiving notification emails like this one, please contact
"commits@couchdb.apache.org" <co...@couchdb.apache.org>.
[couchdb-documentation] 04/07: Add additional logging levels
Posted by va...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit 0e7a95e8f39912701fec60c2901d62be5f9be0b0
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Mon Mar 13 21:38:46 2017 +0100
Add additional logging levels
I'm unsure of proper descriptions, however, so I've left those blank.
---
src/config/logging.rst | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/src/config/logging.rst b/src/config/logging.rst
index 28455f9..1884852 100644
--- a/src/config/logging.rst
+++ b/src/config/logging.rst
@@ -67,11 +67,15 @@ Logging options
and more;
- ``info``: Informative logging. Includes HTTP requests headlines,
startup of an external processes etc.
- - ``warning``: Warning messages are alerts about edge situations that
+ - ``notice``
+ - ``warning`` or ``warn``: Warning messages are alerts about edge situations that
may lead to errors. For instance, compaction daemon alerts about low
or insufficient disk space at this level.
- - ``error``: Error level includes only things that going wrong, crush
+ - ``error`` or ``err``: Error level includes only things that going wrong, crush
reports and HTTP error responses (5xx codes).
+ - ``critical`` or ``crit``
+ - ``alert``
+ - ``emergency`` or ``emerg``
- ``none``: Disables logging any messages.
.. config:option:: include_sasl
--
To stop receiving notification emails like this one, please contact
"commits@couchdb.apache.org" <co...@couchdb.apache.org>.
[couchdb-documentation] 06/07: Fix typo in option
Posted by va...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit c467369738550f226c2606024302f872db979c23
Author: Nick Vatamaniuc <ni...@users.noreply.github.com>
AuthorDate: Wed Mar 15 23:18:57 2017 -0400
Fix typo in option
---
src/config/logging.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/config/logging.rst b/src/config/logging.rst
index 8488059..d8d197a 100644
--- a/src/config/logging.rst
+++ b/src/config/logging.rst
@@ -114,7 +114,7 @@ Logging options
[log]
syslog_host = localhost
- .. config:optoin:: syslog_port
+ .. config:option:: syslog_port
Specifies the syslog port to connect to when sending logs. Only used by
the ``syslog`` :option:`writer <log/writer>`.
--
To stop receiving notification emails like this one, please contact
"commits@couchdb.apache.org" <co...@couchdb.apache.org>.
[couchdb-documentation] 02/07: Fix a typo in the markup
Posted by va...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit adefaace0ac6f2b6760aff8b8b7e2e62c7cdab49
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Mon Mar 13 20:18:15 2017 +0100
Fix a typo in the markup
---
src/api/database/changes.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/api/database/changes.rst b/src/api/database/changes.rst
index 70cb89b..de79564 100644
--- a/src/api/database/changes.rst
+++ b/src/api/database/changes.rst
@@ -192,7 +192,7 @@
Base64-encoding that is used leads to a 33% overhead (i.e. one third) in
transfer size for attachments.
-...warning::
+.. warning::
The results returned by `_changes` are partially ordered. In other words,
the order is not guaranteed to be preserved for multiple calls.
--
To stop receiving notification emails like this one, please contact
"commits@couchdb.apache.org" <co...@couchdb.apache.org>.
[couchdb-documentation] 01/07: Document the log.writer option
Posted by va...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vatamane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit bcfc61639ff3ab32ed96e218597d4df6f6a2aa6f
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Mon Mar 13 19:53:12 2017 +0100
Document the log.writer option
I adapted the description from that found in the default.ini.
---
src/config/logging.rst | 17 ++++++++++++++++-
1 file changed, 16 insertions(+), 1 deletion(-)
diff --git a/src/config/logging.rst b/src/config/logging.rst
index 7cfd56b..28455f9 100644
--- a/src/config/logging.rst
+++ b/src/config/logging.rst
@@ -26,6 +26,21 @@ Logging options
CouchDB logging configuration.
+ .. config:option:: writer :: Set the log writer to use.
+
+ Current writers include:
+
+ - ``stderr``: Logs are sent to stderr.
+ - ``file``: Logs are sent to the file set in
+ :option:`log file <log/file>`.
+ - ``syslog``: Logs are sent to the syslog daemon.
+
+ You can also specify a full module name here if implement your own
+ writer.
+
+ [log]
+ writer = stderr
+
.. config:option:: file :: Logging file path
Specifies the location of file for logging output::
@@ -38,7 +53,7 @@ Logging options
.. config:option:: level :: Logging verbose level
- .. versionchanged:: 1.3: Added ``warning`` level.
+ .. versionchanged:: 1.3 Added ``warning`` level.
Logging level defines how verbose and detailed logging will be::
--
To stop receiving notification emails like this one, please contact
"commits@couchdb.apache.org" <co...@couchdb.apache.org>.