list out the aliases as fully qualified; use the semantic conventions for matches in tests

Author: ShapovalovaIrina

instrumentation/opentelemetry_finch/lib/opentelemetry_finch.ex

@@ -61,24 +61,21 @@ defmodule OpentelemetryFinch do
  ```
  """
 
- alias OpenTelemetry.SemConv.{
- ErrorAttributes,
- HTTPAttributes,
- ServerAttributes,
- URLAttributes,
- NetworkAttributes,
- UserAgentAttributes,
- Incubating
- }
+ alias OpenTelemetry.SemConv.ErrorAttributes
+ alias OpenTelemetry.SemConv.Incubating.HTTPAttributes
+ alias OpenTelemetry.SemConv.Incubating.URLAttributes
+ alias OpenTelemetry.SemConv.NetworkAttributes
+ alias OpenTelemetry.SemConv.ServerAttributes
+ alias OpenTelemetry.SemConv.UserAgentAttributes
 
  require OpenTelemetry.Tracer
 
  opt_ins = [
- Incubating.HTTPAttributes.http_request_body_size(),
- Incubating.HTTPAttributes.http_response_body_size(),
+ HTTPAttributes.http_request_body_size(),
+ HTTPAttributes.http_response_body_size(),
  NetworkAttributes.network_transport(),
- Incubating.URLAttributes.url_scheme(),
- Incubating.URLAttributes.url_template(),
+ URLAttributes.url_scheme(),
+ URLAttributes.url_template(),
  UserAgentAttributes.user_agent_original()
  ]
 
@@ -117,11 +114,11 @@ defmodule OpentelemetryFinch do
  )
 
  @type opt_in_attr() ::
- unquote(Incubating.HTTPAttributes.http_request_body_size())
- | unquote(Incubating.HTTPAttributes.http_response_body_size())
+ unquote(HTTPAttributes.http_request_body_size())
+ | unquote(HTTPAttributes.http_response_body_size())
  | unquote(NetworkAttributes.network_transport())
- | unquote(Incubating.URLAttributes.url_scheme())
- | unquote(Incubating.URLAttributes.url_template())
+ | unquote(URLAttributes.url_scheme())
+ | unquote(URLAttributes.url_template())
  | unquote(UserAgentAttributes.user_agent_original())
 
  @type opt_in_attrs() :: [opt_in_attr()]
@@ -205,10 +202,10 @@ defmodule OpentelemetryFinch do
 
  defp add_opt_in_req_attrs(attrs, request, %{opt_in_attrs: [_ | _] = opt_in_attrs} = otel_config) do
  %{
- Incubating.HTTPAttributes.http_request_body_size() => extract_request_body_size(request),
+ HTTPAttributes.http_request_body_size() => extract_request_body_size(request),
  NetworkAttributes.network_transport() => :tcp,
  URLAttributes.url_scheme() => request.scheme,
- Incubating.URLAttributes.url_template() => extract_url_template(otel_config),
+ URLAttributes.url_template() => extract_url_template(otel_config),
  UserAgentAttributes.user_agent_original() => extract_user_agent(request)
  }
  |> Map.take(opt_in_attrs)
@@ -232,7 +229,7 @@ defmodule OpentelemetryFinch do
 
  defp add_opt_in_resp_attrs(attrs, response, %{opt_in_attrs: [_ | _] = opt_in_attrs}) do
  %{
- Incubating.HTTPAttributes.http_response_body_size() => extract_response_body_size(response)
+ HTTPAttributes.http_response_body_size() => extract_response_body_size(response)
  }
  |> Map.take(opt_in_attrs)
  |> then(&Map.merge(attrs, &1))

instrumentation/opentelemetry_finch/mix.exs

@@ -59,6 +59,7 @@ defmodule OpentelemetryFinch.MixProject do
  {:opentelemetry_semantic_conventions, "~> 1.27"},
  {:opentelemetry, "~> 1.5", only: [:dev, :test]},
  {:opentelemetry_exporter, "~> 1.8", only: [:dev, :test]},
+ {:otel_http, "~> 0.2"},
  {:ex_doc, "~> 0.38", only: [:dev], runtime: false},
  {:finch, "~> 0.19", only: [:dev, :test]},
  {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},

instrumentation/opentelemetry_finch/mix.lock

@@ -27,6 +27,7 @@
  "opentelemetry_api": {:hex, :opentelemetry_api, "1.4.0", "63ca1742f92f00059298f478048dfb826f4b20d49534493d6919a0db39b6db04", [:mix, :rebar3], [], "hexpm", "3dfbbfaa2c2ed3121c5c483162836c4f9027def469c41578af5ef32589fcfc58"},
  "opentelemetry_exporter": {:hex, :opentelemetry_exporter, "1.8.0", "5d546123230771ef4174e37bedfd77e3374913304cd6ea3ca82a2add49cd5d56", [:rebar3], [{:grpcbox, ">= 0.0.0", [hex: :grpcbox, repo: "hexpm", optional: false]}, {:opentelemetry, "~> 1.5.0", [hex: :opentelemetry, repo: "hexpm", optional: false]}, {:opentelemetry_api, "~> 1.4.0", [hex: :opentelemetry_api, repo: "hexpm", optional: false]}, {:tls_certificate_check, "~> 1.18", [hex: :tls_certificate_check, repo: "hexpm", optional: false]}], "hexpm", "a1f9f271f8d3b02b81462a6bfef7075fd8457fdb06adff5d2537df5e2264d9af"},
  "opentelemetry_semantic_conventions": {:hex, :opentelemetry_semantic_conventions, "1.27.0", "acd0194a94a1e57d63da982ee9f4a9f88834ae0b31b0bd850815fe9be4bbb45f", [:mix, :rebar3], [], "hexpm", "9681ccaa24fd3d810b4461581717661fd85ff7019b082c2dff89c7d5b1fc2864"},
+ "otel_http": {:hex, :otel_http, "0.2.0", "b17385986c7f1b862f5d577f72614ecaa29de40392b7618869999326b9a61d8a", [:rebar3], [], "hexpm", "f2beadf922c8cfeb0965488dd736c95cc6ea8b9efce89466b3904d317d7cc717"},
  "plug": {:hex, :plug, "1.15.3", "712976f504418f6dff0a3e554c40d705a9bcf89a7ccef92fc6a5ef8f16a30a97", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.1.1 or ~> 1.2 or ~> 2.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "cc4365a3c010a56af402e0809208873d113e9c38c401cabd88027ef4f5c01fd2"},
  "plug_cowboy": {:hex, :plug_cowboy, "2.7.0", "3ae9369c60641084363b08fe90267cbdd316df57e3557ea522114b30b63256ea", [:mix], [{:cowboy, "~> 2.7.0 or ~> 2.8.0 or ~> 2.9.0 or ~> 2.10.0", [hex: :cowboy, repo: "hexpm", optional: false]}, {:cowboy_telemetry, "~> 0.3", [hex: :cowboy_telemetry, repo: "hexpm", optional: false]}, {:plug, "~> 1.14", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm", "d85444fb8aa1f2fc62eabe83bbe387d81510d773886774ebdcb429b3da3c1a4a"},
  "plug_crypto": {:hex, :plug_crypto, "2.0.0", "77515cc10af06645abbfb5e6ad7a3e9714f805ae118fa1a70205f80d2d70fe73", [:mix], [], "hexpm", "53695bae57cc4e54566d993eb01074e4d894b65a3766f1c43e2c61a1b0f45ea9"},

instrumentation/opentelemetry_finch/test/opentelemetry_finch_test.exs

@@ -7,7 +7,12 @@ defmodule OpentelemetryFinchTest do
  require OpenTelemetry.Span
  require Record
 
- alias OpenTelemetry.SemConv.{NetworkAttributes, UserAgentAttributes, Incubating}
+ alias OpenTelemetry.SemConv.ErrorAttributes
+ alias OpenTelemetry.SemConv.Incubating.HTTPAttributes
+ alias OpenTelemetry.SemConv.Incubating.URLAttributes
+ alias OpenTelemetry.SemConv.NetworkAttributes
+ alias OpenTelemetry.SemConv.ServerAttributes
+ alias OpenTelemetry.SemConv.UserAgentAttributes
 
  for {name, spec} <- Record.extract_all(from_lib: "opentelemetry/include/otel_span.hrl") do
  Record.defrecord(name, spec)
@@ -46,13 +51,19 @@ defmodule OpentelemetryFinchTest do
  attributes: attributes
  )}
 
- assert %{
- "server.address": "localhost",
- "server.port": bypass.port,
- "http.request.method": "GET",
- "url.full": url,
- "http.response.status_code": 200
- } == :otel_attributes.map(attributes)
+ attrs = :otel_attributes.map(attributes)
+
+ expected_attrs = [
+ {ServerAttributes.server_address(), "localhost"},
+ {ServerAttributes.server_port(), bypass.port},
+ {HTTPAttributes.http_request_method(), "GET"},
+ {URLAttributes.url_full(), url},
+ {HTTPAttributes.http_response_status_code(), 200}
+ ]
+
+ for {attr, val} <- expected_attrs do
+ assert Map.get(attrs, attr) == val, " expected #{attr} to equal #{val}"
+ end
  end
 
  test "records span on requests with custom span name", %{bypass: bypass} do
@@ -86,11 +97,11 @@ defmodule OpentelemetryFinchTest do
 
  otel_config = %{
  opt_in_attrs: [
- Incubating.HTTPAttributes.http_request_body_size(),
- Incubating.HTTPAttributes.http_response_body_size(),
+ HTTPAttributes.http_request_body_size(),
+ HTTPAttributes.http_response_body_size(),
  NetworkAttributes.network_transport(),
- Incubating.URLAttributes.url_scheme(),
- Incubating.URLAttributes.url_template(),
+ URLAttributes.url_scheme(),
+ URLAttributes.url_template(),
  UserAgentAttributes.user_agent_original()
  ],
  url_template: "/users/:user_id"
@@ -108,19 +119,25 @@ defmodule OpentelemetryFinchTest do
  attributes: attributes
  )}
 
- assert %{
- "server.address": "localhost",
- "server.port": bypass.port,
- "http.request.method": "GET",
- "url.full": endpoint_url(bypass.port),
- "http.response.status_code": 200,
- "http.request.body.size": 0,
- "http.response.body.size": 0,
- "network.transport": :tcp,
- "url.scheme": :http,
- "url.template": "/users/:user_id",
- "user_agent.original": ""
- } == :otel_attributes.map(attributes)
+ attrs = :otel_attributes.map(attributes)
+
+ expected_attrs = [
+ {ServerAttributes.server_address(), "localhost"},
+ {ServerAttributes.server_port(), bypass.port},
+ {HTTPAttributes.http_request_method(), "GET"},
+ {URLAttributes.url_full(), endpoint_url(bypass.port)},
+ {HTTPAttributes.http_response_status_code(), 200},
+ {HTTPAttributes.http_request_body_size(), 0},
+ {HTTPAttributes.http_response_body_size(), 0},
+ {NetworkAttributes.network_transport(), :tcp},
+ {URLAttributes.url_scheme(), :http},
+ {URLAttributes.url_template(), "/users/:user_id"},
+ {UserAgentAttributes.user_agent_original(), ""}
+ ]
+
+ for {attr, val} <- expected_attrs do
+ assert Map.get(attrs, attr) == val, " expected #{attr} to equal #{val}"
+ end
  end
 
  test "adds request and response headers to span when request_header_attrs and response_header_attrs are set",
@@ -144,16 +161,22 @@ defmodule OpentelemetryFinchTest do
  attributes: attributes
  )}
 
- assert %{
- "server.address": "localhost",
- "server.port": bypass.port,
- "http.request.method": "GET",
- "url.full": endpoint_url(bypass.port),
- "http.response.status_code": 200,
- "http.response.header.content-length": ["0"],
- "http.response.header.server": ["Cowboy"],
- "http.request.header.authorization": ["Bearer token"]
- } == :otel_attributes.map(attributes)
+ attrs = :otel_attributes.map(attributes)
+
+ expected_attrs = [
+ {ServerAttributes.server_address(), "localhost"},
+ {ServerAttributes.server_port(), bypass.port},
+ {HTTPAttributes.http_request_method(), "GET"},
+ {URLAttributes.url_full(), endpoint_url(bypass.port)},
+ {HTTPAttributes.http_response_status_code(), 200},
+ {String.to_atom("#{HTTPAttributes.http_response_header()}.content-length"), ["0"]},
+ {String.to_atom("#{HTTPAttributes.http_response_header()}.server"), ["Cowboy"]},
+ {String.to_atom("#{HTTPAttributes.http_request_header()}.authorization"), ["Bearer token"]}
+ ]
+
+ for {attr, val} <- expected_attrs do
+ assert Map.get(attrs, attr) == val, " expected #{attr} to equal #{val}"
+ end
  end
 
  test "records span on requests failed", %{bypass: _} do
@@ -167,13 +190,19 @@ defmodule OpentelemetryFinchTest do
  attributes: attributes
  )}
 
- assert %{
- "server.address": "localhost",
- "server.port": 3333,
- "http.request.method": "GET",
- "url.full": "http://localhost:3333/",
- "error.type": "connection refused"
- } == :otel_attributes.map(attributes)
+ attrs = :otel_attributes.map(attributes)
+
+ expected_attrs = [
+ {ServerAttributes.server_address(), "localhost"},
+ {ServerAttributes.server_port(), 3333},
+ {HTTPAttributes.http_request_method(), "GET"},
+ {URLAttributes.url_full(), "http://localhost:3333/"},
+ {ErrorAttributes.error_type(), "connection refused"}
+ ]
+
+ for {attr, val} <- expected_attrs do
+ assert Map.get(attrs, attr) == val, " expected #{attr} to equal #{val}"
+ end
  end
 
  test "records span on request response with 4xx status code", %{bypass: bypass} do
@@ -189,14 +218,20 @@ defmodule OpentelemetryFinchTest do
  attributes: attributes
  )}
 
- assert %{
- "server.address": "localhost",
- "server.port": bypass.port,
- "http.request.method": "GET",
- "url.full": endpoint_url(bypass.port),
- "http.response.status_code": 404,
- "error.type": "404"
- } == :otel_attributes.map(attributes)
+ attrs = :otel_attributes.map(attributes)
+
+ expected_attrs = [
+ {ServerAttributes.server_address(), "localhost"},
+ {ServerAttributes.server_port(), bypass.port},
+ {HTTPAttributes.http_request_method(), "GET"},
+ {URLAttributes.url_full(), endpoint_url(bypass.port)},
+ {HTTPAttributes.http_response_status_code(), 404},
+ {ErrorAttributes.error_type(), "404"}
+ ]
+
+ for {attr, val} <- expected_attrs do
+ assert Map.get(attrs, attr) == val, " expected #{attr} to equal #{val}"
+ end
  end
 
  test "logs error and doesn't record span if invalid otel option is passed", %{bypass: bypass} do