Added docs about the swift_source log field

Change-Id: I934230a006c856de844d8580f3b57f38a9845844
This commit is contained in:
John Dickinson 2014-02-04 15:17:11 -08:00
parent 8902aef591
commit ab98fe3d74
3 changed files with 41 additions and 1 deletions

View File

@ -64,13 +64,39 @@ will not change. Swift log processing utilities should look for the first N
fields they require (e.g. in Python using something like fields they require (e.g. in Python using something like
``log_line.split()[:14]`` to get up through the transaction id). ``log_line.split()[:14]`` to get up through the transaction id).
Swift Source
============
The ``source`` value in the proxy logs is used to identify the originator of a
request in the system. For example, if the client initiates a bulk upload, the
proxy server may end up doing many requests. The initial bulk upload request
will be logged as normal, but all of the internal "child requests" will have a
source value indicating they came from the bulk functionality.
======================= =============================
**Logged Source Value** **Originator of the Request**
----------------------- -----------------------------
FP :ref:`formpost`
SLO :ref:`static-large-objects`
SW :ref:`staticweb`
TU :ref:`tempurl`
BD :ref:`bulk` (delete)
EA :ref:`bulk` (extract)
CQ :ref:`container-quotas`
CS :ref:`container-sync`
TA :ref:`common_tempauth`
DLO :ref:`dynamic-large-objects`
======================= =============================
----------------- -----------------
Storage Node Logs Storage Node Logs
----------------- -----------------
Swift's account, container, and object server processes each log requests Swift's account, container, and object server processes each log requests
that they receive. The format for these log lines is:: that they receive, if they have been configured to do so with the
``log_requests`` config parameter (which defaults to true). The format for
these log lines is::
remote_addr - - [datetime] "request_method request_path" status_int remote_addr - - [datetime] "request_method request_path" status_int
content_length "referer" "transaction_id" "user_agent" request_time content_length "referer" "transaction_id" "user_agent" request_time

View File

@ -47,6 +47,8 @@ Ratelimit
:members: :members:
:show-inheritance: :show-inheritance:
.. _staticweb:
StaticWeb StaticWeb
========= =========
@ -63,6 +65,8 @@ TempURL
:members: :members:
:show-inheritance: :show-inheritance:
.. _formpost:
FormPost FormPost
======== ========
@ -130,6 +134,8 @@ GateKeeper
:members: :members:
:show-inheritance: :show-inheritance:
.. _bulk:
Bulk Operations (Delete and Archive Auto Extraction) Bulk Operations (Delete and Archive Auto Extraction)
==================================================== ====================================================
@ -137,6 +143,8 @@ Bulk Operations (Delete and Archive Auto Extraction)
:members: :members:
:show-inheritance: :show-inheritance:
.. _container-quotas:
Container Quotas Container Quotas
================ ================
@ -174,6 +182,8 @@ List Endpoints
:members: :members:
:show-inheritance: :show-inheritance:
.. _container-sync:
Container Sync Middleware Container Sync Middleware
========================= =========================

View File

@ -15,6 +15,8 @@ special manifest file is created that, when downloaded, sends all the segments
concatenated as a single object. This also offers much greater upload speed concatenated as a single object. This also offers much greater upload speed
with the possibility of parallel uploads of the segments. with the possibility of parallel uploads of the segments.
.. _dynamic-large-objects:
--------------------- ---------------------
Dynamic Large Objects Dynamic Large Objects
--------------------- ---------------------
@ -102,6 +104,8 @@ Here's an example using ``curl`` with tiny 1-byte segments::
curl -H 'X-Auth-Token: <token>' \ curl -H 'X-Auth-Token: <token>' \
http://<storage_url>/container/myobject http://<storage_url>/container/myobject
.. _static-large-objects:
-------------------- --------------------
Static Large Objects Static Large Objects
-------------------- --------------------