Update logging for cloud run sample (GoogleCloudPlatform#2299)

averikitsch · web-flow · commit d2b261940411 · 2019-07-31T09:13:47.000-07:00
* Update readmes and logging for cloud run sample

* Update tests

* Revert changes and add flush

* Update gcloud commands

* Update docker run for cred

* Add link with more info
diff --git a/run/README.md b/run/README.md
@@ -36,9 +36,9 @@ For more Cloud Run samples beyond Python, see the main list in the [Cloud Run Sa
 2. [Build the sample container](https://cloud.google.com/run/docs/building/containers#building_locally_and_pushing_using_docker):
 
     ```
-    export SAMPLE=$sample
+    export SAMPLE=<SAMPLE_NAME>
     cd $SAMPLE
-    docker build --tag $sample .
+    docker build --tag $SAMPLE .
     ```
 
 3. [Run containers locally](https://cloud.google.com/run/docs/testing/local)
@@ -57,25 +57,44 @@ For more Cloud Run samples beyond Python, see the main list in the [Cloud Run Sa
         -v $PWD:/app $SAMPLE
     ```
 
-    Injecting your service account key:
+    Injecting your service account key for access to GCP services:
 
     ```
+    # Set the name of the service account key within the container
     export SA_KEY_NAME=my-key-name-123
+
     PORT=8080 && docker run --rm \
-        -p 8080:${PORT} -e PORT=${PORT} \
+        -p 8080:${PORT} \
+        -e PORT=${PORT} \
         -e GOOGLE_APPLICATION_CREDENTIALS=/tmp/keys/${SA_KEY_NAME}.json \
         -v $GOOGLE_APPLICATION_CREDENTIALS:/tmp/keys/${SA_KEY_NAME}.json:ro \
         -v $PWD:/app $SAMPLE
     ```
 
+    * Use the --volume (-v) flag to inject the credential file into the container
+      (assumes you have already set your `GOOGLE_APPLICATION_CREDENTIALS`
+      environment variable on your machine)
+
+    * Use the --environment (-e) flag to set the `GOOGLE_APPLICATION_CREDENTIALS`
+      variable inside the container
+
+    Learn more about [testing your container image locally.][testing]
+
 ## Deploying
 
+1. Set an environment variable with your GCP Project ID
+```
+export GOOGLE_CLOUD_PROJECT=<PROJECT_ID>
+```
+
+1. Submit a build using Google Cloud Build
 ```
 gcloud builds submit --tag gcr.io/${GOOGLE_CLOUD_PROJECT}/${SAMPLE}
-gcloud beta run deploy $SAMPLE \
-  # Needed for Manual Logging sample.
-  --set-env-var GOOGLE_CLOUD_PROJECT=${GOOGLE_CLOUD_PROJECT}
-  --image gcr.io/${GOOGLE_CLOUD_PROJECT}/${SAMPLE}
+```
+
+1. Deploy to Cloud Run
+```
+gcloud beta run deploy $SAMPLE --image gcr.io/${GOOGLE_CLOUD_PROJECT}/${SAMPLE}
 ```
 
 See [Building containers][run_build] and [Deploying container images][run_deploy]
@@ -88,3 +107,4 @@ for more information.
 [pubsub]: pubsub/
 [run_button_helloworld]: https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/knative/docs&cloudshell_working_dir=docs/serving/samples/hello-world/helloworld-python
 [run_button_pubsub]: https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&cloudshell_working_dir=run/pubsub
+[testing]: https://cloud.google.com/run/docs/testing/local#running_locally_using_docker_with_access_to_services
diff --git a/run/pubsub/README.md b/run/pubsub/README.md
@@ -32,6 +32,12 @@ _Note: you may need to install `pytest` using `pip install pytest`._
 ## Deploy
 
 ```
+# Set an environment variable with your GCP Project ID
+export GOOGLE_CLOUD_PROJECT=<PROJECT_ID>
+
+# Submit a build using Google Cloud Build
 gcloud builds submit --tag gcr.io/${GOOGLE_CLOUD_PROJECT}/pubsub-tutorial
-gcloud alpha run deploy pubsub-tutorial --image gcr.io/${GOOGLE_CLOUD_PROJECT}/pubsub-tutorial
+
+# Deploy to Cloud Run
+gcloud beta run deploy pubsub-tutorial --image gcr.io/${GOOGLE_CLOUD_PROJECT}/pubsub-tutorial
 ```
diff --git a/run/pubsub/main.py b/run/pubsub/main.py
@@ -16,6 +16,7 @@
 import base64
 from flask import Flask, request
 import os
+import sys
 
 app = Flask(__name__)
 # [END run_pubsub_server_setup]
@@ -42,6 +43,10 @@ def index():
         name = base64.b64decode(pubsub_message['data']).decode('utf-8').strip()
 
     print(f'Hello {name}!')
+
+    # Flush the stdout to avoid log buffering.
+    sys.stdout.flush()
+
     return ('', 204)
 # [END run_pubsub_handler]
 
