PryIn

PryIn is a performance metrics platform for your Phoenix application.

Installation

1. Sign up for a PryIn account and create a new project there.
2. Add pryin to your dependencies in mix.exs:

def deps do
  [
    {:pryin, "~> 1.0"}
  ]
end

3. If you define an applications list in your mix.exs, add :pryin there, too:

def applications do
  [..., :pryin]
end

4. Add general configuration for the pryin app in config/config.exs:

config :pryin,
  otp_app: :my_app,
  api_key: "your_secret_api_key",
  enabled: false,
  env: :dev

config :my_app, MyApp.Repo,
  loggers: [PryIn.EctoLogger, Ecto.LogEntry]

config :my_app, MyApp.Endpoint,
  instrumenters: [PryIn.Instrumenter]

5. Enable PryIn in the environments you want to collect metrics for. If you want to collect data for the production environment, for example, add the following to config/prod.exs:

config :pryin,
  enabled: true,
  env: :prod

Possible values for env are :dev, :staging or :prod.

6. Add the PryIn plug to your application's endpoint (lib/my_app/endpoint.ex) just before the router plug:

...
plug PryIn.Plug
plug MyApp.Router

7. To collect data about Ecto queries, view renderings or custom instrumentation in your channel joins, you need to join the transport's trace first:

def join("rooms:lobby", message, socket) do
  PryIn.join_trace(socket.transport_pid, self())
  Repo.all(...)
  ...

This is only neccessary in your channel join functions, because the channel process does not exist yet when tracing starts.

Configuration

Above steps will give you a basic installation with standard configuration. If you want to tweak some settings, here are all the possible configuration options:

Further reading

You can find more details (about background jobs, custom instrumentation, and a lot more), in PryIn's FAQs.