Module: OpenObserve

Defined in:
lib/openobserve.rb,
lib/openobserve/hit.rb,
lib/openobserve/alert.rb,
lib/openobserve/alerts.rb,
lib/openobserve/client.rb,
lib/openobserve/coerce.rb,
lib/openobserve/record.rb,
lib/openobserve/search.rb,
lib/openobserve/stream.rb,
lib/openobserve/streams.rb,
lib/openobserve/version.rb,
lib/openobserve/incident.rb,
lib/openobserve/resource.rb,
lib/openobserve/template.rb,
lib/openobserve/dashboard.rb,
lib/openobserve/incidents.rb,
lib/openobserve/templates.rb,
lib/openobserve/dashboards.rb,
lib/openobserve/sourcemaps.rb,
lib/openobserve/destination.rb,
lib/openobserve/client/error.rb,
lib/openobserve/destinations.rb,
lib/openobserve/search_result.rb,
lib/openobserve/client/conflict.rb,
lib/openobserve/client/forbidden.rb,
lib/openobserve/client/not_found.rb,
lib/openobserve/directory_source.rb,
lib/openobserve/client/unauthorized.rb

Overview

Idiomatic, business-oriented Ruby wrapper over the OpenObserve REST API. It sits on top of the openobserve-api transport layer and absorbs the raw API's rough edges (the api sub-client hop, microsecond timestamps, the v1/v2 alerting split) behind a stable, ergonomic surface. See Client.

Defined Under Namespace

Modules: Coerce, DirectorySource, VERSION Classes: Alert, Alerts, Client, Dashboard, Dashboards, Destination, Destinations, Hit, Incident, Incidents, Record, Resource, Search, SearchResult, Sourcemaps, Stream, Streams, Template, Templates

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.loader ⇒ Zeitwerk::Loader (readonly)

The Zeitwerk loader owning this gem's lib/openobserve/ tree. The transport gem runs its own loader over lib/openobserve-api/ for OpenObserve::Api; the two share the OpenObserve root namespace but never the same directory.

Returns:

  • (Zeitwerk::Loader) 


25
26
27
 
# File 'lib/openobserve.rb', line 25

def loader
  @loader
end

Class Method Details

.eager_load! ⇒ void

This method returns an undefined value.

Eager load this gem's tree. Used by the spec suite to prove every file defines the constant its path implies; callers may use it to avoid autoload work at runtime.



39
40
41
 
# File 'lib/openobserve.rb', line 39

def self.eager_load!
  @loader.eager_load
end

.gem_version ⇒ Gem::Version

Returns the gem version.

Returns:

  • (Gem::Version) —

    the gem version



5
6
7
 
# File 'lib/openobserve/version.rb', line 5

def self.gem_version
  Gem::Version.new VERSION::STRING
end

.new ⇒ OpenObserve::Client

Convenience shortcut for OpenObserve::Client.new.

Returns:



31
32
33
 
# File 'lib/openobserve.rb', line 31

def self.new(...)
  Client.new(...)
end