Enhanced debugging infos

- removed version / config leakage in headers for all requests
- moved versions output to ping
- added more hosts debugging infos in the ping endpoint
- renamed _versions to _debug
- removed version from the / endpoint
- made / text configurable (issue)

Docker-DCO-1.1-Signed-off-by: Olivier Gambier <[email protected]> (github: dmp42)

Author: Olivier Gambier

README.md

@@ -153,7 +153,7 @@ When using the `config_sample.yml`, you can pass all options through as environm
 1. `loglevel`: string, level of debugging. Any of python's
    [logging](http://docs.python.org/2/library/logging.html) module levels:
    `debug`, `info`, `warn`, `error` or `critical`
-1. `debug_versions`: boolean, enable the `/_versions` endpoint for debugging.
+1. `debug`: boolean, make the `/_ping` endpoint output more useful informations, such as library versions and host information.
 1. `storage_redirect`: Redirect resource requested if storage engine supports
    this, e.g. S3 will redirect signed URLs, this can be used to offload the
    server.

config/config_sample.yml

@@ -1,9 +1,10 @@
 # All other flavors inherit the `common' config snippet
 common: &common
+    issue: '"docker-registry server"'
     # Default log level is info
     loglevel: _env:LOGLEVEL:info
-    # Enable the debugging /_versions endpoint
-    debug_versions: _env:DEBUG_VERSIONS:false
+    # Enable debugging (additional informations in the output of the _ping endpoint)
+    debug: _env:DEBUG:false
     # By default, the registry acts standalone (eg: doesn't query the index)
     standalone: _env:STANDALONE:true
     # The default endpoint to use (if NOT standalone) is index.docker.io
@@ -179,7 +180,7 @@ elliptics:
 dev: &dev
     <<: *local
     loglevel: _env:LOGLEVEL:debug
-    debug_versions: _env:DEBUG_VERSIONS:true
+    debug: _env:DEBUG:true
     search_backend: _env:SEARCH_BACKEND:sqlalchemy
 
 # This flavor is used by unit tests

docker_registry/app.py

@@ -3,6 +3,7 @@
 import logging
 import logging.handlers
 import os
+import platform
 import sys
 
 from . import toolkit
@@ -26,24 +27,16 @@
 @app.route('/_ping')
 @app.route('/v1/_ping')
 def ping():
-    headers = {'X-Docker-Registry-Standalone': cfg.standalone is True}
-    if mirroring.is_mirror():
-        headers['X-Docker-Registry-Standalone'] = 'mirror'
-    return toolkit.response(headers=headers)
+    headers = {
+        'X-Docker-Registry-Standalone': 'mirror' if mirroring.is_mirror()
+                                        else (cfg.standalone is True)
+    }
+    infos = {}
+    if cfg.debug:
+        # Versions
+        versions = infos['versions'] = {}
+        headers['X-Docker-Registry-Config'] = cfg.flavor
 
-
-@app.route('/_versions')
-@app.route('/v1/_versions')
-def versions():
-    """Return a JSON object ({"package-name": "package-version", ...}).
-
-    This is an unofficial endpoint for debugging your docker-registry
-    install.  If you're running a publicly-accessible endpoint, it's
-    probably best to disable this endpoint to avoid leaking
-    implementation details.
-    """
-    versions = {}
-    if cfg.debug_versions:
         for name, module in sys.modules.items():
             if name.startswith('_'):
                 continue
@@ -53,20 +46,17 @@ def versions():
                 continue
             versions[name] = version
         versions['python'] = sys.version
-    return toolkit.response(versions)
 
+        # Hosts infos
+        infos['host'] = platform.uname()
+        infos['launch'] = sys.argv
 
-@app.route('/')
-def root():
-    return toolkit.response('docker-registry server ({0}) (v{1})'
-                            .format(cfg.flavor, __version__))
+    return toolkit.response(infos, headers=headers)
 
 
-@app.after_request
-def after_request(response):
-    response.headers['X-Docker-Registry-Version'] = __version__
-    response.headers['X-Docker-Registry-Config'] = cfg.flavor
-    return response
+@app.route('/')
+def root():
+    return toolkit.response(cfg.issue)
 
 
 def bugsnag(application, api_key, flavor, version):