Adding base sample files for stackdriver

Author: Frank Natividad

stackdriver/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "sinatra", "~> 1.4"
+
+# [START stackdriver_gem]
+gem "stackdriver"
+# [END stackdriver_gem]

stackdriver/README.md

@@ -0,0 +1,50 @@
+# Stackdriver Samples
+
+Samples used by Stackdriver documentation. The samples don't work out-of-the-box
+and require some modification. The samples are provided as reference guides
+when using Rails, Sinatra, other-rack frameworks, and non-rack apps.
+
+## Rails
+
+The `rails_configuration.rb` provides a configuration example that can be used
+in your `config/environments/*.rb` files.
+
+## Sinatra
+
+Sinatra exmple apps load middleware using a rack configuration file. For example
+`rackup rack_debugger.ru` is an example of starting a Sinatra app with
+Stackdriver Debugger.
+
+The following list provides samples used per Stackdriver product.
+
+### Debugger
+
+- `debugger.ru`
+- `sinatra_debugger.rb`
+
+### Trace
+
+- `trace.ru`
+- `sinatra_trace.rb`
+
+### Logging
+
+- `logging.ru`
+- `sinatra_logging.rb`
+
+### Error Reporting
+
+- `error_reporting.ru`
+- `sinatra_error_reporting.rb`
+
+### Shared Configuration
+
+Stackdriver gems can be configured using shared configuration which is shown in
+`shared_config.ru`
+
+## Non-rack apps
+
+An additional example shows that Debugger doesn't require a Rack
+based app.
+
+- `non_rack_debugger.rb`

stackdriver/debugger.ru

@@ -0,0 +1,20 @@
+require_relative "sinatra_debugger"
+
+# [START debugger_middleware]
+require "google/cloud/debugger"
+
+use Google::Cloud::Debugger::Middleware
+# [END debugger_middleware]
+
+# [START debugger_configure]
+require "google/cloud/debugger"
+
+Google::Cloud.configure do |config|
+  # Stackdriver Debugger specific parameters
+  config.debugger.project_id = "YOUR-PROJECT-ID"
+  config.debugger.keyfile    = "/path/to/service-account.json"
+end
+# [END debugger_configure]
+
+run Sinatra::Application
+

stackdriver/error_reporting.ru

@@ -0,0 +1,19 @@
+require_relative "sinatra_error_reporting"
+
+# [START error_reporting_middleware]
+require "google/cloud/error_reporting"
+
+use Google::Cloud::ErrorReporting::Middleware
+# [END error_reporting_middleware]
+
+# [START error_reporting_configure]
+require "google/cloud/error_reporting"
+
+Google::Cloud.configure do |config|
+  # Stackdriver Error Reporting specific parameters
+  config.error_reporting.project_id = "YOUR-PROJECT-ID"
+  config.error_reporting.keyfile    = "/path/to/service-account.json"
+end
+# [END error_reporting_configure]
+
+run Sinatra::Application

stackdriver/logging.ru

@@ -0,0 +1,20 @@
+require_relative "sinatra_logging"
+
+# [START logging_middleware]
+require "google/cloud/logging"
+
+use Google::Cloud::Logging::Middleware
+# [END logging_middleware]
+
+# [START logging_configure]
+require "google/cloud/logging"
+
+Google::Cloud.configure do |config|
+  # Stackdriver Logging specific parameters
+  config.logging.project_id = "YOUR-PROJECT-ID"
+  config.logging.keyfile    = "/path/to/service-account.json"
+end
+# [END logging_configure]
+
+run Sinatra::Application
+

stackdriver/non_rack_debugger.rb

@@ -0,0 +1,13 @@
+# [START explicit_debugger_norack]
+require "google/cloud/debugger"
+
+Google::Cloud::Debugger.new(project_id: "YOUR-PROJECT-ID",
+                            keyfile:    "/path/to/service-account.json").start
+# [END explicit_debugger_norack]
+
+# [START implicit_debugger_norack]
+require "google/cloud/debugger"
+
+Google::Cloud::Debugger.new.start
+# [END implicit_debugger_norack]
+

stackdriver/rails_configuration.rb

@@ -0,0 +1,44 @@
+# [START shared_configure]
+# Add this to config/environments/*.rb
+Rails.application.configure do |config|
+  # Stackdriver Shared parameters
+  config.google_cloud.project_id = "YOUR-PROJECT-ID"
+  config.google_cloud.keyfile    = "/path/to/service-account.json"
+end
+# [END shared_configure]
+
+# [START debugger_configure]
+# Add this to config/environments/*.rb
+Rails.application.configure do |config|
+  # Stackdriver Debugger specific parameters
+  config.google_cloud.debugger.project_id = "YOUR-PROJECT-ID"
+  config.google_cloud.debugger.keyfile    = "/path/to/service-account.json"
+end
+# [END debugger_configure]
+
+# [START trace_configure]
+# Add this to config/environments/*.rb
+Rails.application.configure do |config|
+  # Stackdriver Trace specific parameters
+  config.google_cloud.trace.project_id = "YOUR-PROJECT-ID"
+  config.google_cloud.trace.keyfile    = "/path/to/service-account.json"
+end
+# [END trace_configure]
+
+# [START error_reporting_configure]
+# Add this to config/environments/*.rb
+Rails.application.configure do |config|
+  # Stackdriver Error Reporting specific parameters
+  config.google_cloud.error_reporting.project_id = "YOUR-PROJECT-ID"
+  config.google_cloud.error_reporting.keyfile    = "/path/to/service-account.json"
+end
+# [END error_reporting_configure]
+
+# [START logging_configure]
+# Add this to config/environments/*.rb
+Rails.application.configure do |config|
+  # Stackdriver Logging specific parameters
+  config.google_cloud.logging.project_id = "YOUR-PROJECT-ID"
+  config.google_cloud.logging.keyfile    = "/path/to/service-account.json"
+end
+# [END logging_configure]

stackdriver/shared_config.ru

@@ -0,0 +1,10 @@
+# [START shared_configure]
+require "stackdriver"
+
+Google::Cloud.configure do |config|
+  # Stackdriver Shared parameters
+  config.project_id = "YOUR-PROJECT-ID"
+  config.keyfile    = "/path/to/service-account.json"
+end
+# [END shared_configure]
+

stackdriver/sinatra_debugger.rb

@@ -0,0 +1,5 @@
+require "sinatra"
+
+get "/" do
+  "hello world!"
+end

stackdriver/sinatra_error_reporting.rb

@@ -0,0 +1,18 @@
+require "sinatra"
+
+get "/" do
+
+end
+
+get "/raise" do
+# [START error_reporting_exception]
+  require "google/cloud/error_reporting"
+
+  begin
+    fail "Raise an exception for Error Reporting."
+  rescue => exception
+    Google::Cloud::ErrorReporting.report exception
+  end
+# [END error_reporting_exception]
+end
+