{"id":21564642,"url":"https://github.com/dashbitco/broadway_dashboard","last_synced_at":"2025-05-14T23:07:07.288Z","repository":{"id":46803504,"uuid":"361755973","full_name":"dashbitco/broadway_dashboard","owner":"dashbitco","description":"Keep track of your Broadway pipelines from Phoenix LiveDashboard","archived":false,"fork":false,"pushed_at":"2025-02-12T20:28:58.000Z","size":722,"stargazers_count":232,"open_issues_count":2,"forks_count":17,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-14T12:58:24.393Z","etag":null,"topics":["broadway","dashboard","elixir","phoenix"],"latest_commit_sha":null,"homepage":"https://elixir-broadway.org/","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dashbitco.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-26T13:14:42.000Z","updated_at":"2025-04-13T05:05:33.000Z","dependencies_parsed_at":"2024-12-08T12:00:26.841Z","dependency_job_id":"15b46313-f763-4b4d-ae71-f395965c731b","html_url":"https://github.com/dashbitco/broadway_dashboard","commit_stats":{"total_commits":30,"total_committers":8,"mean_commits":3.75,"dds":"0.30000000000000004","last_synced_commit":"6f4202715dd460e4c04fec311c0f43ed9b874b16"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dashbitco%2Fbroadway_dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dashbitco%2Fbroadway_dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dashbitco%2Fbroadway_dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dashbitco%2Fbroadway_dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dashbitco","download_url":"https://codeload.github.com/dashbitco/broadway_dashboard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254243362,"owners_count":22038046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["broadway","dashboard","elixir","phoenix"],"created_at":"2024-11-24T10:16:37.741Z","updated_at":"2025-05-14T23:07:02.275Z","avatar_url":"https://github.com/dashbitco.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Broadway Dashboard\n\n[Online documentation](https://hexdocs.pm/broadway_dashboard)\n\n\u003c!-- MDOC !--\u003e\n\n`BroadwayDashboard` is a tool to analyze [`Broadway`](https://hexdocs.pm/broadway)\npipelines. It provides some insights about performance and errors for\nyour running pipelines.\n\nIt works as an additional page for the [`Phoenix LiveDashboard`](https://hexdocs.pm/phoenix_live_dashboard).\n\nYou can inspect pipelines on remote nodes that are not running `BroadwayDashboard` too.\nSee [Distribution](#distribution) for details.\n\n![Broadway Dashboard](https://raw.githubusercontent.com/dashbitco/broadway_dashboard/4da2a5f388a7579d41b63803652796c106b74785/priv/static/broadway-dashboard-01.gif)\n\n## Integration with Phoenix LiveDashboard\n\nYou can add this page to your Phoenix LiveDashboard by adding as a page in\nthe `live_dashboard` macro at your router file.\n\n```elixir\nlive_dashboard \"/dashboard\",\n  additional_pages: [\n    broadway: {BroadwayDashboard, pipelines: [MyBroadway]}\n  ]\n```\n\nThe `:pipelines` option accept pipeline names (the `:name` option of your Broadway).\nBy omitting the `:pipelines` option, `BroadwayDashboard` will try to autodiscover your pipelines.\n\n```elixir\nlive_dashboard \"/dashboard\",\n  additional_pages: [\n    broadway: BroadwayDashboard\n  ]\n```\n\nOnce configured, you will be able to access the `BroadwayDashboard` at `/dashboard/broadway`.\n\n## Using from the command line with PLDS\n\nIt's possible to use Broadway Dashboard without having to install it on your application.\nPLDS stands for Phoenix LiveDashboard Standalone and it's a CLI version of Phoenix LiveDashboard with\nsome tools pre-installed. One of those tools is Broadway Dashboard.\n\nTo install PLDS on your machine, you can run:\n\n```\n$ mix escript.install hex plds\n```\n\nThen connect to your running node with:\n\n```\n$ plds server --connect mynode --open\n```\n\nFor more information about the usage, please check the [PLDS documentation](https://hexdocs.pm/plds).\n\n## Distribution\n\n**Phoenix LiveDashboard** works with distribution out of the box, and it's not different\nwith **Broadway Dashboard**! You can inspect your pipelines that are running on connected nodes.\n\nYou can also inspect pipelines from nodes that are not running the same system of\nyour dashboard. This is possible because we \"copy\" the essential parts of this\ntool to the remote node when it's not running `BroadwayDashboard`. We stop the tracking\nonce the node that started it is disconnected.\n\n\u003c!-- MDOC !--\u003e\n\n## Installation\n\nAdd the following to your `mix.exs` and run mix `deps.get`:\n\n```elixir\ndef deps do\n  [\n    {:broadway_dashboard, \"~\u003e 0.4.0\"}\n  ]\nend\n```\n\nAfter that, proceed with instructions described in **Integration with Phoenix LiveDashboard** above.\n\n## Acknowledgment\n\nThis project is based on [Marlus Saraiva's](https://github.com/msaraiva/) work from\n[his presentation at ElixirConf 2019](https://www.youtube.com/watch?v=tPu-P97-cbE).\n\nIn that talk he presented a graph showing the work of a Broadway pipeline, which is\nessentially the same we display in this project.\nThank you, Marlus! \u003c3\n\n## Development\n\nAfter cloning this project, you can use the following command to run a development server with a\nsample pipeline:\n\n    $ mix dev\n\nThis is going to start a server running Phoenix LiveDashboard.\n\nUse `mix test` to run the test suite.\n\n## License\n\nCopyright 2021 Dashbit\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdashbitco%2Fbroadway_dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdashbitco%2Fbroadway_dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdashbitco%2Fbroadway_dashboard/lists"}