class PlatformAPI::LogDrain

[Log drains](devcenter.heroku.com/articles/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.

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 2087
def initialize(client)
  @client = client
end

Public Instance Methods

create(app_id_or_app_name, body = {}) click to toggle source

Create a new log drain.

@param app_id_or_app_name: unique identifier of app or unique name of app @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 2095
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) click to toggle source

Delete an existing log drain. Log drains added by add-ons can only be removed by removing the add-on.

@param app_id_or_app_name: unique identifier of app or unique name of app @param log_drain_id_or_log_drain_url_or_log_drain_token: unique identifier of this log drain or url associated with the log drain or token associated with the log drain

# File lib/platform-api/client.rb, line 2112
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) click to toggle source

Info for existing log drain.

@param app_id_or_app_name: unique identifier of app or unique name of app @param log_drain_id_or_log_drain_url_or_log_drain_token: unique identifier of this log drain or url associated with the log drain or token associated with the log drain

# File lib/platform-api/client.rb, line 2120
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) click to toggle source

List existing log drains.

@param app_id_or_app_name: unique identifier of app or unique name of app

# File lib/platform-api/client.rb, line 2134
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) click to toggle source

List existing log drains for an add-on.

@param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on

# File lib/platform-api/client.rb, line 2127
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 = {}) click to toggle source

Update an add-on owned log drain.

@param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on @param log_drain_id_or_log_drain_url_or_log_drain_token: unique identifier of this log drain or url associated with the log drain or token associated with the log drain @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 2104
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