defmodule PromEx.MixProject do
use Mix.Project
def project do
[
app: :prom_ex,
version: "1.9.0",
elixir: "~> 1.11",
name: "PromEx",
source_url: "https://github.com/akoutmos/prom_ex",
homepage_url: "https://hex.pm/packages/prom_ex",
description: "Prometheus metrics and Grafana dashboards for all of your favorite Elixir libraries",
elixirc_paths: elixirc_paths(Mix.env()),
start_permanent: Mix.env() == :prod,
test_coverage: [tool: ExCoveralls],
preferred_cli_env: [
coveralls: :test,
"coveralls.detail": :test,
"coveralls.post": :test,
"coveralls.html": :test,
"coveralls.github": :test
],
dialyzer: [
plt_add_apps: [
:absinthe,
:broadway,
:ecto,
:mix,
:oban,
:phoenix,
:plug,
:telemetry_metrics
],
plt_file: {:no_warn, "priv/plts/dialyzer.plt"}
],
package: package(),
deps: deps(),
docs: docs(),
aliases: aliases()
]
end
# Run "mix help compile.app" to learn about applications.
def application do
[
extra_applications: [:logger]
]
end
defp elixirc_paths(:test), do: ["lib", "test/support"]
defp elixirc_paths(_), do: ["lib"]
# Run "mix help deps" to learn about dependencies.
defp deps do
[
# Required dependencies
{:jason, "~> 1.2"},
{:finch, "~> 0.15"},
{:telemetry, ">= 1.0.0"},
{:telemetry_poller, "~> 1.0"},
{:telemetry_metrics, "~> 0.6"},
{:telemetry_metrics_prometheus_core, "~> 1.0"},
{:plug_cowboy, "~> 2.5 or ~> 2.6"},
{:octo_fetch, "~> 0.3"},
# Optional dependencies depending on what telemetry events the user is interested in capturing
{:phoenix, ">= 1.5.0", optional: true},
{:phoenix_live_view, ">= 0.14.0", optional: true},
{:plug, ">= 1.12.1", optional: true},
{:ecto, ">= 3.5.0", optional: true},
{:oban, ">= 2.4.0", optional: true},
{:absinthe, ">= 1.6.0", optional: true},
{:broadway, ">= 1.0.2", optional: true},
# PromEx development related dependencies
{:bypass, "~> 2.1", only: :test},
{:ex_doc, "~> 0.28.2", only: :dev},
{:excoveralls, "~> 0.14.4", only: :test, runtime: false},
{:doctor, "~> 0.18.0", only: :dev},
{:credo, "~> 1.6.1", only: :dev},
{:dialyxir, "~> 1.1.0", only: :dev, runtime: false},
{:git_hooks, "~> 0.6.4", only: [:test, :dev], runtime: false}
]
end
defp docs do
[
main: "readme",
source_ref: "master",
logo: "guides/images/logo.svg",
extras: [
"README.md",
"guides/howtos/Writing PromEx Plugins.md",
"guides/howtos/Telemetry.md",
"guides/howtos/Running Multiple Agents.md",
"guides/howtos/Seeding Metrics.md",
"guides/gallery/All.md"
],
groups_for_extras: [
"How-To's": ~r/guides\/howtos\/.?/,
Grafana: ~r/guides\/gallery\/.?/
]
]
end
defp package do
[
name: "prom_ex",
files: ~w(lib priv/grafana_agent priv/*.eex mix.exs README.md LICENSE CHANGELOG.md),
licenses: ["MIT"],
maintainers: ["Alex Koutmos"],
links: %{
"GitHub" => "https://github.com/akoutmos/prom_ex",
"Sponsor" => "https://github.com/sponsors/akoutmos"
}
]
end
defp aliases do
[
docs: [&massage_readme/1, "docs", ©_files/1]
]
end
defp copy_files(_) do
# Set up directory structure
File.mkdir_p!("./doc/guides/images")
# Copy over image files
"./guides/images/"
|> File.ls!()
|> Enum.each(fn image_file ->
File.cp!("./guides/images/#{image_file}", "./doc/guides/images/#{image_file}")
end)
# Clean up previous file massaging
File.rm!("./README.md")
File.rename!("./README.md.orig", "./README.md")
end
defp massage_readme(_) do
hex_docs_friendly_header_content = """