Class: PlatformAPI::TelemetryDrain

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

A telemetry drain forwards OpenTelemetry traces, metrics, and logs to your own consumer. For Fir-generation apps only.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ TelemetryDrain

Returns a new instance of TelemetryDrain.



3533
3534
3535
 
# File 'lib/platform-api/client.rb', line 3533

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a telemetry drain.

Parameters:

  • body: —

    the object to pass as the request payload



3540
3541
3542
 
# File 'lib/platform-api/client.rb', line 3540

def create(body = {})
  @client.telemetry_drain.create(body)
end

#delete(telemetry_drain_id) ⇒ Object

Delete a telemetry drain.

Parameters:

  • telemetry_drain_id: —

    unique identifier of telemetry drain



3569
3570
3571
 
# File 'lib/platform-api/client.rb', line 3569

def delete(telemetry_drain_id)
  @client.telemetry_drain.delete(telemetry_drain_id)
end

#info(telemetry_drain_id) ⇒ Object

Info for a telemetry drain.

Parameters:

  • telemetry_drain_id: —

    unique identifier of telemetry drain



3576
3577
3578
 
# File 'lib/platform-api/client.rb', line 3576

def info(telemetry_drain_id)
  @client.telemetry_drain.info(telemetry_drain_id)
end

#list_by_app(app_id_or_app_name) ⇒ Object

List telemetry drains for an app.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



3547
3548
3549
 
# File 'lib/platform-api/client.rb', line 3547

def list_by_app(app_id_or_app_name)
  @client.telemetry_drain.list_by_app(app_id_or_app_name)
end

#list_by_space(space_id_or_space_name) ⇒ Object

List telemetry drains for a space.

Parameters:

  • space_id_or_space_name: —

    unique identifier of space or unique name of space



3554
3555
3556
 
# File 'lib/platform-api/client.rb', line 3554

def list_by_space(space_id_or_space_name)
  @client.telemetry_drain.list_by_space(space_id_or_space_name)
end

#update(telemetry_drain_id, body = {}) ⇒ Object

Update a telemetry drain.

Parameters:

  • telemetry_drain_id: —

    unique identifier of telemetry drain

  • body: —

    the object to pass as the request payload



3562
3563
3564
 
# File 'lib/platform-api/client.rb', line 3562

def update(telemetry_drain_id, body = {})
  @client.telemetry_drain.update(telemetry_drain_id, body)
end