Class: GraylogAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/graylogapi.rb,
lib/graylogapi/users.rb,
lib/graylogapi/alerts.rb,
lib/graylogapi/client.rb,
lib/graylogapi/system.rb,
lib/graylogapi/streams.rb,
lib/graylogapi/version.rb,
lib/graylogapi/dashboards.rb,
lib/graylogapi/extractors.rb,
lib/graylogapi/stream_rules.rb,
lib/graylogapi/static_fields.rb,
lib/graylogapi/system/inputs.rb,
lib/graylogapi/system/cluster.rb,
lib/graylogapi/client/response.rb,
lib/graylogapi/system/index_sets.rb,
lib/graylogapi/system/inputs/types.rb

Overview

class for work with graylog api

Defined Under Namespace

Classes: Alerts, Client, Dashboards, Extractors, StaticFields, StreamRules, Streams, System, Users

Constant Summary collapse

VERSION = 
'1.3.2'.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ GraylogAPI

Initializes a new GraylogAPI object

Parameters:

  • options (Hash) (defaults to: {}) 


24
25
26
 
# File 'lib/graylogapi.rb', line 24

def initialize(options = {})
  @client = Client.new(options)
end

Instance Attribute Details

#client ⇒ GraylogAPI::Client (readonly)

Returns:



18
19
20
 
# File 'lib/graylogapi.rb', line 18

def client
  @client
end

Instance Method Details

#alerts ⇒ GraylogAPI::Alerts

Returns:



29
30
31
 
# File 'lib/graylogapi.rb', line 29

def alerts
  @alerts ||= Alerts.new(@client)
end

#dashboards ⇒ GraylogAPI::Dashboards

Returns:



49
50
51
 
# File 'lib/graylogapi.rb', line 49

def dashboards
  @dashboards ||= Dashboards.new(@client)
end

#extractors ⇒ GraylogAPI::Extractors

Returns:



59
60
61
 
# File 'lib/graylogapi.rb', line 59

def extractors
  @extractors ||= Extractors.new(@client)
end

#static_fields ⇒ GraylogAPI::StaticFields

Returns:



54
55
56
 
# File 'lib/graylogapi.rb', line 54

def static_fields
  @static_fields ||= StaticFields.new(@client)
end

#stream_rules ⇒ GraylogAPI::StreamsRules

Returns:

  • (GraylogAPI::StreamsRules) 


44
45
46
 
# File 'lib/graylogapi.rb', line 44

def stream_rules
  @stream_rules ||= StreamRules.new(@client)
end

#streams ⇒ GraylogAPI::Streams

Returns:



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

def streams
  @streams ||= Streams.new(@client)
end

#system ⇒ GraylogAPI::System

Returns:



34
35
36
 
# File 'lib/graylogapi.rb', line 34

def system
  @system ||= System.new(@client)
end

#users ⇒ GraylogAPI::Users

Returns:



64
65
66
 
# File 'lib/graylogapi.rb', line 64

def users
  @users ||= Users.new(@client)
end