membraneframeworklabs/membrane_dashboard repository overview

⁠Membrane Dashboard

This repository contains a dashboard for monitoring Membrane's pipelines.

It uses membrane_timescaledb_reporter for obtaining information about pipelines states.

For now it supports:

• displaying dependency diagram of pipeline's elements for given time range
• charts for monitoring metrics with live update

It is part of Membrane Multimedia Framework⁠.

⁠Usage

Membrane dashboard is a simple Phoenix application utilizing live view components.

First install dependencies:

mix deps.get
npm ci --prefix ./assets

To run the application you need to provide a few necessary environment variables:

• for timescaleDB configuration (used by Ecto.Repo):
  • DB_USER - username
  • DB_PASS - password
  • DB_NAME - database
  • DB_HOST - hostname
• server host:
  • HOST - hostname to access the application

You can also pass one optional environment variable:

• PORT - port at which the application will be available

Running example:

DB_USER=postgres DB_PASS=postgres DB_NAME=membrane_timescaledb_reporter DB_HOST=localhost HOST=localhost mix phx.server

Application uses port 8000 by default. If HOST=localhost, dashboard will be available at address http://localhost:8000.

⁠Copyright and License

Copyright 2021, Software Mansion⁠

Licensed under the Apache License, Version 2.0⁠