Add Profiler code samples for App Engine (GoogleCloudPlatform#2028)

jqll · tswast · commit 3e019f34ba20 · 2019-03-06T07:58:34.000-08:00
* Add Profiler code samples for App Engine

* Fix comments
diff --git a/profiler/appengine/flexible/app.yaml b/profiler/appengine/flexible/app.yaml
@@ -0,0 +1,19 @@
+runtime: python
+env: flex
+entrypoint: gunicorn -b :$PORT main:app
+
+# App Engine flexible Python 3 runtime uses Python 3.7.x, which supports both
+# CPU and Wall profiling.
+runtime_config:
+  python_version: 3
+
+# This sample incurs costs to run on the App Engine flexible environment. 
+# The settings below are to reduce costs during testing and are not appropriate
+# for production use. For more information, see:
+# https://cloud.google.com/appengine/docs/flexible/python/configuring-your-app-with-app-yaml
+manual_scaling:
+  instances: 1
+resources:
+  cpu: 1
+  memory_gb: 0.5
+  disk_size_gb: 10
diff --git a/profiler/appengine/flexible/main.py b/profiler/appengine/flexible/main.py
@@ -0,0 +1,45 @@
+# Copyright 2019 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""An example of using https://cloud.google.com/profiler on GAE flex."""
+
+from flask import Flask
+# [START profiler_python_appengine_flex]
+import googlecloudprofiler
+
+# Profiler initialization. It starts a daemon thread which continuously
+# collects and uploads profiles. Best done as early as possible.
+try:
+    # service and service_version can be automatically inferred when
+    # running on App Engine. project_id must be set if not running
+    # on GCP.
+    googlecloudprofiler.start(verbose=3)
+except (ValueError, NotImplementedError) as exc:
+    print(exc)  # Handle errors here
+
+# [END profiler_python_appengine_flex]
+
+
+app = Flask(__name__)
+
+
+@app.route('/')
+def hello():
+    """Return a friendly HTTP greeting."""
+    return 'Hello World!'
+
+
+if __name__ == '__main__':
+    # This is used when running locally. Gunicorn is used to run the
+    # application on Google App Engine. See entrypoint in app.yaml.
+    app.run(host='127.0.0.1', port=8080, debug=True)
diff --git a/profiler/appengine/flexible/main_test.py b/profiler/appengine/flexible/main_test.py
@@ -0,0 +1,24 @@
+# Copyright 2019 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import main
+
+
+def test_index():
+    main.app.testing = True
+    client = main.app.test_client()
+
+    r = client.get('/')
+    assert r.status_code == 200
+    assert 'Hello World' in r.data.decode('utf-8')
diff --git a/profiler/appengine/flexible/requirements.txt b/profiler/appengine/flexible/requirements.txt
@@ -0,0 +1,3 @@
+Flask==1.0.2
+gunicorn==19.9.0
+google-cloud-profiler
diff --git a/profiler/appengine/standard_python37/app.yaml b/profiler/appengine/standard_python37/app.yaml
@@ -0,0 +1 @@
+runtime: python37
diff --git a/profiler/appengine/standard_python37/main.py b/profiler/appengine/standard_python37/main.py
@@ -0,0 +1,48 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""An example of using https://cloud.google.com/profiler on GAE standard."""
+
+from flask import Flask
+# [START profiler_python_appengine_standard_python37]
+import googlecloudprofiler
+
+# Profiler initialization. It starts a daemon thread which continuously
+# collects and uploads profiles. Best done as early as possible.
+try:
+    # service and service_version can be automatically inferred when
+    # running on App Engine. project_id must be set if not running
+    # on GCP.
+    googlecloudprofiler.start(verbose=3)
+except (ValueError, NotImplementedError) as exc:
+    print(exc)  # Handle errors here
+
+# [END profiler_python_appengine_standard_python37]
+
+
+# If `entrypoint` is not defined in app.yaml, App Engine will look for an app
+# called `app` in `main.py`.
+app = Flask(__name__)
+
+
+@app.route('/')
+def hello():
+    """Return a friendly HTTP greeting."""
+    return 'Hello World!'
+
+
+if __name__ == '__main__':
+    # This is used when running locally only. When deploying to Google App
+    # Engine, a webserver process such as Gunicorn will serve the app. This
+    # can be configured by adding an `entrypoint` to app.yaml.
+    app.run(host='127.0.0.1', port=8080, debug=True)
diff --git a/profiler/appengine/standard_python37/main_test.py b/profiler/appengine/standard_python37/main_test.py
@@ -0,0 +1,24 @@
+# Copyright 2019 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import main
+
+
+def test_index():
+    main.app.testing = True
+    client = main.app.test_client()
+
+    r = client.get('/')
+    assert r.status_code == 200
+    assert 'Hello World' in r.data.decode('utf-8')
diff --git a/profiler/appengine/standard_python37/requirements.txt b/profiler/appengine/standard_python37/requirements.txt
@@ -0,0 +1,2 @@
+Flask==1.0.2
+google-cloud-profiler
diff --git a/profiler/quickstart/main.py b/profiler/quickstart/main.py
@@ -33,7 +33,7 @@ def main():
             # project_id='my-project-id',
         )
     except (ValueError, NotImplementedError) as exc:
-        print(exc)  # Handles errors here
+        print(exc)  # Handle errors here
 # [END profiler_python_quickstart]
     busyloop()
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Flask==1.0.2`
	`2`	`+gunicorn==19.9.0`
	`3`	`+google-cloud-profiler`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Flask==1.0.2`
	`2`	`+google-cloud-profiler`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ def main():`
`33`	`33`	`# project_id='my-project-id',`
`34`	`34`	`)`
`35`	`35`	`except (ValueError, NotImplementedError) as exc:`
`36`		`- print(exc) # Handles errors here`
	`36`	`+ print(exc) # Handle errors here`
`37`	`37`	`# [END profiler_python_quickstart]`
`38`	`38`	`busyloop()`
`39`	`39`