Sha256: c1fea2a3a7d7bda8b01fa2d8a7a45574bb58604c88ae2c1921635b275127156c

Contents?: true

Size: 1.42 KB

Versions: 14

Compression:

Stored size: 1.42 KB

Contents

module Bixby
  module Metrics

    # Store the results of one or more Checks. Each result may contain multiple metrics.
    #
    # Fires the :put_check_result hook on completion, passing results as the only param.
    #
    # @param [Array<Hash>] results              An array of results from one or more checks
    # @option results [Fixnum] :check_id
    # @option results [String] :key             base key name
    # @option results [String] :status          OK, WARNING, CRITICAL, UNKNOWN, TIMEOUT
    # @option results [Fixnum] :timestamp
    # @option results [Array]  :metrics
    #   * [Hash] :metrics                       key/value pairs
    #   * [Hash] :metadata                      key/value pairs
    # @option results [Array<String>] :errors   list of errors, if any
    #
    # @return [void]
    #
    # Example input:
    #
    #    {
    #      "status"    => "OK",
    #      "timestamp" => 1329775841,
    #      "key"       => "hardware.storage.disk",
    #      "check_id"  => "77",
    #      "metrics" => [
    #        {
    #          "metrics"  => { "size"=>297, "used"=>202, "free"=>94, "usage"=>69 },
    #          "metadata" => { "mount"=>"/", "type"=>"hfs" }
    #        }
    #      ],
    #      "errors"=>[]
    #    }
    #
    def self.put_check_result(results)
      req = JsonRequest.new("metrics:put_check_result", [ results ])
      return Bixby.client.exec_api(req)
    end

  end # Metrics
end # Bixby

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
bixby-client-0.5.3 lib/bixby-client/modules/metrics.rb
bixby-client-0.5.2 lib/bixby-client/modules/metrics.rb
bixby-client-0.5.1 lib/bixby-client/modules/metrics.rb
bixby-client-0.5.0 lib/bixby-client/modules/metrics.rb
bixby-client-0.4.1 lib/bixby-client/modules/metrics.rb
bixby-client-0.4.0 lib/bixby-client/modules/metrics.rb
bixby-client-0.3.0 lib/bixby-client/modules/metrics.rb
bixby-client-0.2.2 lib/bixby-client/modules/metrics.rb
bixby-client-0.2.1 lib/bixby-client/modules/metrics.rb
bixby-client-0.2.0 lib/bixby-client/modules/metrics.rb
bixby-client-0.1.4 lib/bixby-client/modules/metrics.rb
bixby-client-0.1.3 lib/bixby-client/modules/metrics.rb
bixby-client-0.1.2 lib/bixby-client/modules/metrics.rb
bixby-client-0.1.1 lib/bixby-client/modules/metrics.rb