Merge pull request #1198 from andrewsg/error-reporting

Add error reporting sample for manual reporting

error_reporting/report_exception.py → error_reporting/api/report_exception.py

@@ -12,11 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# [START error_reporting]
-from google.cloud import error_reporting
-
 
+# [START error_reporting]
 def simulate_error():
+    from google.cloud import error_reporting
+
     client = error_reporting.Client()
     try:
         # simulate calling a method that's not defined
@@ -26,5 +26,15 @@ def simulate_error():
 # [END error_reporting]
 
 
+# [START error_reporting_manual]
+def report_manual_error():
+    from google.cloud import error_reporting
+
+    client = error_reporting.Client()
+    client.report("An error has occurred.")
+# [END error_reporting_manual]
+
+
 if __name__ == '__main__':
     simulate_error()
+    report_manual_error()

error_reporting/report_exception_test.py → error_reporting/api/report_exception_test.py

@@ -12,13 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import pytest
-
 import report_exception
 
 
-@pytest.mark.xfail(
-    strict=True,
-    reason='GoogleCloudPlatform/google-cloud-python#3263')
 def test_error_sends():
     report_exception.simulate_error()
+
+
+def test_manual_error_sends():
+    report_exception.report_manual_error()

error_reporting/fluent_on_compute/README.md

@@ -0,0 +1,30 @@
+# Google Error Reorting Samples Samples
+
+This section contains samples for [Google Cloud Error Reporting](https://cloud.google.com/error-reporting).
+
+A startup script has been provided to demonstrated how to properly provision a GCE 
+instance with fluentd configured. Note the intallation of fluentd, the addition of the config file,
+ and the restarting of the fluetnd service. You can start an instance  using
+it like this:
+
+    gcloud compute instances create example-instance --metadata-from-file startup-script=startup_script.sh
+
+or simply use it as reference when creating your own instance.
+
+After fluentd is configured, main.py could be used to simulate an error:
+
+    gcloud compute copy-files main.py example-instance:~/main.py
+
+Then, 
+
+    gcloud compute ssh example-instance
+    python ~/main.py
+
+And you will see the message in the Errors Console.
+
+<!-- auto-doc-link -->
+These samples are used on the following documentation page:
+
+> https://cloud.google.com/error-reporting/docs/setting-up-on-compute-engine
+
+<!-- end-auto-doc-link -->

error_reporting/fluent_on_compute/main.py

@@ -0,0 +1,42 @@
+# Copyright 2016 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.
+
+# [START error_reporting]
+import traceback
+
+import fluent.event
+import fluent.sender
+
+
+def simulate_error():
+    fluent.sender.setup('myapp', host='localhost', port=24224)
+
+    def report(ex):
+        data = {}
+        data['message'] = '{0}'.format(ex)
+        data['serviceContext'] = {'service': 'myapp'}
+        # ... add more metadata
+        fluent.event.Event('errors', data)
+
+    # report exception data using:
+    try:
+        # simulate calling a method that's not defined
+        raise NameError
+    except Exception:
+        report(traceback.format_exc())
+# [END error_reporting]
+
+
+if __name__ == '__main__':
+    simulate_error()

error_reporting/fluent_on_compute/main_test.py

@@ -0,0 +1,23 @@
+# Copyright 2016 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 mock
+
+import main
+
+
+@mock.patch("fluent.event")
+def test_error_sends(event_mock):
+    main.simulate_error()
+    event_mock.Event.assert_called_once_with(mock.ANY, mock.ANY)

error_reporting/fluent_on_compute/requirements.txt

@@ -0,0 +1 @@
+fluent-logger==0.4.4

error_reporting/fluent_on_compute/startup_script.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+# Copyright 2016 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.
+
+set -v
+
+curl -sSO "https://dl.google.com/cloudagents/install-logging-agent.sh"
+chmod +x install-logging-agent.sh
+./install-logging-agent.sh
+mkdir -p /etc/google-fluentd/config.d/
+cat <<EOF > /etc/google-fluentd/config.d/forward.conf
+<source>
+  type forward
+  port 24224
+</source>
+EOF
+service google-fluentd restart
+
+apt-get update
+apt-get install -yq \
+        git build-essential supervisor python python-dev python-pip libffi-dev \
+            libssl-dev
+pip install fluent-logger
+