From ee8a9753f0f7f2b025d0c1c464e4d6bf38d80bbb Mon Sep 17 00:00:00 2001
From: Jon Wayne Parrott <jon.wayne.parrott@gmail.com>
Date: Thu, 3 Dec 2015 14:48:00 -0800
Subject: [PATCH] Moving logging example.

---
 appengine/logging/__init__.py               |   0
 appengine/logging/reading_logs/__init__.py  |   0
 appengine/logging/reading_logs/app.yaml     |   7 ++
 appengine/logging/reading_logs/main.py      | 103 ++++++++++++++++++++
 appengine/logging/reading_logs/main_test.py |  31 ++++++
 appengine/logging/writing_logs/__init__.py  |   0
 appengine/logging/writing_logs/app.yaml     |   7 ++
 appengine/logging/writing_logs/main.py      |  47 +++++++++
 appengine/logging/writing_logs/main_test.py |  30 ++++++
 tests/utils.py                              |   1 +
 10 files changed, 226 insertions(+)
 create mode 100644 appengine/logging/__init__.py
 create mode 100644 appengine/logging/reading_logs/__init__.py
 create mode 100644 appengine/logging/reading_logs/app.yaml
 create mode 100644 appengine/logging/reading_logs/main.py
 create mode 100644 appengine/logging/reading_logs/main_test.py
 create mode 100644 appengine/logging/writing_logs/__init__.py
 create mode 100644 appengine/logging/writing_logs/app.yaml
 create mode 100644 appengine/logging/writing_logs/main.py
 create mode 100644 appengine/logging/writing_logs/main_test.py

diff --git a/appengine/logging/__init__.py b/appengine/logging/__init__.py
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/appengine/logging/reading_logs/__init__.py b/appengine/logging/reading_logs/__init__.py
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/appengine/logging/reading_logs/app.yaml b/appengine/logging/reading_logs/app.yaml
new file mode 100644
index 000000000000..42ad35ed2a84
--- /dev/null
+++ b/appengine/logging/reading_logs/app.yaml
@@ -0,0 +1,7 @@
+runtime: python27
+threadsafe: yes
+api_version: 1
+
+handlers:
+- url: .*
+  script: main.app
diff --git a/appengine/logging/reading_logs/main.py b/appengine/logging/reading_logs/main.py
new file mode 100644
index 000000000000..ef3e94606065
--- /dev/null
+++ b/appengine/logging/reading_logs/main.py
@@ -0,0 +1,103 @@
+# Copyright 2015 Google Inc.
+#
+# 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.
+
+"""
+Sample Google App Engine application that demonstrates how to use the App
+Engine Log Service API to read application logs.
+"""
+
+# [START all]
+import base64
+import datetime
+from itertools import islice
+from textwrap import dedent
+import time
+
+from google.appengine.api.logservice import logservice
+import webapp2
+
+
+def get_logs(offset=None):
+    # Logs are read backwards from the given end time. This specifies to read
+    # all logs up until now.
+    end_time = time.time()
+
+    logs = logservice.fetch(
+        end_time=end_time,
+        offset=offset,
+        minimum_log_level=logservice.LOG_LEVEL_INFO,
+        include_app_logs=True)
+
+    return logs
+
+
+def format_log_entry(entry):
+    # Format any application logs that happened during this request.
+    logs = []
+    for log in entry.app_logs:
+        date = datetime.datetime.fromtimestamp(
+            log.time).strftime('%D %T UTC')
+        logs.append('Date: {}, Message: {}'.format(
+            date, log.message))
+
+    # Format the request log and include the application logs.
+    date = datetime.datetime.fromtimestamp(
+        entry.end_time).strftime('%D %T UTC')
+
+    output = dedent("""
+        Date: {}
+        IP: {}
+        Method: {}
+        Resource: {}
+        Logs:
+    """.format(date, entry.ip, entry.method, entry.resource))
+
+    output += '\n'.join(logs)
+
+    return output
+
+
+class MainPage(webapp2.RequestHandler):
+    def get(self):
+        offset = self.request.get('offset', None)
+
+        if offset:
+            offset = base64.urlsafe_b64decode(str(offset))
+
+        # Get the logs given the specified offset.
+        logs = get_logs(offset=offset)
+
+        # Output the first 10 logs.
+        log = None
+        for log in islice(logs, 10):
+            self.response.write(
+                '<pre>{}</pre>'.format(format_log_entry(log)))
+
+            offset = log.offset
+
+        if not log:
+            self.response.write('No log entries found.')
+
+        # Add a link to view more log entries.
+        elif offset:
+            self.response.write(
+                '<a href="/?offset={}"">More</a'.format(
+                    base64.urlsafe_b64encode(offset)))
+
+
+app = webapp2.WSGIApplication([
+    ('/', MainPage)
+], debug=True)
+
+# [END all]
diff --git a/appengine/logging/reading_logs/main_test.py b/appengine/logging/reading_logs/main_test.py
new file mode 100644
index 000000000000..0ab76921a0b7
--- /dev/null
+++ b/appengine/logging/reading_logs/main_test.py
@@ -0,0 +1,31 @@
+# Copyright 2015 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.
+
+from tests import AppEngineTestbedCase
+import webtest
+
+from . import main
+
+
+class TestReadingLogs(AppEngineTestbedCase):
+    def setUp(self):
+        super(TestReadingLogs, self).setUp()
+
+        self.app = webtest.TestApp(main.app)
+
+    def test_get(self):
+        response = self.app.get('/')
+        self.assertEqual(response.status_int, 200)
+        self.assertTrue('No log entries found' in response.text)
+        self.assertTrue('More' not in response.text)
diff --git a/appengine/logging/writing_logs/__init__.py b/appengine/logging/writing_logs/__init__.py
new file mode 100644
index 000000000000..e69de29bb2d1
diff --git a/appengine/logging/writing_logs/app.yaml b/appengine/logging/writing_logs/app.yaml
new file mode 100644
index 000000000000..42ad35ed2a84
--- /dev/null
+++ b/appengine/logging/writing_logs/app.yaml
@@ -0,0 +1,7 @@
+runtime: python27
+threadsafe: yes
+api_version: 1
+
+handlers:
+- url: .*
+  script: main.app
diff --git a/appengine/logging/writing_logs/main.py b/appengine/logging/writing_logs/main.py
new file mode 100644
index 000000000000..442e7710020c
--- /dev/null
+++ b/appengine/logging/writing_logs/main.py
@@ -0,0 +1,47 @@
+# Copyright 2015 Google Inc.
+#
+# 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.
+
+"""
+Sample Google App Engine application that demonstrates using the standard
+Python logging package. Logs are automatically collected and available via
+the Google Cloud Console.
+"""
+
+# [START all]
+import logging
+
+import webapp2
+
+
+class MainPage(webapp2.RequestHandler):
+    def get(self):
+        logging.debug('This is a debug message')
+        logging.info('This is an info message')
+        logging.warning('This is a warning message')
+        logging.error('This is an error message')
+        logging.critical('This is a critical message')
+
+        try:
+            raise ValueError('This is a sample value error.')
+        except ValueError:
+            logging.exception('A example exception log.')
+
+        self.response.out.write('Logging example.')
+
+
+app = webapp2.WSGIApplication([
+    ('/', MainPage)
+], debug=True)
+
+# [END all]
diff --git a/appengine/logging/writing_logs/main_test.py b/appengine/logging/writing_logs/main_test.py
new file mode 100644
index 000000000000..c2f6fd86757c
--- /dev/null
+++ b/appengine/logging/writing_logs/main_test.py
@@ -0,0 +1,30 @@
+# Copyright 2015 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.
+
+from tests import AppEngineTestbedCase
+import webtest
+
+from . import main
+
+
+class TestWritingLogs(AppEngineTestbedCase):
+    def setUp(self):
+        super(TestWritingLogs, self).setUp()
+
+        self.app = webtest.TestApp(main.app)
+
+    def test_get(self):
+        response = self.app.get('/')
+        self.assertEqual(response.status_int, 200)
+        self.assertTrue('Logging example' in response.text)
diff --git a/tests/utils.py b/tests/utils.py
index 9ea605622b26..d9e7729fd107 100644
--- a/tests/utils.py
+++ b/tests/utils.py
@@ -94,6 +94,7 @@ def setUp(self):
         self.testbed.init_taskqueue_stub(root_path='tests/resources')
         self.taskqueue_stub = self.testbed.get_stub(
             testbed.TASKQUEUE_SERVICE_NAME)
+        self.testbed.init_logservice_stub()
 
     def tearDown(self):
         super(AppEngineTestbedCase, self).tearDown()