Broadway Dashboard 使用教程

1. 项目的目录结构及介绍

Broadway Dashboard 是一个用于分析 Broadway 管道的工具，它提供了关于性能和错误的洞察。以下是项目的目录结构及其介绍：

broadway_dashboard/
├── github/workflows/
│   └── config/
├── lib/
│   └── broadway_dashboard/
├── priv/static/
│   └── assets/
├── test/
│   └── broadway_dashboard/
├── .formatter.exs
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── dev.exs
├── mix.exs
├── mix.lock

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• lib/broadway_dashboard/: 包含 Broadway Dashboard 的主要代码。
• priv/static/assets/: 包含静态资源文件。
• test/broadway_dashboard/: 包含测试代码。
• .formatter.exs: 代码格式化配置文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• dev.exs: 开发环境配置文件。
• mix.exs: 项目依赖和配置文件。
• mix.lock: 依赖锁定文件。

2. 项目的启动文件介绍

Broadway Dashboard 的启动文件主要是 mix.exs 和 dev.exs。

mix.exs

mix.exs 文件是 Elixir 项目的配置文件，包含了项目的依赖、版本、应用程序配置等信息。以下是 mix.exs 文件的主要内容：

defmodule BroadwayDashboard.MixProject do
  use Mix.Project

  def project do
    [
      app: :broadway_dashboard,
      version: "0.4.1",
      elixir: "~> 1.10",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      description: description(),
      package: package(),
      source_url: "https://github.com/dashbitco/broadway_dashboard"
    ]
  end

  def application do
    [
      extra_applications: [:logger]
    ]
  end

  defp deps do
    [
      {:broadway, "~> 1.0"},
      {:phoenix_live_dashboard, "~> 0.8.0"}
    ]
  end

  defp description do
    "A Phoenix LiveDashboard page for inspecting your Broadway pipelines"
  end

  defp package do
    [
      licenses: ["Apache-2.0"],
      links: %{"GitHub" => "https://github.com/dashbitco/broadway_dashboard"}
    ]
  end
end

dev.exs

dev.exs 文件是开发环境的配置文件，用于启动开发服务器和示例管道。以下是 dev.exs 文件的主要内容：

import Config

config :broadway_dashboard, BroadwayDashboard.Endpoint,
  http: [port: 4000],
  debug_errors: true,
  code_reloader: true,
  check_origin: false,
  watchers: []

config :broadway_dashboard, BroadwayDashboard.Broadway,
  name: MyBroadway,
  producer: [
    module: {Broadway.DummyProducer, []},
    concurrency: 1
  ],
  processors: [
    default: [
      concurrency: 10
    ]
  ],
  batchers: [
    default: [
      batch_size: 10,
      batch_timeout: 1000,
      concurrency: 5
    ]
  ]

3. 项目的配置文件介绍

Broadway Dashboard 的配置文件主要是 mix.exs 和 dev.exs。

mix.exs

mix.exs 文件包含了项目的依赖、版本、应用程序配置等信息。具体内容如上所述。

dev.exs

dev.exs 文件是开发环境的配置文件，用于启动开发服务器和示例管道。