StatetraceElixir
Elixir integration for https://www.statetrace.com
Installation
If available in Hex, the package can be installed
by adding statetrace_elixir to your list of dependencies in mix.exs:
def deps do
[
{:statetrace_elixir, "~> 0.1.0"}
]
endAfter the packages are installed you must create a database migration to add the statetrace_annotations table to your database:
mix ecto.gen.migration add_statetrace_annotations_tableOpen the generated migration in your editor and call the up and down functions on StatetraceElixir.Migrations:
defmodule MyApp.Repo.Migrations.AddStatetraceAnnotationsTable do
use Ecto.Migration
def up do
StatetraceElixir.Migrations.up()
end
# We specify `version: 1` in `down`, ensuring that we'll roll all the way back down if
# necessary, regardless of which version we've migrated `up` to.
def down do
StatetraceElixir.Migrations.down(version: 1)
end
endNew versions may require additional migrations, however, migrations will never change between versions and they are always idempotent.
Now, run the migration to create the table:
mix ecto.migrateNext we need to annotate your http requests' transactions. Wrap &action/2 in your controllers in a transaction and annotate it.
Its easiest to add this to <YourProject>Web
defmodule <YourProject>Web do
def controller do
quote do
use Phoenix.Controller, namespace: <YourProject>Web
import Plug.Conn
import <YourProject>Web.Gettext
alias <YourProject>Web.Router.Helpers, as: Routes
defp current_actor(conn) do
conn.assigns.current_user # Should return %{id: String.t | nil, full_name: String.t | nil, avatar: String.t | nil}
end
def action(conn, _) do
args = [conn, conn.params]
with {_, response} <-
<YourProject>.Repo.transaction(fn ->
StatetraceElixir.Annotations.process_conn(conn,
get_actor: ¤t_actor/1,
repo: <YourProject>.Repo
)
apply(__MODULE__, action_name(conn), args)
end) do
response
end
end
end
end
endDocumentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/statetrace_elixir.
