Membrane RTC Engine TimescaleDB plugin
v0.2.0

View Source Membrane.RTC.Engine.TimescaleDB.Cleaner (Membrane RTC Engine TimescaleDB plugin v0.2.0)

Worker responsible for deleting obsolete records from the database. By default started under the application's supervision tree with params passed in :membreane_rtc_engine_timescaledb config (params passed in config, used to start worker, are these same, as expected by start/1 and start_link/1) start/1 and start_link/1 functions expect a keyword list as an argument, with the following keys:

  • :repo (required) is a module, that uses Ecto.Repo
  • :cleanup_interval (default: 1 hour) is the number of seconds between database cleanups
  • :metrics_lifetime (default: 24 hours) is the number of seconds that must pass from creation before each metric can be deleted during cleanup The keyword may also include GenServer options, see GenServer.option/0 for reference.

Link to this section Summary

Types

cleaner()
option()
options()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

start(options \\ [])
start_link(options \\ [])

Link to this section Types

Link to this type

cleaner()

View Source 
@type cleaner() :: pid() | atom()
Link to this type

option()

View Source 
@type option() ::
  GenServer.option()
  | {:cleanup_interval, pos_integer()}
  | {:metrics_lifetime, pos_integer()}
  | {:repo, module()}
Link to this type

options()

View Source 
@type options() :: [option()]

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

start(options \\ [])

View Source 
@spec start(options()) :: GenServer.on_start()
Link to this function

start_link(options \\ [])

View Source 
@spec start_link(options()) :: GenServer.on_start()