alerty-plugin-stackdriver 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfe5672c5435de5e687dde50cb6f59456e8b57b6
-  data.tar.gz: 0ea6b49908522bf2d8ed2b03b333f4f0ff22456f
+  metadata.gz: 2d3325464e2303f7f9ec6e0e05b6f9922810a76a
+  data.tar.gz: 0060fe275b148594af890d102c6d5cacd0fe5145
 SHA512:
-  metadata.gz: 3f661c604da93e10943ee3cec15e1bffaff8093cc1bc2bd4f1ffa8dde10478aed3e6397112cdfac326dddc263e2eba97989b25c12bf0f2e3f1a563c608224b95
-  data.tar.gz: 2f0d435a6135995b035f327f9810bd34ce79c1ab475fcffc1879201a42d9d0935009eec37091eef06c0b9d2f232194446c016042a104f5984e92747b4f57bd59
+  metadata.gz: 8b3b20f61b128e0548c34a77d07a19bf8386f6668e32e5123f25ab856e75148ba7f59687946835a81c2293553c754aa8a020c02e69eb52327be19489e93ae26e
+  data.tar.gz: c82203f2b3d37ecca7d580d5cc95af59a3ba6364cc66643a24061d53b886a014830755c50e4da392723f819566f2911ef4af5ec1319220a98bc72fd85841c9ca

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 potato2003
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -26,8 +26,25 @@ Or install it yourself as:
 * **log_name**: Stackdriver log name.
 * **resource_type**: Stackdriver Logging monitored resource types. https://cloud.google.com/logging/docs/api/v2/resource-list
 * **resource_labels**: Stackdriver Logging monitored resource labels. https://cloud.google.com/logging/docs/api/v2/resource-list
+* **app_name**: your application name, the default name is `alerty`.
+* **app_version**: your application version, the default value is `default`.
 * **message**: message of alert. `${command}` is replaced with a given command, `${hostname}` is replaced with the hostname ran the command, `${output}` is replaced with the output. The default is `${output}`.
 
+
+```
+log_path: STDOUT
+log_level: debug
+plugins:
+  - type: stackdriver
+    keyfile: "example_keyfile.json"
+    project_id: "example_project"
+    log_name: "example_alerty_log"
+    resource_type: "gae_app"
+    resource_labels:
+      module_id: "1"
+      version_id: "20150925t173233"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -38,3 +55,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/potato2003/alerty-plugin-stackdriver.
 
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/alerty-plugin-stackdriver.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "alerty-plugin-stackdriver"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["potato2003"]
   spec.email         = ["potato2003@gmail.com"]
 

data/lib/alerty/plugin/stackdriver.rb

@@ -11,7 +11,9 @@ class Alerty
         # https://cloud.google.com/logging/docs/api/v2/resource-list
         @resource_type   = config.resource_type
         @resource_labels = config.resource_labels
-        @log_name        = config.log_name || 'alerty'
+        @app_name        = config.app_name    || 'alerty'
+        @app_version     = config.app_version || 'default'
+        @log_name        = config.log_name    || 'alerty'
         @message         = config.message
         @num_retries     = config.num_retries || DEFAULT_NUM_OF_RETIRES
 
@@ -55,16 +57,30 @@ class Alerty
         e.resource.labels = @resource_labels if @resource_labels
         e.log_name        = @log_name
         e.payload         = payload(record)
+        e.severity        = :ERROR
 
         e
       end
 
       def payload(record)
-        if @message
-          expand_placeholder(@message, record)
-        else
-          record[:output]
-        end
+        body = if @message
+                 expand_placeholder(@message, record)
+               else
+                 record[:output]
+               end
+
+        # support Stackdriver Error Reporting. https://cloud.google.com/error-reporting/docs/formatting-error-messages
+        {
+          serviceContext: {
+            service: @app_name,
+            app_version: @app_version
+          },
+          message: body,
+          context: {
+            functionName: record[:command],
+            lineNumber: 0
+          }
+        }
       end
 
       def expand_placeholder(str, record)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alerty-plugin-stackdriver
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - potato2003
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alerty
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - alerty-plugin-stackdriver.gemspec