Collect profile data on DH requests

- Seeing issues with a lot of Drydock
  requests timing out and it seems to be a
  downstream issue with pulling Deckhand
  docs
- Add jsonpath cacheing as the jsonpath-ng
  parser was consuming 54s of the total 56s
  runtime of a rendered-documents GET call.
  With caching, the call is taking closer to 2s.
- All add a .dockerignore file to make image
  building a little faster

Change-Id: I6ef84ffd946dcf2713b4f7570b985156deb1d697

.dockerignore

@@ -0,0 +1,2 @@
+.tox
+build

charts/deckhand/templates/deployment.yaml

@@ -78,8 +78,16 @@ spec:
               mountPath: /etc/deckhand/policy.yaml
               subPath: policy.yaml
               readOnly: true
+{{ if .Values.conf.deckhand.DEFAULT.profiler }}
+            - name: tmp-profiles
+              mountPath: /tmp/profiles
+{{ end }}
 {{ if $mounts_deckhand.volumeMounts }}{{ toYaml $mounts_deckhand.volumeMounts | indent 12 }}{{ end }}
       volumes:
+{{ if .Values.conf.deckhand.DEFAULT.profiler }}
+        - name: tmp-profiles
+          emptyDir: {}
+{{ end }}
         - name: etc-deckhand
           emptyDir: {}
         - name: deckhand-etc

charts/deckhand/values.yaml

@@ -215,6 +215,7 @@ conf:
       debug: true
       use_stderr: true
       use_syslog: true
+      profiler: false
     database:
       connection:
     keystone_authtoken:

deckhand/conf/config.py

@@ -48,6 +48,9 @@ Possible values:
     * True
     * False
 """),
+    cfg.BoolOpt('profiler', default=False,
+                help="Enabling profiling of API requests. Do NOT "
+                     "use in production."),
 ]
 
 

deckhand/service.py

@@ -17,6 +17,7 @@ import os
 import falcon
 from oslo_config import cfg
 from oslo_log import log
+from werkzeug.contrib.profiler import ProfilerMiddleware
 
 from deckhand.control import base
 from deckhand.control import buckets
@@ -82,5 +83,11 @@ def deckhand_app_factory(global_config, **local_config):
 
     app = falcon.API(request_type=base.DeckhandRequest,
                      middleware=middleware_list)
-
+    if CONF.profiler:
-    return configure_app(app, version='v1.0')
+        LOG.warning("Profiler ENABLED. Expect significant "
+                    "performance overhead.")
+        return ProfilerMiddleware(
+            configure_app(app, version='v1.0'),
+            profile_dir="/tmp/profiles")  # nosec w/o profile data
+    else:
+        return configure_app(app, version='v1.0')

deckhand/utils.py

@@ -25,6 +25,8 @@ from deckhand import errors
 
 LOG = logging.getLogger(__name__)
 
+path_cache = dict()
+
 
 def to_camel_case(s):
     """Convert string to camel case."""
@@ -71,7 +73,12 @@ def jsonpath_parse(data, jsonpath, match_all=False):
     elif jsonpath.startswith('.'):
         jsonpath = '$' + jsonpath
 
-    p = jsonpath_ng.parse(jsonpath)
+    if jsonpath not in path_cache:
+        p = jsonpath_ng.parse(jsonpath)
+        path_cache[jsonpath] = p
+    else:
+        p = path_cache[jsonpath]
+
     matches = p.find(data)
     if matches:
         result = [m.value for m in matches]

requirements.txt

@@ -41,3 +41,6 @@ oslo.utils>=3.35.0 # Apache-2.0
 # likely this should be imported from a
 # container sidecar long-term
 python-barbicanclient>=4.6.0  # Apache-2.0
+
+# To support profiling in non-prod
+Werkzeug==0.14.1