https://github.com/zachallaun/req_telemetry

Req plugin to instrument requests with Telemetry events
https://github.com/zachallaun/req_telemetry

Last synced: 12 days ago
JSON representation

Req plugin to instrument requests with Telemetry events

• Host: GitHub
• URL: https://github.com/zachallaun/req_telemetry
• Owner: zachallaun
• Created: 2022-10-27T16:47:28.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-10T14:44:21.000Z (4 months ago)
• Last Synced: 2024-10-11T19:20:03.718Z (27 days ago)
• Language: Elixir
• Size: 37.1 KB
• Stars: 13
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
[![Hex.pm](https://img.shields.io/hexpm/v/req_telemetry)](https://hex.pm/packages/req_telemetry)

[![HexDocs.pm](https://img.shields.io/badge/hex.pm-docs-8e7ce6.svg)](https://hexdocs.pm/req_telemetry)

[![CI](https://github.com/zachallaun/req_telemetry/actions/workflows/ci.yml/badge.svg)](https://github.com/zachallaun/req_telemetry/actions/workflows/ci.yml)

[`Req`](https://hexdocs.pm/req) plugin to instrument requests with `:telemetry` events.

## Usage

Preferably, `ReqTelemetry` should be the last plugin attached to your `%Req.Request{}`. This

allows `ReqTelemetry` to emit events both at the very start and very end of the request and

response pipelines. In this way, you can observe both the total time spent issuing and

processing the request and response, as well as the time spent only with the request adapter.

```elixir

req = Req.new() |> ReqTelemetry.attach()

req =

  Req.new(adapter: &my_adapter/1)

  |> ReqSomeOtherThing.attach()

  |> ReqTelemetry.attach()

```

## Events

`ReqTelemetry` produces the following events (in order of event dispatch):

  * `[:req, :request, :pipeline, :start]`

  * `[:req, :request, :adapter, :start]`

  * `[:req, :request, :adapter, :stop]`

  * `[:req, :request, :adapter, :error]`

  * `[:req, :request, :pipeline, :stop]`

  * `[:req, :request, :pipeline, :error]`

You can configure `ReqTelemetry` to produce only `:pipeline` or `:adapter` events; see

`ReqTelemetry.attach/2` for options.

## Logging

`ReqTelemetry` defines a a simple, default logger that logs basic request information and timing.

Here's how a successful request might be logged:

    Req:479128347 - GET https://example.org (pipeline)

    Req:479128347 - GET https://example.org (adapter)

    Req:479128347 - 200 in 403ms (adapter)

    Req:479128347 - 200 in 413ms (pipeline)

For usage and configuration, see `ReqTelemetry.attach_default_logger/1`.

## Installation

`req_telemetry` is available through [hex.pm](https://hex.pm/packages/req_telemetry), and can be

installed by adding the following to your list of dependencies:

```elixir

def deps do

  [

    {:req_telemetry, "~> 0.1.0"}

  ]

end

```