Add new_relic support

Author: VitorTrin

.circleci/config.yml

@@ -1,26 +1,25 @@
-version: 2
+version: 2.1
+
 jobs:
   build:
     docker:
       - image: elixir:1.8.2-alpine
-        name: app  
+        name: app
         environment:
-            MIX_ENV: test
-            DATABASE_USER: user
-            DATABASE_PASSWORD: pass
-            DATABASE_PORT: 5432
-            DATABASE_HOST: db
-            DATABASE_NAME: ecto_job_scheduler_test
-            DATABASE_POOL_SIZE: 5
-        depends_on:
-          - db
+          MIX_ENV: test
+          DATABASE_USER: user
+          DATABASE_PASSWORD: pass
+          DATABASE_PORT: "5432"
+          DATABASE_HOST: db
+          DATABASE_NAME: ecto_job_scheduler_test
+          DATABASE_POOL_SIZE: "5"
       - image: postgres:9.6-alpine
         name: db
         environment:
           POSTGRES_USER: user
           POSTGRES_PASSWORD: pass
           POSTGRES_DB: ecto_job_scheduler_test
-   
+
     working_directory: ~/app
 
     steps:
@@ -29,20 +28,31 @@ jobs:
       - run: mix do deps.get, compile --warnings-as-errors
       - run: mix format --check-formatted
       - run: mix credo --strict
+      - run: sh -c 'while true; do nc -z db 5432; if [[ "$?" == 0 ]]; then break; fi; sleep 1; done'
       - run: mix do ecto.create, ecto.migrate
       - run: mix coveralls.html
+      - restore_cache:
+          keys:
+            - plt-cache-{{ checksum "mix.lock" }}-{{ .Branch }}
+            - plt-cache-{{ checksum "mix.lock" }}
       - run: MIX_ENV=dev mix dialyzer --plt
+      - save_cache:
+          key: plt-cache-{{ checksum "mix.lock" }}-{{ .Branch }}
+          paths:
+            - _dialyzer/ecto-job-scheduler.plt
+      - save_cache:
+          key: plt-cache-{{ checksum "mix.lock" }}
+          paths:
+            - _dialyzer/ecto-job-scheduler.plt
+      - run: MIX_ENV=dev mix dialyzer --format short
       - store_artifacts:
           path: cover/
-   
- 
+
 workflows:
   version: 2
   build-and-deploy:
     jobs:
       - build:
           filters:
-            branches:
-              only: /.*/
             tags:
               only: /.*/

.gitignore

@@ -24,5 +24,4 @@ ecto_job_scheduler-*.tar
 .elixir_ls/*
 
 # Dialyzer
-/priv/plts/*.plt
-/priv/plts/*.plt.hash
+_dialyzer/*

CHANGELOG.md

@@ -1,30 +1,38 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [1.1.0]
+
+## Added
+
+- Support for new_relic instrumentation for the jobs
+
 ## [1.0.2] - 2020-02-18
 
-###  Fixes
+### Fixes
 
 - Perform result
 
 ## [1.0.1] - 2020-02-11
 
-###  Fixes
+### Fixes
 
 - Allow MFA tuple to be given sanitizer config
 
 ## [1.0.0] - 2020-01-22
 
-###  Added
+### Added
 
 - Added support for ecto_job 3
 
-[Unreleased]: https://github.com/rai200890/ecto-job-scheduler/compare/v1.0.2...HEAD
+[Unreleased]: https://github.com/rai200890/ecto-job-scheduler/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/rai200890/ecto-job-scheduler/compare/v1.0.2...1.1.0
 [1.0.2]: https://github.com/rai200890/ecto-job-scheduler/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/rai200890/ecto-job-scheduler/compare/v1.0.0...v1.0.1
-[1.0.0]: https://github.com/rai200890/ecto-job-scheduler/compare/v0.7.0...v1.0.0
+[1.0.0]: https://github.com/rai200890/ecto-job-scheduler/compare/v0.7.0...v1.0.0

README.md

@@ -6,7 +6,7 @@
 
 Helpers for scheduling Jobs defined in [EctoJob](https://github.com/mbuhot/ecto_job)
 
-Thanks [joaothallis](https://github.com/joaothallis), [ramondelemos](https://github.com/ramondelemos), [victorprs](https://github.com/victorprs) 
+Thanks [joaothallis](https://github.com/joaothallis), [ramondelemos](https://github.com/ramondelemos), [victorprs](https://github.com/victorprs)
 
 ## Installation
 
@@ -59,6 +59,20 @@ defmodule MyApplication.MyJobQueue do
 end
 ```
 
+If you want new_relic instrumentation in your jobs, add new_relic_agent to the deps and
+
+```elixir
+defmodule MyApplication.MyJobQueue do
+  @moduledoc false
+  use EctoJobScheduler.JobQueue,
+    table_name: "test_jobs",
+    jobs: [
+      MyApplication.MyJob
+    ],
+    instrumenter: :new_relic
+end
+```
+
 ### Define scheduler module for job queue
 
 ```elixir
@@ -92,4 +106,4 @@ config :my_application, MyApplication.MyJob, max_attempts: "15"
   multi = Multi.run(:do_my_thing, fn _repo, _changes -> {:ok, :xablau} end)
   multi = MyJobScheduler.schedule(multi, MyJob, %{"input" => "a"})
   result = MyJobScheduler.run(multi)
-```
+```

VERSION

@@ -1 +1 @@
-1.0.4
+1.1.0

config/test.exs

@@ -21,3 +21,7 @@ end
 config :ecto_job_scheduler, sanitizer: sanitize_fun
 
 config :logger, level: :warn
+
+config :ecto_job_scheduler, EctoJobScheduler.NewRelic.JobInstrumenter,
+  transaction: TransactionMock,
+  reporter: ReporterMock

lib/job_queue.ex

@@ -3,21 +3,44 @@ defmodule EctoJobScheduler.JobQueue do
    Defines EctoJob.JobQueue based on defined EctoJobScheduler.Job
   """
 
+  # credo:disable-for-this-file Credo.Check.Refactor.Nesting
+
   defmacro __using__(options \\ []) do
     table_name = options[:table_name]
     jobs = options[:jobs]
+    instrumenter = options[:instrumenter]
 
-    quote bind_quoted: [table_name: table_name, jobs: jobs] do
+    quote bind_quoted: [table_name: table_name, jobs: jobs, instrumenter: instrumenter],
+          location: :keep do
       use EctoJob.JobQueue, table_name: table_name
       require Logger
 
       alias Ecto.Multi
+      alias EctoJobScheduler.NewRelic.JobInstrumenter
 
       Enum.each(jobs, fn job ->
         type = job |> Atom.to_string() |> String.split(".") |> List.last()
 
-        def perform(%Multi{} = multi, %{"type" => unquote(type)} = job_params) do
-          apply(unquote(job), :perform, [multi, job_params])
+        case instrumenter do
+          :new_relic ->
+            def perform(%Multi{} = multi, %{"type" => unquote(type)} = job_params) do
+              case job_params["request_id"] do
+                nil ->
+                  nil
+
+                request_id ->
+                  Logger.metadata(request_id: request_id)
+              end
+
+              JobInstrumenter.transaction("job/#{unquote(type)}", fn ->
+                apply(unquote(job), :perform, [multi, job_params])
+              end)
+            end
+
+          _ ->
+            def perform(%Multi{} = multi, %{"type" => unquote(type)} = job_params) do
+              apply(unquote(job), :perform, [multi, job_params])
+            end
         end
       end)
     end

lib/new_relic/job_instrumenter.ex

@@ -0,0 +1,78 @@
+defmodule EctoJobScheduler.NewRelic.JobInstrumenter do
+  @moduledoc """
+  Tool for capture metrics to NewRelic.
+  """
+
+  @doc """
+  Execute a function and capture metrics to NewRelic from it.
+  The metrics is grouped with name parameter.
+
+  Example of use:
+
+  NewRelic.JobInstrumenter.transaction("job/1", fn ->
+    ...
+  end)
+  """
+  @spec transaction(
+          name :: String.t(),
+          function :: (() -> {:error, term()} | any() | no_return())
+        ) ::
+          term()
+  def transaction(name, function) do
+    start()
+
+    add_attributes(
+      other_transaction_name: name,
+      request_id: get_request_id()
+    )
+
+    case function.() do
+      {:error, reason} ->
+        {:current_stacktrace, stack} = Process.info(self(), :current_stacktrace)
+        fail(:error, reason, stack)
+        complete()
+        {:error, reason}
+
+      result ->
+        complete()
+        result
+    end
+  rescue
+    exception ->
+      fail(exception.__struct__, Exception.message(exception), __STACKTRACE__)
+      complete()
+      reraise exception, __STACKTRACE__
+  end
+
+  defp start do
+    reporter().start()
+  end
+
+  defp add_attributes(attributes) do
+    reporter().add_attributes(attributes)
+  end
+
+  defp fail(kind, reason, stack) do
+    reporter().fail(self(), %{
+      kind: kind,
+      reason: reason,
+      stack: stack
+    })
+  end
+
+  defp complete do
+    transaction().stop_transaction()
+  end
+
+  defp get_request_id do
+    Keyword.get(Logger.metadata(), :request_id)
+  end
+
+  defp reporter,
+    do:
+      Application.get_env(:ecto_job_scheduler, __MODULE__)[:reporter] ||
+        NewRelic.Transaction.Reporter
+
+  defp transaction,
+    do: Application.get_env(:ecto_job_scheduler, __MODULE__)[:transaction] || NewRelic.Transaction
+end

lib/new_relic/reporter.ex

@@ -0,0 +1,11 @@
+defmodule EctoJobScheduler.NewRelic.Reporter do
+  @moduledoc false
+
+  @callback start() :: term()
+
+  @callback add_attributes(keyword()) :: term()
+
+  @callback fail(pid(), map()) :: term()
+
+  @callback complete(pid(), atom()) :: term()
+end

lib/new_relic/transaction.ex

@@ -0,0 +1,5 @@
+defmodule EctoJobScheduler.NewRelic.TransactionBehaviour do
+  @moduledoc false
+
+  @callback stop_transaction() :: :ok
+end