Packages
sentry
12.0.0
13.3.0
13.2.0
13.1.0
13.0.1
13.0.0
12.0.3
12.0.2
12.0.1
12.0.0
11.0.4
11.0.3
11.0.2
11.0.1
11.0.0
10.10.0
10.9.0
10.8.1
10.8.0
10.7.1
10.7.0
10.6.2
10.6.1
10.6.0
10.5.0
10.4.0
10.3.0
10.2.1
10.2.0
10.2.0-rc.2
10.2.0-rc.1
10.1.0
10.0.3
10.0.2
10.0.1
10.0.0
9.1.0
9.0.0
8.1.0
8.0.6
8.0.5
8.0.4
8.0.3
8.0.2
8.0.1
8.0.0
8.0.0-rc.2
8.0.0-rc.1
8.0.0-rc.0
retired
7.2.5
7.2.4
7.2.3
7.2.2
7.2.1
7.2.0
7.1.0
7.0.6
7.0.5
7.0.4
7.0.3
7.0.2
7.0.1
7.0.0
6.4.2
6.4.1
6.4.0
6.3.0
6.2.1
6.2.0
6.1.0
6.0.5
6.0.4
6.0.3
6.0.2
6.0.1
6.0.0
5.0.1
5.0.0
4.0.3
4.0.2
4.0.1
4.0.0
3.0.0
2.2.0
2.1.0
2.0.2
2.0.1
2.0.0
1.1.2
1.1.1
1.1.0
1.0.0
0.3.2
0.3.1
0.3.0
0.2.0
0.1.3
0.1.2
0.1.1
0.1.0
The Official Elixir client for Sentry
Current section
Files
Jump to
Current section
Files
lib/sentry/transport.ex
defmodule Sentry.Transport do
@moduledoc false
# This module is exclusively responsible for encoding and POSTing envelopes to Sentry.
alias Sentry.{ClientError, ClientReport, Config, Envelope, LoggerUtils}
alias Sentry.Transport.RateLimiter
@default_retries [1000, 2000, 4000, 8000]
@sentry_version 5
@sentry_client "sentry-elixir/#{Mix.Project.config()[:version]}"
@spec default_retries() :: [pos_integer(), ...]
def default_retries do
@default_retries
end
@doc """
Encodes the given envelope and POSTs it to Sentry.
The `retries` parameter is there for better testing. This function also logs
a warning if there is an error encoding or posting the envelope.
"""
@spec encode_and_post_envelope(Envelope.t(), module(), [non_neg_integer()]) ::
{:ok, envelope_id :: String.t()} | {:error, ClientError.t()}
def encode_and_post_envelope(%Envelope{} = envelope, client, retries \\ @default_retries)
when is_atom(client) and is_list(retries) do
result =
case Envelope.to_binary(envelope) do
{:ok, body} ->
{endpoint, headers} = get_endpoint_and_headers()
post_envelope_with_retries(client, endpoint, headers, body, retries, envelope.items)
{:error, reason} ->
{:error, ClientError.new({:invalid_json, reason})}
end
_ = maybe_log_send_result(result, envelope.items)
result
end
defp post_envelope_with_retries(
client,
endpoint,
headers,
payload,
retries_left,
envelope_items
) do
case request(client, endpoint, headers, payload, envelope_items) do
{:ok, id} ->
{:ok, id}
{:error, :rate_limited} ->
ClientReport.Sender.record_discarded_events(:ratelimit_backoff, envelope_items)
{:error, ClientError.new(:rate_limited)}
{:error, {:envelope_too_large, {status, headers, body}}} ->
ClientReport.Sender.record_discarded_events(:send_error, envelope_items)
{:error, ClientError.envelope_too_large(status, headers, body)}
{:error, _reason} when retries_left != [] ->
[sleep_interval | retries_left] = retries_left
Process.sleep(sleep_interval)
post_envelope_with_retries(
client,
endpoint,
headers,
payload,
retries_left,
envelope_items
)
{:error, {:http, {status, headers, body}}} ->
ClientReport.Sender.record_discarded_events(:send_error, envelope_items)
{:error, ClientError.server_error(status, headers, body)}
{:error, reason} ->
ClientReport.Sender.record_discarded_events(:send_error, envelope_items)
{:error, ClientError.new(reason)}
end
end
defp check_rate_limited(envelope_items) do
rate_limited? =
Enum.any?(envelope_items, fn item ->
category = Envelope.get_data_category(item)
RateLimiter.rate_limited?(category)
end)
if rate_limited?, do: {:error, :rate_limited}, else: :ok
end
defp request(client, endpoint, headers, body, envelope_items) do
with :ok <- check_rate_limited(envelope_items),
{:ok, 200, _headers, body} <-
client_post_and_validate_return_value(client, endpoint, headers, body),
{:ok, json} <- Sentry.JSON.decode(body, Config.json_library()) do
{:ok, Map.get(json, "id")}
else
{:ok, 429, _headers, _body} ->
{:error, :rate_limited}
{:ok, 413, headers, body} ->
{:error, {:envelope_too_large, {413, headers, body}}}
{:ok, status, headers, body} ->
{:error, {:http, {status, headers, body}}}
{:error, :rate_limited} ->
{:error, :rate_limited}
{:error, reason} ->
{:error, {:request_failure, reason}}
end
catch
kind, data -> {:error, {kind, data, __STACKTRACE__}}
end
defp client_post_and_validate_return_value(client, endpoint, headers, body) do
case client.post(endpoint, headers, body) do
{:ok, status, resp_headers, resp_body}
when is_integer(status) and status in 200..599 and is_list(resp_headers) and
is_binary(resp_body) ->
update_rate_limits(resp_headers, status)
{:ok, status, resp_headers, resp_body}
{:ok, status, resp_headers, resp_body} ->
{:error, {:malformed_http_client_response, status, resp_headers, resp_body}}
{:error, reason} ->
{:error, reason}
end
end
defp update_rate_limits(headers, status) do
rate_limits_header = :proplists.get_value("X-Sentry-Rate-Limits", headers, nil)
cond do
is_binary(rate_limits_header) ->
# Use categorized rate limits if present
RateLimiter.update_rate_limits(rate_limits_header)
status == 429 ->
# Use global rate limit from Retry-After if no categorized limits are present
delay_seconds = get_global_delay(headers)
RateLimiter.update_global_rate_limit(delay_seconds)
true ->
:ok
end
end
defp get_global_delay(headers) do
with timeout when is_binary(timeout) <- :proplists.get_value("Retry-After", headers, nil),
{delay, ""} <- Integer.parse(timeout) do
delay
else
# Per the spec, if Retry-After is missing or malformed, default to 60 seconds
# https://develop.sentry.dev/sdk/rate-limiting/#stage-1-parse-response-headers
_ -> 60
end
end
defp get_endpoint_and_headers do
%Sentry.DSN{} = dsn = Config.dsn()
auth_query =
[
sentry_version: @sentry_version,
sentry_client: @sentry_client,
sentry_timestamp: System.system_time(:second),
sentry_key: dsn.public_key,
sentry_secret: dsn.secret_key
]
|> Enum.reject(fn {_, value} -> is_nil(value) end)
|> Enum.map_join(", ", fn {name, value} -> "#{name}=#{value}" end)
auth_headers = [
{"User-Agent", @sentry_client},
{"X-Sentry-Auth", "Sentry " <> auth_query}
]
{dsn.endpoint_uri, auth_headers}
end
defp maybe_log_send_result(send_result, events) do
if Enum.any?(events, &(Map.has_key?(&1, :source) && &1.source == :logger)) do
:ok
else
message =
case send_result do
{:error, %ClientError{} = error} ->
"Failed to send Sentry event. #{Exception.message(error)}"
{:ok, _} ->
nil
end
if message, do: LoggerUtils.log(fn -> [message] end)
end
end
end