stackdriver_simple 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e16354a6269722025c5124a621cfe909f8a8d1f424302bf01dcaf1c0f6d4615
+  data.tar.gz: 633eef3b4d3dd7c99300f26efde767af34e2cc9192da431731bfa1e1478f8583
+SHA512:
+  metadata.gz: 79a2a2e7739a3d2d14b01057e83ee3125d04d5c550aef4cd3bd59f90eff9e73db8596e8406e566fea048d524950fde3863f31756539a1ce6c7432f7b9057d767
+  data.tar.gz: 320bdeef1596a9c9981526bceae32127d014c0a2ddafdec456ec50c0b1643738a6270cf808dc5c59c03d7674f2edfbcf452111bd21fca59d9047fb4e4b0890ec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Peter Jones
+Copyright (c) 2009 James Healy
+
+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

@@ -0,0 +1,53 @@
+# stackdriver_simple
+
+It's surprisingly hard to submit metrics directly to stackdriver using ruby.
+
+The [official docs](https://cloud.google.com/monitoring/custom-metrics/open-census)
+recommend using [opencensus](https://opencensus.io/), but the stackdriver
+backend for the ruby opencensus implementation is incomplete.
+
+I eventually worked out the right voodoo, but it's not the kind of code you want
+to re-implement in multiple projects.
+
+## Installation
+
+Manually:
+
+    gem install stackdriver_simple
+
+or, in your Gemfile:
+
+    gem "stackdriver_simple"
+
+## Usage
+
+### Authentication
+
+This is just a wrapper around an official google gem that knows the well-known
+places to look for valid credentials.
+
+One option is to have credentials in a JSON file. If you have the `gcloud` SDK
+installed, the following command will save some credentials to disk in a place
+where the gem will find them:
+
+    gcloud auth application-default login
+
+If you have a JSON file with gcloud credentials in another location, set the GOOGLE_APPLICATION_CREDENTIALS environment variable like this:
+
+    GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json ruby my-script.rb
+
+Alternatively, if you're running a program on Google Compute Engine the
+instance metadata will contain valid credentials too.
+
+### Gauges
+
+Submit a gauge like this:
+
+    require 'stackdriver_simple'
+
+    StackdriverSimple.new(google_cloud_project: "my-project-id").submit_gauge("gauge_name", 123)
+
+### Other metric types
+
+There are other metrics types that could be submitted, I just haven't
+implemented them yet. Pull requests are welcome!

data/lib/stackdriver_simple.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+#
+require "google/cloud/monitoring"
+
+class StackdriverSimple
+
+  def initialize(google_cloud_project:)
+    @google_cloud_project = google_cloud_project.to_s
+
+    raise ArgumentError if @google_cloud_project.include?(" ")
+  end
+
+  # This assumes the following two ENV vars are set:
+  #
+  # * GOOGLE_APPLICATION_CREDENTIALS=<path-to-credentials>
+  def submit_gauge(name, value)
+    raise ArgumentError, "name cannot include spaces" if name.to_s.include?(" ")
+    raise ArgumentError, "name cannot include /" if name.to_s.include?("/")
+    raise ArgumentError, "value cannot be nil" if value.nil?
+
+    # This might have optional arguments for providing the project and credentials?
+    client = Google::Cloud::Monitoring::Metric.new
+    project_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path(@google_cloud_project)
+
+    series = Google::Monitoring::V3::TimeSeries.new
+    metric = Google::Api::Metric.new type: "custom.googleapis.com/#{name}"
+    series.metric = metric
+
+    resource = Google::Api::MonitoredResource.new type: "global"
+    series.resource = resource
+
+    point = Google::Monitoring::V3::Point.new
+    point.value = Google::Monitoring::V3::TypedValue.new double_value: value
+    now = Time.now
+    end_time = Google::Protobuf::Timestamp.new seconds: now.to_i, nanos: now.usec
+    point.interval = Google::Monitoring::V3::TimeInterval.new end_time: end_time
+    series.points << point
+
+    client.create_time_series project_name, [series]
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: stackdriver_simple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-monitoring
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An easy way to submit metrics to stackdriver
+email:
+- james@yob.id.au
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
+files:
+- MIT-LICENSE
+- README.md
+- lib/stackdriver_simple.rb
+homepage: http://github.com/yob/stackdriver_simpler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: An easy way to submit metrics to stackdriver
+test_files: []