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:31:24 UTC
[couchdb-documentation] branch master updated: Remove /_log
references from the documentation.
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
The following commit(s) were added to refs/heads/master by this push:
new f87f9e2 Remove /_log references from the documentation.
f87f9e2 is described below
commit f87f9e23077306ca3b09c1a300c8073419569767
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Wed Mar 15 10:17:11 2017 +0100
Remove /_log references from the documentation.
And add its removal to the whatsnew document.
---
src/api/server/common.rst | 71 ----------------------------------------
src/api/server/configuration.rst | 2 --
src/config/http-handlers.rst | 7 ----
src/config/http.rst | 8 -----
src/whatsnew/2.0.rst | 1 +
5 files changed, 1 insertion(+), 88 deletions(-)
diff --git a/src/api/server/common.rst b/src/api/server/common.rst
index e0aee09..cb9a60d 100644
--- a/src/api/server/common.rst
+++ b/src/api/server/common.rst
@@ -324,77 +324,6 @@
]
}
-.. _api/server/log:
-
-=========
-``/_log``
-=========
-
-.. http:get:: /_log
- :synopsis: Returns the server log file
-
- Gets the CouchDB log, equivalent to accessing the local log file of the
- corresponding CouchDB instance.
-
- :<header Accept: - :mimetype:`text/plain`
- :query number bytes: Bytes to be returned. Default is ``1000``.
- :query number offset: Offset in bytes where the log tail should be started.
- Default is ``0``.
- :>header Content-Type: :mimetype:`text/plain; charset=utf-8`
- :>header Transfer-Encoding: ``chunked``
- :code 200: Request completed successfully
- :code 401: CouchDB Server Administrator privileges required
-
- **Request**:
-
- .. code-block:: http
-
- GET /_log HTTP/1.1
- Accept: application/json
- Host: localhost:5984
-
- **Response**:
-
- .. code-block:: text
-
- [Wed, 27 Oct 2010 10:49:42 GMT] [info] [<0.23338.2>] 192.168.0.2 - - 'PUT' /authdb 401
- [Wed, 27 Oct 2010 11:02:19 GMT] [info] [<0.23428.2>] 192.168.0.116 - - 'GET' /recipes/FishStew 200
- [Wed, 27 Oct 2010 11:02:19 GMT] [info] [<0.23428.2>] 192.168.0.116 - - 'GET' /_session 200
- [Wed, 27 Oct 2010 11:02:19 GMT] [info] [<0.24199.2>] 192.168.0.116 - - 'GET' / 200
- [Wed, 27 Oct 2010 13:03:38 GMT] [info] [<0.24207.2>] 192.168.0.116 - - 'GET' /_log?offset=5 200
-
-If you want to pick out specific parts of the log information you can use the
-``bytes`` argument, which specifies the number of bytes to be returned,
-and ``offset``, which specifies where the reading of the log should start,
-counted back from the end. For example, if you use the following request:
-
-.. code-block:: http
-
- GET /_log?bytes=500&offset=2000 HTTP/1.1
-
-Reading of the log will start at 2000 bytes from the end of the log, and 500
-bytes will be shown.
-
-**How bytes/offset works?**
-
-CouchDB reads specified amount of ``bytes`` from the end of log file, jumping
-to ``offset`` bytes towards the beginning of the file first:
-
-.. code-block:: text
-
- Log File FilePos
- ----------
- | | 10
- | | 20
- | | 30
- | | 40
- | | 50
- | | 60
- | | 70 -- Bytes = 20 --
- | | 80 | Chunk
- | | 90 -- Offset = 10 --
- |__________| 100
-
.. _api/server/replicate:
===============
diff --git a/src/api/server/configuration.rst b/src/api/server/configuration.rst
index d78ceed..92057e3 100644
--- a/src/api/server/configuration.rst
+++ b/src/api/server/configuration.rst
@@ -118,7 +118,6 @@ the various configuration values within a running CouchDB instance.
"_active_tasks": "{couch_httpd_misc_handlers, handle_task_status_req}",
"_all_dbs": "{couch_httpd_misc_handlers, handle_all_dbs_req}",
"_config": "{couch_httpd_misc_handlers, handle_config_req}",
- "_log": "{couch_httpd_misc_handlers, handle_log_req}",
"_oauth": "{couch_httpd_oauth, handle_oauth_req}",
"_replicate": "{couch_httpd_misc_handlers, handle_replicate_req}",
"_restart": "{couch_httpd_misc_handlers, handle_restart_req}",
@@ -199,7 +198,6 @@ the various configuration values within a running CouchDB instance.
"bind_address": "127.0.0.1",
"default_handler": "{couch_httpd_db, handle_request}",
"enable_cors": "false",
- "log_max_chunk_size": "1000000",
"port": "5984",
"secure_rewrites": "true",
"vhost_global_handlers": "_utils, _uuids, _session, _oauth, _users"
diff --git a/src/config/http-handlers.rst b/src/config/http-handlers.rst
index a59fc1a..76c1a93 100644
--- a/src/config/http-handlers.rst
+++ b/src/config/http-handlers.rst
@@ -72,13 +72,6 @@ Global HTTP Handlers
[httpd_global_handlers]
_config = {couch_httpd_misc_handlers, handle_config_req}
- .. config:option:: _log
-
- ::
-
- [httpd_global_handlers]
- _log = {couch_httpd_misc_handlers, handle_log_req}
-
.. config:option:: _oauth
::
diff --git a/src/config/http.rst b/src/config/http.rst
index c206b1e..fef5c42 100644
--- a/src/config/http.rst
+++ b/src/config/http.rst
@@ -109,14 +109,6 @@ HTTP Server Options
[httpd]
enable_cors = false
- .. config:option:: log_max_chunk_size :: Logs chunk size
-
- Defines maximum chunk size in bytes for :ref:`_log <api/server/log>`
- resource::
-
- [httpd]
- log_max_chunk_size = 1000000
-
.. config:option:: port :: Listen port
Defined the port number to listen::
diff --git a/src/whatsnew/2.0.rst b/src/whatsnew/2.0.rst
index e774804..27d5935 100644
--- a/src/whatsnew/2.0.rst
+++ b/src/whatsnew/2.0.rst
@@ -60,6 +60,7 @@ Version 2.0.0
* ``/_up`` api to signal health of a node to a load-balancer
* ``/db/_local_docs`` and ``/db/_design_docs`` (similar to ``/db/_all_docs``)
+* The ``/_log`` endpoint was removed.
* "Backend" interface on port 5986 used for specific cluster admin tasks. Of
interest are the ``_nodes`` and ``_dbs`` databases visible only through this
interface.
--
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <co...@couchdb.apache.org>'].