Merge pull request #157 from cedricgarcia-wttj/feat-add-telemetry-support

feat: add :telemetry support with HTTP client events

Author: klacointe

README.md

@@ -106,6 +106,27 @@ fields can be accessed in the `resources` field of the structure.
   }
 ```
 
+### Telemetry Integration
+
+Chargebeex now supports `:telemetry`, allowing users to instrument and monitor API calls using telemetry events. This enables integration with various observability tools.
+
+#### Telemetry Events
+
+Chargebeex emits the following telemetry events for each API request:
+
+- `[:chargebeex, :request, :start]`: Emitted when an API request starts.
+- `[:chargebeex, :request, :stop]`: Emitted when an API request completes.
+
+When making API calls, telemetry events will automatically be emitted:
+
+```elixir
+Chargebeex.Client.get("/customers")
+```
+
+This will emit :start and :stop telemetry events with metadata such as the HTTP method, URL, and status code, which can be processed by your telemetry handler.
+
+For more information on `:telemetry`, visit the [official documentation](https://hexdocs.pm/telemetry/).
+
 ## Run tests
 
 ```sh

lib/chargebeex/client.ex

@@ -46,35 +46,45 @@ defmodule Chargebeex.Client do
 
   def get(path, params \\ %{}, opts \\ []) do
     site = Keyword.get(opts, :site, :default)
-
     url = endpoint(site, path, params)
 
-    case apply(http_client(), :get, [url, "", default_headers(site, opts)]) do
-      {:ok, status_code, headers, body} when status_code in 200..299 ->
-        {:ok, status_code, headers, get_body_from_response(body)}
+    :telemetry.span([:chargebeex, :request], %{method: :get, url: url, params: params}, fn ->
+      {status, status_code, _, _} =
+        result =
+        case apply(http_client(), :get, [url, "", default_headers(site, opts)]) do
+          {:ok, status_code, headers, body} when status_code in 200..299 ->
+            {:ok, status_code, headers, get_body_from_response(body)}
 
-      {:ok, status_code, headers, body} ->
-        {:error, status_code, headers, get_body_from_response(body)}
-    end
+          {:ok, status_code, headers, body} ->
+            {:error, status_code, headers, get_body_from_response(body)}
+        end
+
+      {result, %{status: status, status_code: status_code}}
+    end)
   end
 
   def post(path, params \\ %{}, opts \\ []) do
     site = Keyword.get(opts, :site, :default)
+    url = endpoint(site, path)
 
     body =
       params
       |> transform_arrays_for_chargebee
       |> Plug.Conn.Query.encode()
 
-    url = endpoint(site, path)
+    :telemetry.span([:chargebeex, :request], %{method: :post, url: url, params: params}, fn ->
+      {status, status_code, _, _} =
+        result =
+        case apply(http_client(), :post, [url, body, default_headers(site, opts, :post)]) do
+          {:ok, status_code, headers, body} when status_code in 200..299 ->
+            {:ok, status_code, headers, get_body_from_response(body)}
 
-    case apply(http_client(), :post, [url, body, default_headers(site, opts, :post)]) do
-      {:ok, status_code, headers, body} when status_code in 200..299 ->
-        {:ok, status_code, headers, get_body_from_response(body)}
+          {:ok, status_code, headers, body} ->
+            {:error, status_code, headers, get_body_from_response(body)}
+        end
 
-      {:ok, status_code, headers, body} ->
-        {:error, status_code, headers, get_body_from_response(body)}
-    end
+      {result, %{status: status, status_code: status_code}}
+    end)
   end
 
   defp get_body_from_response(body) do

mix.exs

@@ -54,7 +54,8 @@ defmodule Chargebeex.MixProject do
       {:credo, "~> 1.6", only: [:dev, :test], runtime: false},
       {:typed_struct, "~> 0.3.0"},
       {:dialyxir, ">= 0.0.0", only: [:dev], runtime: false},
-      {:exconstructor, "~> 1.2.7"}
+      {:exconstructor, "~> 1.2.7"},
+      {:telemetry, "~> 1.3"}
     ]
   end