Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support elixir 1.15.7-otp-26 #1

Merged
merged 2 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
erlang 26.1
elixir 1.15.7-otp-26
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,17 @@ What makes Statix the fastest library around:

See [the documentation](https://hexdocs.pm/statix) for detailed usage information.

## Why Forked Repo?

**Statix Compatibility**: [Statix](https://github.com/lexmag/statix), does not yet support OTP-26. It is using `Port.command` instead of `:gen_udp.send`, as the former was considered more performant for OTP 25 and older versions. However, due to OTP updates occurring at the networking layer, this approach no longer works. Now, `gen_udp.send` has been optimized, rendering the previous workaround obsolete.

### References
- **Open PR**: There is an open pull request in the Statix repository addressing this issue: [Pull Request #72](https://github.com/lexmag/statix/pull/72). This PR aims to update the codebase to support OTP-26 and utilize the optimized `gen_udp.send` function.

- **Erlang Discussion**: For further insights, you can refer to the Erlang discussion about the breaking change in `Port.command` for OTP-26: [Issue #7130](https://github.com/erlang/otp/issues/7130).

By utilizing the forked repository of [Statix](https://github.com/lexmag/statix), we can maintain compatibility with OTP-26. As Statix evolves and potentially adds support for our current version, we aim to transition back to the main Statix repository. Alternatively, we'll explore alternatives should the need arise in the future.

## Installation

Add Statix as a dependency to your `mix.exs` file:
Expand Down
9 changes: 4 additions & 5 deletions lib/statix.ex
Original file line number Diff line number Diff line change
Expand Up @@ -254,12 +254,12 @@ defmodule Statix do
"123"

"""
@callback measure(key, options, function :: (() -> result)) :: result when result: var
@callback measure(key, options, function :: (-> result)) :: result when result: var

@doc """
Same as `measure(key, [], function)`.
"""
@callback measure(key, function :: (() -> result)) :: result when result: var
@callback measure(key, function :: (-> result)) :: result when result: var

defmacro __using__(opts) do
current_statix =
Expand Down Expand Up @@ -359,11 +359,10 @@ defmodule Statix do
@doc false
def new(module, options) do
config = get_config(module, options)
conn = Conn.new(config.host, config.port)
header = IO.iodata_to_binary([conn.header | config.prefix])
conn = Conn.new(config.host, config.port, config.prefix)

%__MODULE__{
conn: %{conn | header: header},
conn: conn,
pool: build_pool(module, config.pool_size),
tags: config.tags
}
Expand Down
38 changes: 17 additions & 21 deletions lib/statix/conn.ex
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
defmodule Statix.Conn do
@moduledoc false

defstruct [:sock, :header]
defstruct [:sock, :address, :port, :prefix]

alias Statix.Packet

require Logger

def new(host, port) when is_binary(host) do
new(String.to_charlist(host), port)
def new(host, port, prefix) when is_binary(host) do
new(String.to_charlist(host), port, prefix)
end

def new(host, port) when is_list(host) or is_tuple(host) do
def new(host, port, prefix) when is_list(host) or is_tuple(host) do
case :inet.getaddr(host, :inet) do
{:ok, address} ->
header = Packet.header(address, port)
%__MODULE__{header: header}
%__MODULE__{address: address, port: port, prefix: prefix}

{:error, reason} ->
raise(
Expand All @@ -30,34 +29,31 @@ defmodule Statix.Conn do
%__MODULE__{conn | sock: sock}
end

def transmit(%__MODULE__{header: header, sock: sock}, type, key, val, options)
def transmit(%__MODULE__{sock: sock, prefix: prefix} = conn, type, key, val, options)
when is_binary(val) and is_list(options) do
result =
header
prefix
|> Packet.build(type, key, val, options)
|> transmit(sock)
|> transmit(conn)

if result == {:error, :port_closed} do
with {:error, error} <- result do
Logger.error(fn ->
if(is_atom(sock), do: "", else: "Statix ") <>
"#{inspect(sock)} #{type} metric \"#{key}\" lost value #{val}" <> " due to port closure"
"#{inspect(sock)} #{type} metric \"#{key}\" lost value #{val}" <>
" error=#{inspect(error)}"
end)
end

result
end

defp transmit(packet, sock) do
try do
Port.command(sock, packet)
rescue
ArgumentError ->
{:error, :port_closed}
defp transmit(packet, %__MODULE__{address: address, port: port, sock: sock_name}) do
sock = Process.whereis(sock_name)

if sock do
:gen_udp.send(sock, address, port, packet)
else
true ->
receive do
{:inet_reply, _port, status} -> status
end
{:error, :port_closed}
end
end
end
27 changes: 2 additions & 25 deletions lib/statix/packet.ex
Original file line number Diff line number Diff line change
@@ -1,31 +1,8 @@
defmodule Statix.Packet do
@moduledoc false

import Bitwise

def header({n1, n2, n3, n4}, port) do
true = Code.ensure_loaded?(:gen_udp)

anc_data_part =
if function_exported?(:gen_udp, :send, 5) do
[0, 0, 0, 0]
else
[]
end

[
_addr_family = 1,
band(bsr(port, 8), 0xFF),
band(port, 0xFF),
band(n1, 0xFF),
band(n2, 0xFF),
band(n3, 0xFF),
band(n4, 0xFF)
] ++ anc_data_part
end

def build(header, name, key, val, options) do
[header, key, ?:, val, ?|, metric_type(name)]
def build(prefix, name, key, val, options) do
[prefix, key, ?:, val, ?|, metric_type(name)]
|> set_option(:sample_rate, options[:sample_rate])
|> set_option(:tags, options[:tags])
end
Expand Down
16 changes: 10 additions & 6 deletions test/statix_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ defmodule StatixTest do

defp close_port() do
%{pool: pool} = current_statix()
Enum.each(pool, &Port.close/1)

Enum.each(pool, fn module_name ->
sock = Process.whereis(module_name)
:gen_udp.close(sock)
end)
end

setup do
Expand Down Expand Up @@ -156,22 +160,22 @@ defmodule StatixTest do

assert capture_log(fn ->
assert {:error, :port_closed} == increment("sample")
end) =~ "counter metric \"sample\" lost value 1 due to port closure"
end) =~ "counter metric \"sample\" lost value 1 error=:port_closed\n\e[0m"

assert capture_log(fn ->
assert {:error, :port_closed} == decrement("sample")
end) =~ "counter metric \"sample\" lost value -1 due to port closure"
end) =~ "counter metric \"sample\" lost value -1 error=:port_closed\n\e[0m"

assert capture_log(fn ->
assert {:error, :port_closed} == gauge("sample", 2)
end) =~ "gauge metric \"sample\" lost value 2 due to port closure"
end) =~ "gauge metric \"sample\" lost value 2 error=:port_closed\n\e[0m"

assert capture_log(fn ->
assert {:error, :port_closed} == histogram("sample", 3)
end) =~ "histogram metric \"sample\" lost value 3 due to port closure"
end) =~ "histogram metric \"sample\" lost value 3 error=:port_closed\n\e[0m"

assert capture_log(fn ->
assert {:error, :port_closed} == timing("sample", 2.5)
end) =~ "timing metric \"sample\" lost value 2.5 due to port closure"
end) =~ "timing metric \"sample\" lost value 2.5 error=:port_closed\n\e[0m"
end
end
10 changes: 10 additions & 0 deletions test/support/test_server.exs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ defmodule Statix.TestServer do
@impl true
def init(port) do
{:ok, socket} = :gen_udp.open(port, [:binary, active: true])
Process.flag(:trap_exit, true)
{:ok, %{socket: socket, test: nil}}
end

Expand All @@ -21,12 +22,21 @@ defmodule Statix.TestServer do
end

@impl true
def handle_info({:EXIT, _pid, reason}, state) do
{:stop, reason, state}
end

def handle_info({:udp, socket, host, port, packet}, %{socket: socket, test: test} = state) do
metadata = %{host: host, port: port, socket: socket}
send(test, {:test_server, metadata, packet})
{:noreply, state}
end

@impl true
def terminate(_reason, %{socket: socket}) do
:gen_udp.close(socket)
end

def setup(test_module) do
:ok = set_current_test(test_module, self())
ExUnit.Callbacks.on_exit(fn -> set_current_test(test_module, nil) end)
Expand Down