Add Cloud Profiler to Forseti server

google/cloud/forseti/common/gcp_api/_base_repository.py

@@ -25,10 +25,10 @@
 
 import google_auth_httplib2
 import googleapiclient
+import uritemplate
 from googleapiclient import discovery
 from ratelimiter import RateLimiter
 from retrying import retry
-import uritemplate
 
 import google.auth
 from google.auth.credentials import with_scopes_if_required

google/cloud/forseti/services/server.py

@@ -35,6 +35,17 @@
 
 LOGGER = logger.get_logger(__name__)
 
+try:
+    import googlecloudprofiler
+    LOGGER.info('Cloud Profiler library successfully imported.')
+    CLOUD_PROFILER_IMPORTED = True
+except ImportError:
+    LOGGER.warning('Cannot enable Cloud Profiler because the '
+                   '`googlecloudprofiler` library was not found. Run '
+                   '`sudo pip3 install .[profiler]` to install '
+                   'Cloud Profiler.')
+    CLOUD_PROFILER_IMPORTED = False
+
 SERVICE_MAP = {
     'explain': GrpcExplainerFactory,
     'inventory': GrpcInventoryFactory,
@@ -141,9 +152,6 @@ def check_args(args):
     return (0, 'All good!')
 
 
-# pylint: enable=too-many-locals
-
-
 def main():
     """Run."""
     parser = argparse.ArgumentParser()
@@ -176,6 +184,10 @@ def main():
         '--enable_console_log',
         action='store_true',
         help='Print log to console.')
+    parser.add_argument(
+        '--enable_profiler',
+        action='store_true',
+        help='Enable Cloud Profiler.')
 
     args = vars(parser.parse_args())
 
@@ -186,6 +198,18 @@ def main():
         parser.print_usage()
         sys.exit(exit_code)
 
+    if args['enable_profiler'] and CLOUD_PROFILER_IMPORTED:
+        try:
+            googlecloudprofiler.start(
+                service='forseti-server',
+                verbose=2,
+                # project_id must be set if not running on GCP, such as in your
+                # local dev environment.
+                # project_id='my_project_id',
+            )
+        except (ValueError, NotImplementedError) as exc:
+            LOGGER.warning('Unable to enable Cloud Profiler: %s', exc)
+
     serve(args['endpoint'],
           args['services'],
           args['forseti_db'],

pylintrc

@@ -70,7 +70,7 @@ enable=all
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=no-name-in-module,relative-import,suppressed-message,locally-disabled,locally-enabled,too-few-public-methods
+disable=no-name-in-module,relative-import,suppressed-message,locally-disabled,locally-enabled,too-few-public-methods,ungrouped-imports
 
 [REPORTS]
 

setup.py

@@ -64,6 +64,12 @@
     'sqlalchemy-migrate==0.11.0'
 ]
 
+OPTIONAL_PACKAGES = {
+    'profiler': [
+        'google-cloud-profiler==1.0.8'
+    ]
+}
+
 if sys.version_info.major < 3:
     sys.exit('Sorry, Python 2 is not supported.')
 
@@ -122,6 +128,7 @@ def run(self):
     install_requires=REQUIRED_PACKAGES,
     setup_requires=REQUIRED_PACKAGES,
     tests_require=REQUIRED_PACKAGES,
+    extras_require=OPTIONAL_PACKAGES,
     packages=find_packages(exclude=[
         '*.tests', '*.tests.*', 'tests.*', 'tests']),
     include_package_data=True,