Compare commits
6 Commits
e586a29e75
...
076b41eadd
Author | SHA1 | Date | |
---|---|---|---|
|
076b41eadd | ||
|
2e5373ae3f | ||
|
5334fff7a2 | ||
|
060ade05eb | ||
|
168ca704cd | ||
39419f8837 |
49
.drone.yml
49
.drone.yml
@@ -5,7 +5,6 @@ name: test
|
||||
|
||||
trigger:
|
||||
event:
|
||||
- push
|
||||
- pull_request
|
||||
|
||||
steps:
|
||||
@@ -17,6 +16,26 @@ steps:
|
||||
PGHOST: db
|
||||
commands:
|
||||
- while ! pg_isready; do sleep 1; done
|
||||
|
||||
- name: restore cache
|
||||
image: 'meltwater/drone-cache:v1.3.0'
|
||||
environment:
|
||||
AWS_ACCESS_KEY_ID:
|
||||
from_secret: minio_user
|
||||
AWS_SECRET_ACCESS_KEY:
|
||||
from_secret: minio_password
|
||||
settings:
|
||||
archive_format: gzip
|
||||
bucket: trainlog-cache
|
||||
cache_key: '{{ .Repo.Name }}-{{ checksum "mix.lock" }}'
|
||||
endpoint: minio:9000
|
||||
mount:
|
||||
- _build
|
||||
- deps
|
||||
path_style: true
|
||||
region: us-east-1
|
||||
restore: true
|
||||
|
||||
- name: test
|
||||
image: 'elixir:1.13.4'
|
||||
environment:
|
||||
@@ -26,7 +45,33 @@ steps:
|
||||
POSTGRES_PASS: postgres
|
||||
commands:
|
||||
- mix do local.rebar --force, local.hex --force, deps.get, deps.compile
|
||||
- mix test --cover --trace --slowest 10
|
||||
- make test
|
||||
|
||||
- name: lint
|
||||
image: 'elixir:1.13.4'
|
||||
commands:
|
||||
- mix do local.rebar --force, local.hex --force, deps.get, deps.compile
|
||||
- make static_code_analysis
|
||||
|
||||
- name: rebuild cache
|
||||
image: 'meltwater/drone-cache:v1.3.0'
|
||||
environment:
|
||||
AWS_ACCESS_KEY_ID:
|
||||
from_secret: minio_user
|
||||
AWS_SECRET_ACCESS_KEY:
|
||||
from_secret: minio_password
|
||||
settings:
|
||||
archive_format: gzip
|
||||
bucket: trainlog-cache
|
||||
cache_key: '{{ .Repo.Name }}-{{ checksum "mix.lock" }}'
|
||||
endpoint: minio:9000
|
||||
exit_code: true
|
||||
mount:
|
||||
- _build
|
||||
- deps
|
||||
path_style: true
|
||||
rebuild: true
|
||||
region: us-east-1
|
||||
|
||||
services:
|
||||
- name: db
|
||||
|
142
.github/workflows/ci.yml
vendored
142
.github/workflows/ci.yml
vendored
@@ -1,142 +0,0 @@
|
||||
---
|
||||
# based on:
|
||||
# 1. https://dev.to/mnishiguchi/basic-github-actions-setup-for-phoenix-apps-m3g
|
||||
# 2. https://www.jonathanyeong.com/garden/how-to-setup-ci-with-phoenix-github-actions/
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
brances: [main]
|
||||
|
||||
env:
|
||||
MIX_ENV: test
|
||||
|
||||
jobs:
|
||||
dependencies:
|
||||
runs-on: ubuntu-20.04
|
||||
strategy:
|
||||
matrix:
|
||||
elixir: ['1.12.1']
|
||||
otp: ['24.0.2']
|
||||
steps:
|
||||
- name: cancel previous execution
|
||||
uses: styfle/cancel-workflow-action@0.9.0
|
||||
with:
|
||||
access_token: ${{ github.token }}
|
||||
- name: checkout repo
|
||||
uses: actions/checkout@v2
|
||||
- name: setup erlang/elixir
|
||||
uses: erlef/setup-beam@v1
|
||||
with:
|
||||
elixir-version: ${{ matrix.elixir }}
|
||||
otp-version: ${{ matrix.otp }}
|
||||
- name: fecth cached dependencies
|
||||
uses: actions/cache@v2
|
||||
id: mix-cache
|
||||
with:
|
||||
path: |
|
||||
deps
|
||||
_build
|
||||
priv/plts
|
||||
key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles('mix.lock') }}
|
||||
- name: install dependencies
|
||||
if: steps.mix-cache.outputs.cache-hit != 'true'
|
||||
run: |
|
||||
mkdir -p priv/plts
|
||||
mix local.rebar --force
|
||||
mix local.hex --force
|
||||
mix deps.get
|
||||
mix deps.compile
|
||||
mix dialyzer --plt
|
||||
static-code-analysis:
|
||||
needs: dependencies
|
||||
runs-on: ubuntu-20.04
|
||||
strategy:
|
||||
matrix:
|
||||
elixir: ['1.12.1']
|
||||
otp: ['24.0.2']
|
||||
steps:
|
||||
- name: cancel previous execution
|
||||
uses: styfle/cancel-workflow-action@0.9.0
|
||||
with:
|
||||
access_token: ${{ github.token }}
|
||||
- name: checkout repo
|
||||
uses: actions/checkout@v2
|
||||
- name: setup erlang/elixir
|
||||
uses: erlef/setup-beam@v1
|
||||
with:
|
||||
elixir-version: ${{ matrix.elixir }}
|
||||
otp-version: ${{ matrix.otp }}
|
||||
- name: fecth cached dependencies
|
||||
uses: actions/cache@v2
|
||||
id: mix-cache
|
||||
with:
|
||||
path: |
|
||||
deps
|
||||
_build
|
||||
priv/plts
|
||||
key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles('mix.lock') }}
|
||||
- run: mix format --check-formatted
|
||||
- name: credo analysis
|
||||
uses: red-shirts/reviewdog-action-credo@v1
|
||||
with:
|
||||
github_token: ${{ secrets.github_token }}
|
||||
reporter: github-pr-review
|
||||
- run: mix dialyzer --no-check --quiet --ignore-exit-status --format short
|
||||
test:
|
||||
needs: dependencies
|
||||
runs-on: ubuntu-20.04
|
||||
strategy:
|
||||
matrix:
|
||||
elixir: ['1.12.1']
|
||||
otp: ['24.0.2']
|
||||
services:
|
||||
db:
|
||||
image: 'postgres:13.3-alpine'
|
||||
ports:
|
||||
- '5432:5432'
|
||||
env:
|
||||
POSTGRES_USER: postgres
|
||||
POSTGRES_PASSWORD: postgres
|
||||
options: >-
|
||||
--health-cmd pg_isready
|
||||
--health-interval 10s
|
||||
--health-timeout 5s
|
||||
--health-retries 5
|
||||
steps:
|
||||
- name: cancel previous execution
|
||||
uses: styfle/cancel-workflow-action@0.9.0
|
||||
with:
|
||||
access_token: ${{ github.token }}
|
||||
- name: checkout repo
|
||||
uses: actions/checkout@v2
|
||||
- name: setup erlang/elixir
|
||||
uses: erlef/setup-beam@v1
|
||||
with:
|
||||
elixir-version: ${{ matrix.elixir }}
|
||||
otp-version: ${{ matrix.otp }}
|
||||
- name: fecth cached dependencies
|
||||
uses: actions/cache@v2
|
||||
id: mix-cache
|
||||
with:
|
||||
path: |
|
||||
deps
|
||||
_build
|
||||
priv/plts
|
||||
key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles('mix.lock') }}
|
||||
- run: mix test --cover --trace --slowest 10
|
||||
env:
|
||||
POSTGRES_USER: postgres
|
||||
POSTGRES_PASS: postgres
|
||||
- name: publish test results
|
||||
uses: EnricoMi/publish-unit-test-result-action/composite@v1
|
||||
if: always()
|
||||
with:
|
||||
files: 'report/test/*.xml'
|
||||
- name: publish coverage report
|
||||
uses: romeovs/lcov-reporter-action@v0.2.16
|
||||
if: always()
|
||||
with:
|
||||
lcov-file: 'cover/lcov.info'
|
@@ -14,6 +14,13 @@ config :wabanex, Wabanex.Repo,
|
||||
migration_primary_key: [type: :binary_id],
|
||||
migration_foreign_key: [type: :binary_id]
|
||||
|
||||
config :wabanex, Wabanex.PromEx,
|
||||
disabled: false,
|
||||
manual_metrics_start_delay: :no_delay,
|
||||
drop_metrics_groups: [],
|
||||
grafana: :disabled,
|
||||
metrics_server: :disabled
|
||||
|
||||
# Configures the endpoint
|
||||
config :wabanex, WabanexWeb.Endpoint,
|
||||
url: [host: "localhost"],
|
||||
|
@@ -32,21 +32,6 @@ services:
|
||||
working_dir: /opt/app
|
||||
entrypoint: sleep
|
||||
command: infinity
|
||||
pgcli:
|
||||
image: 'joaodubas/pgcli:latest'
|
||||
hostname: development
|
||||
depends_on:
|
||||
- db
|
||||
environment:
|
||||
PGUSER: *db_user
|
||||
PGPASSWORD: *db_pass
|
||||
PGHOST: *db_host
|
||||
PGDATABASE: wabanex_dev
|
||||
volumes:
|
||||
- './priv/docker/pgcli:/root/.config/pgcli'
|
||||
restart: unless-stopped
|
||||
entrypoint: sleep
|
||||
command: 3650d
|
||||
|
||||
volumes:
|
||||
db_data: {}
|
||||
|
@@ -7,6 +7,8 @@ defmodule Wabanex.Application do
|
||||
|
||||
def start(_type, _args) do
|
||||
children = [
|
||||
# Start the PromEx supervisor
|
||||
Wabanex.PromEx,
|
||||
# Start the Ecto repository
|
||||
Wabanex.Repo,
|
||||
# Start the Telemetry supervisor
|
||||
|
102
lib/wabanex/prom_ex.ex
Normal file
102
lib/wabanex/prom_ex.ex
Normal file
@@ -0,0 +1,102 @@
|
||||
defmodule Wabanex.PromEx do
|
||||
@moduledoc """
|
||||
Be sure to add the following to finish setting up PromEx:
|
||||
|
||||
1. Update your configuration (config.exs, dev.exs, prod.exs, releases.exs, etc) to
|
||||
configure the necessary bit of PromEx. Be sure to check out `PromEx.Config` for
|
||||
more details regarding configuring PromEx:
|
||||
```
|
||||
config :wabanex, Wabanex.PromEx,
|
||||
disabled: false,
|
||||
manual_metrics_start_delay: :no_delay,
|
||||
drop_metrics_groups: [],
|
||||
grafana: :disabled,
|
||||
metrics_server: :disabled
|
||||
```
|
||||
|
||||
2. Add this module to your application supervision tree. It should be one of the first
|
||||
things that is started so that no Telemetry events are missed. For example, if PromEx
|
||||
is started after your Repo module, you will miss Ecto's init events and the dashboards
|
||||
will be missing some data points:
|
||||
```
|
||||
def start(_type, _args) do
|
||||
children = [
|
||||
Wabanex.PromEx,
|
||||
|
||||
...
|
||||
]
|
||||
|
||||
...
|
||||
end
|
||||
```
|
||||
|
||||
3. Update your `endpoint.ex` file to expose your metrics (or configure a standalone
|
||||
server using the `:metrics_server` config options). Be sure to put this plug before
|
||||
your `Plug.Telemetry` entry so that you can avoid having calls to your `/metrics`
|
||||
endpoint create their own metrics and logs which can pollute your logs/metrics given
|
||||
that Prometheus will scrape at a regular interval and that can get noisy:
|
||||
```
|
||||
defmodule WabanexWeb.Endpoint do
|
||||
use Phoenix.Endpoint, otp_app: :wabanex
|
||||
|
||||
...
|
||||
|
||||
plug PromEx.Plug, prom_ex_module: Wabanex.PromEx
|
||||
|
||||
...
|
||||
end
|
||||
```
|
||||
|
||||
4. Update the list of plugins in the `plugins/0` function return list to reflect your
|
||||
application's dependencies. Also update the list of dashboards that are to be uploaded
|
||||
to Grafana in the `dashboards/0` function.
|
||||
"""
|
||||
|
||||
use PromEx, otp_app: :wabanex
|
||||
|
||||
alias PromEx.Plugins
|
||||
|
||||
@impl true
|
||||
def plugins do
|
||||
[
|
||||
# PromEx built in plugins
|
||||
Plugins.Application,
|
||||
Plugins.Beam,
|
||||
# {Plugins.Phoenix, router: WabanexWeb.Router, endpoint: WabanexWeb.Endpoint},
|
||||
Plugins.Ecto,
|
||||
# Plugins.Oban,
|
||||
# Plugins.PhoenixLiveView,
|
||||
Plugins.Absinthe
|
||||
# Plugins.Broadway,
|
||||
|
||||
# Add your own PromEx metrics plugins
|
||||
# Wabanex.Users.PromExPlugin
|
||||
]
|
||||
end
|
||||
|
||||
@impl true
|
||||
def dashboard_assigns do
|
||||
[
|
||||
datasource_id: "WABANEX_SERVICE",
|
||||
default_selected_interval: "30s"
|
||||
]
|
||||
end
|
||||
|
||||
@impl true
|
||||
def dashboards do
|
||||
[
|
||||
# PromEx built in Grafana dashboards
|
||||
{:prom_ex, "application.json"},
|
||||
{:prom_ex, "beam.json"},
|
||||
# {:prom_ex, "phoenix.json"},
|
||||
{:prom_ex, "ecto.json"},
|
||||
# {:prom_ex, "oban.json"},
|
||||
# {:prom_ex, "phoenix_live_view.json"},
|
||||
{:prom_ex, "absinthe.json"}
|
||||
# {:prom_ex, "broadway.json"},
|
||||
|
||||
# Add your dashboard definitions here with the format: {:otp_app, "path_in_priv"}
|
||||
# {:wabanex, "/grafana_dashboards/user_metrics.json"}
|
||||
]
|
||||
end
|
||||
end
|
@@ -16,6 +16,8 @@ defmodule WabanexWeb.Endpoint do
|
||||
|
||||
socket "/live", Phoenix.LiveView.Socket, websocket: [connect_info: [session: @session_options]]
|
||||
|
||||
plug PromEx.Plug, prom_ex_module: Wabanex.PromEx
|
||||
|
||||
# Serve at "/" the static files from "priv/static" directory.
|
||||
#
|
||||
# You should set gzip to true if you are running phx.digest
|
||||
|
@@ -17,7 +17,7 @@ defmodule WabanexWeb.Schema.Types.Custom.DateRange do
|
||||
end
|
||||
|
||||
@spec serialize_range(PgRanges.DateRange.t()) :: String.t()
|
||||
@spec serialize_range(list(String.t())) :: String.t()
|
||||
@spec serialize_range(list(DateTime.t() | nil)) :: String.t()
|
||||
defp serialize_range(%PgRanges.DateRange{lower: start_range, upper: end_range}),
|
||||
do: serialize_range([start_range, end_range])
|
||||
|
||||
|
1
mix.exs
1
mix.exs
@@ -45,6 +45,7 @@ defmodule Wabanex.MixProject do
|
||||
{:phoenix_live_dashboard, "~> 0.6"},
|
||||
{:plug_cowboy, "~> 2.0"},
|
||||
{:postgrex, ">= 0.0.0"},
|
||||
{:prom_ex, "~> 1.7"},
|
||||
{:telemetry_metrics, "~> 0.6"},
|
||||
{:telemetry_poller, "~> 1.0"}
|
||||
]
|
||||
|
4
mix.lock
4
mix.lock
@@ -39,8 +39,10 @@
|
||||
"plug_cowboy": {:hex, :plug_cowboy, "2.5.2", "62894ccd601cf9597e2c23911ff12798a8a18d237e9739f58a6b04e4988899fe", [:mix], [{:cowboy, "~> 2.7", [hex: :cowboy, repo: "hexpm", optional: false]}, {:cowboy_telemetry, "~> 0.3", [hex: :cowboy_telemetry, repo: "hexpm", optional: false]}, {:plug, "~> 1.7", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm", "ea6e87f774c8608d60c8d34022a7d073bd7680a0a013f049fc62bf35efea1044"},
|
||||
"plug_crypto": {:hex, :plug_crypto, "1.2.2", "05654514ac717ff3a1843204b424477d9e60c143406aa94daf2274fdd280794d", [:mix], [], "hexpm", "87631c7ad914a5a445f0a3809f99b079113ae4ed4b867348dd9eec288cecb6db"},
|
||||
"postgrex": {:hex, :postgrex, "0.16.2", "0f83198d0e73a36e8d716b90f45f3bde75b5eebf4ade4f43fa1f88c90a812f74", [:mix], [{:connection, "~> 1.1", [hex: :connection, repo: "hexpm", optional: false]}, {:db_connection, "~> 2.1", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}], "hexpm", "a9ea589754d9d4d076121090662b7afe155b374897a6550eb288f11d755acfa0"},
|
||||
"prom_ex": {:hex, :prom_ex, "1.7.1", "39331ee3fe6f9a8587d8208bf9274a253bb80281700e127dd18786cda5e08c37", [:mix], [{:absinthe, ">= 1.6.0", [hex: :absinthe, repo: "hexpm", optional: true]}, {:broadway, ">= 1.0.2", [hex: :broadway, repo: "hexpm", optional: true]}, {:ecto, ">= 3.5.0", [hex: :ecto, repo: "hexpm", optional: true]}, {:finch, "~> 0.10.2", [hex: :finch, repo: "hexpm", optional: false]}, {:jason, "~> 1.2", [hex: :jason, repo: "hexpm", optional: false]}, {:oban, ">= 2.4.0", [hex: :oban, repo: "hexpm", optional: true]}, {:phoenix, ">= 1.5.0", [hex: :phoenix, repo: "hexpm", optional: true]}, {:phoenix_live_view, ">= 0.14.0", [hex: :phoenix_live_view, repo: "hexpm", optional: true]}, {:plug, ">= 1.12.1", [hex: :plug, repo: "hexpm", optional: true]}, {:plug_cowboy, "~> 2.5.1", [hex: :plug_cowboy, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.0.0", [hex: :telemetry, repo: "hexpm", optional: false]}, {:telemetry_metrics, "~> 0.6.1", [hex: :telemetry_metrics, repo: "hexpm", optional: false]}, {:telemetry_metrics_prometheus_core, "~> 1.0.2", [hex: :telemetry_metrics_prometheus_core, repo: "hexpm", optional: false]}, {:telemetry_poller, "~> 1.0.0", [hex: :telemetry_poller, repo: "hexpm", optional: false]}], "hexpm", "4c978872b88a929833925a0f4d0561824804c671fdd04581e765509ed0a6ed08"},
|
||||
"ranch": {:hex, :ranch, "1.8.0", "8c7a100a139fd57f17327b6413e4167ac559fbc04ca7448e9be9057311597a1d", [:make, :rebar3], [], "hexpm", "49fbcfd3682fab1f5d109351b61257676da1a2fdbe295904176d5e521a2ddfe5"},
|
||||
"telemetry": {:hex, :telemetry, "1.1.0", "a589817034a27eab11144ad24d5c0f9fab1f58173274b1e9bae7074af9cbee51", [], [], "hexpm", "b727b2a1f75614774cff2d7565b64d0dfa5bd52ba517f16543e6fc7efcc0df48"},
|
||||
"telemetry": {:hex, :telemetry, "1.0.0", "0f453a102cdf13d506b7c0ab158324c337c41f1cc7548f0bc0e130bbf0ae9452", [:rebar3], [], "hexpm", "73bc09fa59b4a0284efb4624335583c528e07ec9ae76aca96ea0673850aec57a"},
|
||||
"telemetry_metrics": {:hex, :telemetry_metrics, "0.6.1", "315d9163a1d4660aedc3fee73f33f1d355dcc76c5c3ab3d59e76e3edf80eef1f", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "7be9e0871c41732c233be71e4be11b96e56177bf15dde64a8ac9ce72ac9834c6"},
|
||||
"telemetry_metrics_prometheus_core": {:hex, :telemetry_metrics_prometheus_core, "1.0.2", "c98b1c580de637bfeac00db41b9fb91fb4c3548ee3d512a8ed7299172312eaf3", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0.0", [hex: :telemetry, repo: "hexpm", optional: false]}, {:telemetry_metrics, "~> 0.6", [hex: :telemetry_metrics, repo: "hexpm", optional: false]}], "hexpm", "48351a0d56f80e38c997b44232b1043e0a081670d16766eee920e6254175b730"},
|
||||
"telemetry_poller": {:hex, :telemetry_poller, "1.0.0", "db91bb424e07f2bb6e73926fcafbfcbcb295f0193e0a00e825e589a0a47e8453", [:rebar3], [{:telemetry, "~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "b3a24eafd66c3f42da30fc3ca7dda1e9d546c12250a2d60d7b81d264fbec4f6e"},
|
||||
}
|
||||
|
Reference in New Issue
Block a user