couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject [20/32] git commit: updated refs/heads/1781-reorganize-and-improve-docs to 11fd32a
Date Fri, 14 Jun 2013 08:25:17 GMT
Describe log and log_level_by_module config sections.


Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/af1003e2
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/af1003e2
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/af1003e2

Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: af1003e26fdd590d1f0aff8a495ad6d3244c4027
Parents: 16defb1
Author: Alexander Shorin <kxepal@apache.org>
Authored: Wed Jun 12 15:47:59 2013 +0400
Committer: Alexander Shorin <kxepal@apache.org>
Committed: Wed Jun 12 16:06:30 2013 +0400

----------------------------------------------------------------------
 share/doc/build/Makefile.am    |  3 ++
 share/doc/src/config/index.rst |  1 +
 share/doc/src/config/log.rst   | 90 +++++++++++++++++++++++++++++++++++++
 3 files changed, 94 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/af1003e2/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index d9bb43d..807aaed 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -63,6 +63,7 @@ html_files = \
     html/_sources/config/daemons.txt \
     html/_sources/config/httpd.txt \
     html/_sources/config/index.txt \
+    html/_sources/config/log.txt \
     html/_sources/config/native-query-servers.txt \
     html/_sources/config/oauth.txt \
     html/_sources/config/os-daemons.txt \
@@ -127,6 +128,7 @@ html_files = \
     html/config/daemons.html \
     html/config/httpd.html \
     html/config/index.html \
+    html/config/log.html \
     html/config/native-query-servers.html \
     html/config/oauth.html \
     html/config/os-daemons.html \
@@ -189,6 +191,7 @@ src_files = \
     ../src/config/daemons.rst \
     ../src/config/httpd.rst \
     ../src/config/index.rst \
+    ../src/config/log.rst \
     ../src/config/native-query-servers.rst \
     ../src/config/oauth.rst \
     ../src/config/os-daemons.rst \

http://git-wip-us.apache.org/repos/asf/couchdb/blob/af1003e2/share/doc/src/config/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/index.rst b/share/doc/src/config/index.rst
index 0cf0da4..cc4106f 100644
--- a/share/doc/src/config/index.rst
+++ b/share/doc/src/config/index.rst
@@ -56,6 +56,7 @@ Content:
    couchdb
    daemons
    httpd
+   log
    native-query-servers
    oauth
    os-daemons

http://git-wip-us.apache.org/repos/asf/couchdb/blob/af1003e2/share/doc/src/config/log.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/log.rst b/share/doc/src/config/log.rst
new file mode 100644
index 0000000..f1d395b
--- /dev/null
+++ b/share/doc/src/config/log.rst
@@ -0,0 +1,90 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
+.. use this file except in compliance with the License. You may obtain a copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations under
+.. the License.
+
+.. highlight:: ini
+
+.. _config/log:
+
+``[log]`` :: Logging options
+============================
+
+CouchDB logging configuration.
+
+.. _config/log/file:
+
+``file`` :: Logging file path
+-----------------------------
+
+Specifies the location of file for logging output::
+
+  [log]
+  file = /var/log/couchdb/couch.log
+
+This path should be readable and writable for user that runs CouchDB service
+(`couchdb` by default).
+
+.. _config/log/level:
+
+``level`` :: Logging verbose level
+----------------------------------
+
+.. versionchanged:: 1.3: Added ``warning`` level.
+
+Logging level defines how verbose and detailed logging will be::
+
+  [log]
+  level = info
+
+Available levels:
+
+- ``debug``: Very informative and detailed debug logging. Includes HTTP headers,
+  external processes communications, authorization information and more;
+- ``info``: Informative logging. Includes HTTP requests headlines, startup of
+  external processes etc.
+- ``warning``: 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 reports
+  and HTTP error responses (5xx codes).
+- ``none``: Disables logging any messages.
+
+.. _config/log/include_sasl:
+
+``include_sasl``
+----------------
+
+Includes `SASL`_ information in logs::
+
+  [log]
+  include_sasl = true
+
+.. _SASL: http://www.erlang.org/doc/apps/sasl/
+
+
+.. _config/log_level_by_module:
+
+``[log_level_by_module]`` :: Per module logging
+===============================================
+
+.. versionadded:: 1.3
+
+In this section you can specify :ref:`log level <config/log/level>` on a
+per-module basis::
+
+  [log_level_by_module]
+  couch_httpd = debug
+  couch_replicator = info
+  couch_query_servers = error
+
+See `src/*/*.erl`_ for available modules.
+
+.. _src/*/*.erl: https://git-wip-us.apache.org/repos/asf?p=couchdb.git;a=tree;f=src;hb=HEAD


Mime
View raw message