Module: BoringMetrics

Defined in:

lib/boringmetrics.rb,
lib/boringmetrics/client.rb,
lib/boringmetrics/version.rb,
lib/boringmetrics/transport.rb,
lib/boringmetrics/log_methods.rb,
lib/boringmetrics/live_methods.rb,
lib/boringmetrics/configuration.rb

Overview

Main module for the Boring Metrics SDK

Defined Under Namespace

Classes: Client, Configuration, LiveMethods, LogMethods, Transport

Constant Summary

VERSION =

"0.1.1"

Class Attribute Summary

• .instance ⇒ BoringMetrics::Client readonly

  The configured client instance.

Class Method Summary

• .initialize(token) ⇒ BoringMetrics::Client

  Initialize the SDK with your API token.

• .lives ⇒ BoringMetrics::Client::LiveMethods

  Access lives functionality.

• .logs ⇒ BoringMetrics::Client::LogMethods

  Access logs functionality.

Class Attribute Details

.instance ⇒ BoringMetrics::Client (readonly)

Returns The configured client instance.

Returns:

• (BoringMetrics::Client) —

  The configured client instance

# File 'lib/boringmetrics.rb', line 11

def instance
  @instance
end

Class Method Details

.initialize(token) ⇒ BoringMetrics::Client

Initialize the SDK with your API token

Parameters:

• token (String) —

  Your Boring Metrics API token

Returns:

• (BoringMetrics::Client) —

  The configured client instance

# File 'lib/boringmetrics.rb', line 16

def initialize(token)
  @instance ||= Client.new(token)
end

.lives ⇒ BoringMetrics::Client::LiveMethods

Access lives functionality

Returns:

• (BoringMetrics::Client::LiveMethods)

# File 'lib/boringmetrics.rb', line 28

def lives
  instance.lives
end

.logs ⇒ BoringMetrics::Client::LogMethods

Access logs functionality

Returns:

• (BoringMetrics::Client::LogMethods)

# File 'lib/boringmetrics.rb', line 22

def logs
  instance.logs
end