> ## 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.

# Hanami

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 Ruby", version: "3.3.0" },
{ name: "Hanami", version: "2" }
]}
/>

[Hanami](https://hanamirb.org/) é oficialmente suportado. Instrumentar aplicações Hanami requer alguma configuração manual. Siga os passos de instalação no AppSignal, começando por clicar em 'Add app' na [tela de contas](https://appsignal.com/accounts).

<Note>
  Sua aplicação está usando uma combinação de Rails, Grape, Hanami, Padrino ou Sinatra? Siga nosso guia sobre [instrumentação de múltiplas aplicações Rack](/ruby/integrations/rack-libraries).
</Note>

<Tip>
  Esta página descreve a integração para o framework Hanami, instalado via
  a gem "hanami". O framework Hanami::API (da gem "hanami-api") não é
  suportado.
</Tip>

## Instalação

Após instalar a gem AppSignal, adicione a integração AppSignal depois de requerer `hanami/boot` no arquivo `config.ru`.

<CodeGroup>
  ```ruby Ruby theme={null}
  # config.ru
  require "appsignal" # Adicione este require
  require "hanami/boot"

  # Carrega a integração com Hanami
  Appsignal.load(:hanami)
  # Inicia o AppSignal
  Appsignal.start

  run Hanami.app

  # Para gem Ruby 3.11 e mais antigas
  require "appsignal/integrations/hanami" # Adicione esta linha
  ```
</CodeGroup>

## Tratamento de exceptions

O Hanami não possui nenhum tratamento de exceptions por padrão. O servidor web (como Puma ou Unicorn) mostrará uma página básica de "internal server error" se um erro ocorrer no app. Essas exceptions não tratadas serão reportadas ao AppSignal automaticamente.

O [guia de tratamento de exceptions do Hanami](https://guides.hanamirb.org/v2.1/actions/exception-handling/) explica como adicionar tratamento de exceptions customizado em aplicações Hanami para renderizar páginas de erro customizadas. Exceptions tratadas não serão reportadas ao AppSignal automaticamente.

Recomendamos adicionar o seguinte código à classe base Action da aplicação encontrada em `app/action.rb` para adicionar tratamento de exceptions para `StandardError`. Dessa forma, não é necessário adicionar tratamento de exceptions a cada classe de action.

No método `handle_standard_error`, configurado por `handle_exception`, chame o helper `Appsignal.report_error` para reportar a exception ao AppSignal e não perder nenhum erro reportado pelo seu app. (Use o helper `Appsignal.set_error` ao usar a gem Ruby versão 3 ou mais antiga.)

<CodeGroup>
  ```ruby Ruby theme={null}
  # app/action.rb
  # auto_register: false
  # frozen_string_literal: true

  require "hanami/action"

  module MyHanamiApp
    class Action < Hanami::Action
      handle_exception StandardError => :handle_standard_error

      private

      def handle_standard_error(request, response, exception)
        # Reporta o erro ao AppSignal
        Appsignal.report_error(exception)

        # Renderiza página de erro customizada
        response.status = 500
        response.body = "Sorry, something went wrong handling your request"
      end
    end
  end
  ```
</CodeGroup>

Depois de adicionar o método `Appsignal.report_error` às exceptions do Hanami que você deseja reportar, o AppSignal reportará esses erros sempre que ocorrerem.