Class: PlatformAPI::LogDrain

Inherits:

Object

• Object
• PlatformAPI::LogDrain

Defined in:

lib/platform-api/client.rb

Overview

Log drains provide a way to forward your Heroku logs to an external syslog server for long-term archiving. This external service must be configured to receive syslog packets from Heroku, whereupon its URL can be added to an app using this API. Some add-ons will add a log drain when they are provisioned to an app. These drains can only be removed by removing the add-on.

Instance Method Summary

• #create(app_id_or_app_name, body = {}) ⇒ Object
• #delete(app_id_or_app_name, log_drain_id_or_log_drain_url_or_log_drain_token) ⇒ Object
• #info(app_id_or_app_name, log_drain_id_or_log_drain_url_or_log_drain_token) ⇒ Object
• #initialize(client) ⇒ LogDrain constructor

  A new instance of LogDrain.

• #list(app_id_or_app_name) ⇒ Object
• #list_by_addon(addon_id_or_addon_name) ⇒ Object
• #update(addon_id_or_addon_name, log_drain_id_or_log_drain_url_or_log_drain_token, body = {}) ⇒ Object

Constructor Details

#initialize(client) ⇒ LogDrain

Returns a new instance of LogDrain.

# File 'lib/platform-api/client.rb', line 3078

def initialize(client)
  @client = client
end

Instance Method Details

#create(app_id_or_app_name, body = {}) ⇒ Object

# File 'lib/platform-api/client.rb', line 3092

def create(app_id_or_app_name, body = {})
  @client.log_drain.create(app_id_or_app_name, body)
end

#delete(app_id_or_app_name, log_drain_id_or_log_drain_url_or_log_drain_token) ⇒ Object

# File 'lib/platform-api/client.rb', line 3122

def delete(app_id_or_app_name, log_drain_id_or_log_drain_url_or_log_drain_token)
  @client.log_drain.delete(app_id_or_app_name, log_drain_id_or_log_drain_url_or_log_drain_token)
end

#info(app_id_or_app_name, log_drain_id_or_log_drain_url_or_log_drain_token) ⇒ Object

# File 'lib/platform-api/client.rb', line 3136

def info(app_id_or_app_name, log_drain_id_or_log_drain_url_or_log_drain_token)
  @client.log_drain.info(app_id_or_app_name, log_drain_id_or_log_drain_url_or_log_drain_token)
end

#list(app_id_or_app_name) ⇒ Object

# File 'lib/platform-api/client.rb', line 3160

def list(app_id_or_app_name)
  @client.log_drain.list(app_id_or_app_name)
end

#list_by_addon(addon_id_or_addon_name) ⇒ Object

# File 'lib/platform-api/client.rb', line 3148

def list_by_addon(addon_id_or_addon_name)
  @client.log_drain.list_by_addon(addon_id_or_addon_name)
end

#update(addon_id_or_addon_name, log_drain_id_or_log_drain_url_or_log_drain_token, body = {}) ⇒ Object

# File 'lib/platform-api/client.rb', line 3108

def update(addon_id_or_addon_name, log_drain_id_or_log_drain_url_or_log_drain_token, body = {})
  @client.log_drain.update(addon_id_or_addon_name, log_drain_id_or_log_drain_url_or_log_drain_token, body)
end