> ## Documentation Index
> Fetch the complete documentation index at: https://docs.appsignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HTTPoison

export const VersionRequirements = ({versions = []}) => {
  if (!Array.isArray(versions) || versions.length === 0) {
    return null;
  }
  const boundaries = {
    upper: " or lower",
    exact: "",
    lower: " or higher"
  };
  const containerStyle = {
    marginTop: "0.5rem",
    marginBottom: "1.5rem"
  };
  const lineStyle = {
    display: "block",
    margin: "0 0 0.35rem 0",
    fontSize: "0.875rem",
    lineHeight: "1.4"
  };
  const pillBaseStyle = {
    display: "inline-block",
    padding: "0.1em 0.4em",
    borderRadius: "0.25rem",
    border: "1px solid",
    fontFamily: "ui-monospace, SFMono-Regular, Menlo, monospace",
    fontSize: "0.85em",
    fontWeight: 500
  };
  const pillColors = {
    "AppSignal for Elixir": {
      background: "#f3e8ff",
      borderColor: "#e9d5ff",
      color: "#9333ea"
    },
    "AppSignal for Front-end": {
      background: "#fef9c3",
      borderColor: "#fde68a",
      color: "#ca8a04"
    },
    "AppSignal for Go": {
      background: "#ccfbf1",
      borderColor: "#99f6e4",
      color: "#0d9488"
    },
    "AppSignal for JavaScript": {
      background: "#fef9c3",
      borderColor: "#fde68a",
      color: "#ca8a04"
    },
    "AppSignal for Node.js": {
      background: "#dcfce7",
      borderColor: "#bbf7d0",
      color: "#16a34a"
    },
    "AppSignal for Python": {
      background: "#dbeafe",
      borderColor: "#bfdbfe",
      color: "#2563eb"
    },
    "AppSignal for Ruby": {
      background: "#fee2e2",
      borderColor: "#fecaca",
      color: "#dc2626"
    },
    "AppSignal for Rust": {
      background: "#ffedd5",
      borderColor: "#fed7aa",
      color: "#ea580c"
    }
  };
  const defaultPillColor = {
    background: "#f4f4f5",
    borderColor: "#e4e4e7",
    color: "#52525b"
  };
  const getPillStyle = name => ({
    ...pillBaseStyle,
    ...pillColors[name] || defaultPillColor
  });
  const getBoundText = bound => {
    return boundaries[bound] || boundaries.lower;
  };
  return <div style={containerStyle}>
      {versions.map((v, i) => <p key={`${v.name}-${v.version}-${v.bound || "lower"}-${i}`} style={lineStyle}>
          This feature requires{" "}
          <code style={getPillStyle(v.name)}>{v.name}</code> version {v.version}
          {getBoundText(v.bound)}.
        </p>)}
    </div>;
};

<VersionRequirements
  versions={[
{ name: "AppSignal for Elixir", version: "2.17.0" },
{ name: "HTTPoison", version: "2.0.0" }
]}
/>

O pacote AppSignal for Elixir instrumenta requisições HTTP realizadas pelo [HTTPoison](https://github.com/edgurgel/httpoison).

HTTPoison é um cliente HTTP popular para Elixir. Diferentemente do Finch e do Tesla, o HTTPoison não emite eventos de telemetria, então o AppSignal não pode instrumentá-lo automaticamente. Em vez disso, o AppSignal fornece módulos wrapper aos quais você opta por aderir: `Appsignal.HTTPoison` como um cliente drop-in, e `Appsignal.HTTPoison.Base` para módulos cliente customizados. As structs de response e error (`%HTTPoison.Response{}`, `%HTTPoison.Error{}`, ...) são os tipos próprios do HTTPoison e são retornados sem alteração.

O AppSignal envolverá as requisições executadas via `Appsignal.HTTPoison` como eventos `request.httpoison` na timeline de eventos das suas amostras de desempenho, permitindo que você veja quanto tempo o HTTPoison gasta fazendo requisições a APIs externas. Esses dados podem ajudá-lo a decidir mover as requisições de API para um background job ou introduzir caching para ajudar a acelerar o desempenho e limitar requisições desnecessárias a APIs.

## Configuração

A instrumentação do HTTPoison é opt-in. Escolha a abordagem que melhor se adapta à sua aplicação.

### Usando Appsignal.HTTPoison diretamente

Chame `Appsignal.HTTPoison` em vez de `HTTPoison` para fazer requisições instrumentadas. Faça pattern-match em `%HTTPoison.Response{...}` e `%HTTPoison.Error{...}` normalmente — esses são os tipos de struct próprios do HTTPoison, retornados sem alteração:

<Warning>
  Não use `alias Appsignal.HTTPoison`. Isso sombrearia o nome do módulo
  `HTTPoison`, fazendo com que pattern matches em `%HTTPoison.Response{}` e
  `%HTTPoison.Error{}` falhem.
</Warning>

<CodeGroup>
  ```elixir Elixir theme={null}
  defmodule MyAppWeb.PageController do
    use MyAppWeb, :controller

    def index(conn, _params) do
      case Appsignal.HTTPoison.get("https://api.example.com/users") do
        {:ok, %HTTPoison.Response{status_code: 200, body: body}} ->
          render(conn, :index, users: body)

        {:ok, %HTTPoison.Response{status_code: status}} ->
          conn |> put_status(status) |> text("Error")

        {:error, %HTTPoison.Error{reason: reason}} ->
          conn |> put_status(500) |> text("Error: #{reason}")
      end
    end
  end
  ```
</CodeGroup>

### Módulos cliente customizados

Se você usa um módulo cliente HTTP customizado baseado em `HTTPoison.Base`, substitua `use HTTPoison.Base` por `use Appsignal.HTTPoison.Base`. Nenhuma alteração adicional é necessária — dentro do módulo, você pode chamar métodos como `get/1` e `post/3`, e fazer match nas structs de response e error do HTTPoison normalmente:

<CodeGroup>
  ```elixir Elixir theme={null}
  defmodule MyApp.ApiClient do
    # substitua `use HTTPoison.Base` por `use Appsignal.HTTPoison.Base`
    use Appsignal.HTTPoison.Base

    def process_url(url) do
      "https://api.example.com" <> url
    end

    def users do
      case get("/users") do
        {:ok, %HTTPoison.Response{status_code: 200, body: body}} -> {:ok, body}
        {:ok, %HTTPoison.Response{status_code: status}} -> {:error, status}
        {:error, %HTTPoison.Error{reason: reason}} -> {:error, reason}
      end
    end
  end
  ```
</CodeGroup>

Todas as requisições feitas através do seu cliente customizado serão então instrumentadas automaticamente. Se seu módulo sobrescreve `request/5`, certifique-se de chamar `super` para preservar a instrumentação:

<CodeGroup>
  ```elixir Elixir theme={null}
  defmodule MyApp.ApiClient do
    use Appsignal.HTTPoison.Base

    def request(method, url, body, headers, options) do
      # ... lógica customizada aqui ...
      super(method, url, body, headers, options)
    end
  end
  ```
</CodeGroup>
