API Reference Membrane RTC Engine TimescaleDB plugin v0.2.0
modules
Modules
Allows to store Membrane.RTC.Engine
metrics reports in a database.
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
Provides functions facilitating releasing a project, that has a dependency to this library
Migrations creating DB tables required by this library to function.
To execute migrations, run Elixir.Membrane.RTC.Engine.TimescaleDB.Migrations.up(versions: 1..2)
or Elixir.Membrane.RTC.Engine.TimescaleDB.Migrations.up(version: 2)
.
To undo them, run Elixir.Membrane.RTC.Engine.TimescaleDB.Migrations.down(versions: 1..2)
or Elixir.Membrane.RTC.Engine.TimescaleDB.Migrations.down(version: 2)
accordingly.
Currently, the latest migrations version is 2
Suggested way of using functions from this module, is to create a migration module in your own
project and call them there. Remember, that versions passed to down
should match ones passed to
up
. Here's an example
Module responsible for putting data to TimescaleDB.
Model representing a set of peer metrics from Membrane.RTC.Engine
metrics report.
Model representing a set of track metrics from Membrane.RTC.Engine
metrics report.
A worker responsible for storing reports in the database.