Swift middleware to relay information about a request back to the client.

• Timing - Adds the "Inspector-Timing" header to the request indicating the amount of time it took the proxy server to process the request.

$ curl -i -H'Inspector: Timing' -XGET -H'x-auth-token: AUTH_tkd03626426c8647aeba7eb150330e8be6' http://127.0.0.1:8080/v1/AUTH_test/c
HTTP/1.1 200 OK
...
Inspector-Timing: 0.0140538215637

example_object

• Handlers - Adds the "Inspector-Handlers" and "Inspector-Handlers-Proxy" headers to the request. "Inspector-Handlers" is meant to return the account/container/object servers that were contacted in the request, but is currently unimplemented. As such it always returns "Unknown". "Inspector-Handlers-Proxy" returns the proxy that handled the request.

curl -i -XGET  -H'inspector: Handlers' -H'x-auth-token: AUTH_tk9b6a1f4321dd4108afdfbb609c31c199' http://127.0.0.1:8080/v1/AUTH_test/c/o
HTTP/1.1 200 OK
...
Inspector-Handlers-Proxy: http://192.168.0.1:8080/v1/AUTH_test/c/o
Inspector-Handlers-Object: http://127.0.0.1:6030/sdb3/312/AUTH_test/c/o
...

example_object_data

• Nodes - Adds the "Inspector-Nodes" and "Inspector-More-Nodes" headers to the request. "Inspector-Nodes" indicates what account/container/object servers the path resides on. "Inspector-More-Nodes" indicates extra nodes for a partition for hinted handoff.

$ curl -i -H'Inspector: Nodes' -XGET -H'x-auth-token: AUTH_tkd03626426c8647aeba7eb150330e8be6' http://127.0.0.1:8080/v1/AUTH_test/c
HTTP/1.1 200 OK
...
Inspector-Nodes: http://127.0.0.1:6042/sdb4/802, http://127.0.0.1:6032/sdb3/802, http://127.0.0.1:6022/sdb2/802
Inspector-More-Nodes: http://127.0.0.1:6012/sdb1/802

example_object

Swift Inspector currently supports middleware in the proxy and object servers.

####Proxy Configuration

• Add inspector to your pipeline, preferably immediately after gatekeeper.

pipeline = catch_errors gatekeeper inspector ...

• Add the inspector filter.

[filter:inspector]
use = egg:swift_inspector#swift_proxy_inspector
# hmac_key - Key to restrict access to the inspector feature.  if set, will
#            require the additional headers 'Inspector-Expires'
#            and 'Inspector-Sig'. Inspector-Expires represents a unix timestamp
#            indicating when access to the feature should be cut off.
#            Inspector-Sig is the signature used to sign the inspectors to
#            allow access to.
hmac_key = Password1
#
# exclude - List of inspector names separated by spaces to exclude.  This 
#           will cause a invalid inspector error if a request attempts to
#           request it.
exclude =
#
# default - List of inspector names separated by spaces to automatically include.
#           This is useful for a SAIO or dev instance where this information
#           could be useful with most requests.
default = Timing Handlers Nodes

####Object Server Configuration

• Add inspector to the front of your pipeline.

pipeline = inspector recon ...

• Add the inspector filter.

[filter:inspector]
use = egg:swift_inspector#swift_object_inspector

• Restart servers as needed.