AwsExRay - Ecto Support

NOT STABLE YET

Please wait version 1.0.0 released.

Installation

If available in Hex, the package can be installed by adding aws_ex_ray_ecto to your list of dependencies in mix.exs:

def application do
  [
    extra_applications: [
      :logger,
      :aws_ex_ray
      # ...
    ],
    mod {MyApp.Supervisor, []}
  ]
end

def deps do
  [
    {:aws_ex_ray, "~> 0.1"},
    {:aws_ex_ray_ecto, "~> 0.2.0"},
     # ...
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/aws_ex_ray_ecto.

USAGE

with Ecto >= 3 - Telemetry based instrumenter

In your Application file

defmodule MyApp.Application do
  use Application

  @impl Application
  def start(_type, _opts) do
    ...
    AwsExRay.Ecto.Instrumenter.attach(ecto_app_name)
    ...
  end
end

ecto_app_name can be found in your Repo file as :otp_app value

defmodule MyApp.Repo do
  use Ecto.Repo, otp_app: :my_app, adapter: Ecto.Adapters.MyXQL
end

with Ecto < 3 - Logger based

In your config file, put AwsExRay.Ecto.Logger into Ecto's :loggers setting.

config :my_app, MyApp.EctoRepo,
  adapter: Ecto.Adapters.MySQL,
  hostname: "example.org",
  port:     "3306",
  database: "my_db",
  username: "foo",
  password: "bar",
  loggers:  [Ecto.LogEntry, AwsExRay.Ecto.Logger]

Then automatically record subsegment if queries called on the tracing process.