opentelemetry-erlang-contrib/instrumentation/opentelemetry_finch
Tom Taylor 17d31cc594
Improve test matrix and add support for Elixir 1.15 and OTP 26 (#188)
* Use test matrix from file

* Only check formatting on specific Elixir version

* Use latest patch version of each Elixir/OTP release in test matrix

* Test on Elixir 1.15 and OTP 26

* Run formatter on opentelemetry_httpoison

* Run formatter on opentelemetry_phoenix

* Run formatter on opentelemetry_tesla

* Fix building opentelemetry_ecto on Elixir 1.15

Upgraded deps to fix ssl_verify_fun not compiling

* Fix building opentelemetry_dataloader on Elixir 1.15

Upgraded deps to fix ssl_verify_fun and ecto_sql not compiling

* Upgrade opentelemetry_finch to build on Elixir 1.15

* Upgrade opentelemetry_httpoison deps to build on 1.15

* Upgrade opentelemetry_nebulex to build on Elixir 1.15

* Upgrade opentelemetry_oban to build on Elixir 1.15

* Upgrade opentelemetry_phoenix deps to build on 1.15

* Upgrade opentelemetry_redix deps to build on 1.15

* Fix warning about <> being ambiguous

* Fix assertion on attributes keys

These are always atoms, not strings.

* Upgrade ssl_verify_fun in opentelemetry_telemetry

* Deterministically sort keys before asserting in tests

* Upgrade opentelemetry_process_propogator to build on Elixir 1.15

* Run mix format on opentelemetry_process_propogator

* Assert keys are atoms, not strings

* Use matrix.os to define runs-on parameter

* Pin test matrix to specific OTP + Elixir versions

* Run formatter on telemetry and process_propagator

* Run formatter over opentelemetry_phoenix

---------

Co-authored-by: Tristan Sloughter <t@crashfast.com>
2023-08-25 14:11:23 -06:00
..
config finch-instrumentation (#115) 2022-11-09 12:27:40 -07:00
lib chore: add sc to finch (#141) 2022-12-15 04:36:52 -07:00
test Fix CI errors, update GHA deps, update versions (#125) 2022-11-15 16:22:28 -07:00
.formatter.exs finch-instrumentation (#115) 2022-11-09 12:27:40 -07:00
.gitignore finch-instrumentation (#115) 2022-11-09 12:27:40 -07:00
CHANGELOG.md finch-instrumentation (#115) 2022-11-09 12:27:40 -07:00
LICENSE finch-instrumentation (#115) 2022-11-09 12:27:40 -07:00
README.md finch-instrumentation (#115) 2022-11-09 12:27:40 -07:00
mix.exs Make exdocs settings a bit more similar between different packages (#168) 2023-04-30 12:10:03 -06:00
mix.lock Improve test matrix and add support for Elixir 1.15 and OTP 26 (#188) 2023-08-25 14:11:23 -06:00

README.md

OpentelemetryFinch

OpentelemetryFinch uses telemetry handlers to create OpenTelemetry spans from Finch events.

Installation

The package can be installed by adding opentelemetry_finch to your list of dependencies in mix.exs:

  def deps do
    [
      {:opentelemetry_finch, "~> 0.1"}
    ]
  end

In your application start:

  def start(_type, _args) do
    OpentelemetryFinch.setup()

    # ...
  end

Since this instrumentation is based on telemetry, it is not possible to automatically propagate the context in the http headers. If you need to perform context propagation, you should opt for manual instrumentation. Something like this:

    require OpenTelemetry.Tracer, as: Tracer

    Tracer.with_span "HTTP #{url}" do
      headers = :otel_propagator_text_map.inject([])

      with request <- Finch.build(:get, url, headers),
           {:ok, response} <- Finch.request(request, HttpFinch) do

        Tracer.set_attributes([
          {"http.url", url},
          {"http.method", request.method},
          {"http.status_code", response.status}])
        {:ok, response}
      else
        {:error, %{__exception__: true} = error} ->
          Tracer.set_status(:error, Exception.message(error))
          {:error, error}
      end
    end

Compatibility Matrix

OpentelemetryFinch Version Otel Version Notes
v0.1.0 v1.0.0

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