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

# Grape

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>;
};

export const Compatibility = ({versions = [], label = "Available in"}) => {
  if (!Array.isArray(versions) || versions.length === 0) {
    return null;
  }
  const defaultPillStyle = {
    borderColor: "#d4d4d8",
    background: "#f4f4f5",
    color: "#3f3f46"
  };
  const pillStyles = {
    "AppSignal for Elixir": {
      background: "#f3e8ff",
      borderColor: "#d8b4fe",
      color: "#6b21a8"
    },
    "AppSignal for Front-end": {
      background: "#fef9c3",
      borderColor: "#fde047",
      color: "#854d0e"
    },
    "AppSignal for Go": {
      background: "#ccfbf1",
      borderColor: "#5eead4",
      color: "#115e59"
    },
    "AppSignal for JavaScript": {
      background: "#fef9c3",
      borderColor: "#fde047",
      color: "#854d0e"
    },
    "AppSignal for Node.js": {
      background: "#dcfce7",
      borderColor: "#86efac",
      color: "#166534"
    },
    "AppSignal for Python": {
      background: "#dbeafe",
      borderColor: "#93c5fd",
      color: "#1e40af"
    },
    "AppSignal for Ruby": {
      background: "#fee2e2",
      borderColor: "#fca5a5",
      color: "#991b1b"
    },
    "AppSignal for Rust": {
      background: "#ffedd5",
      borderColor: "#fdba74",
      color: "#9a3412"
    }
  };
  const getPillStyle = name => ({
    ...defaultPillStyle,
    ...pillStyles[name] || ({})
  });
  return <div className="not-prose my-4 rounded-lg border border-zinc-200 bg-zinc-50 px-4 py-3 text-sm dark:border-white/10 dark:bg-white/5">
      <div className="flex flex-wrap items-center gap-x-2 gap-y-1">
        <span className="font-semibold text-zinc-700 dark:text-zinc-200">
          {label}:
        </span>
        {versions.map((v, i) => <span key={`${v.name}-${v.version}-${i}`} className="inline-flex items-center gap-1 rounded-full border px-2 py-0.5 text-xs font-medium" style={getPillStyle(v.name)}>
            <span>{v.name}</span>
            <span className="opacity-70">
              {v.version}
              {v.exact ? "" : "+"}
            </span>
          </span>)}
      </div>
    </div>;
};

<VersionRequirements
  versions={[
{ name: "AppSignal for Ruby", version: "1.1" },
{ name: "Grape", version: "1.0" }
]}
/>

Aplicações [Grape](https://www.ruby-grape.org/) são oficialmente suportadas. Instrumentar aplicações Grape 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>

## Instalação

<Tip>
  Este guia de instalação é para a gem Ruby 3.12 e mais novas. Para aplicações
  usando uma gem AppSignal for Ruby mais antiga, siga nosso [guia de instalação
  legado](#legacy-installation).
</Tip>

Após [instalar e configurar a gem AppSignal](/ruby/installation), adicione a integração AppSignal depois que o app Grape for carregado.

A integração com Grape é requerida pela gem Ruby do AppSignal e os middlewares de event e instrumentation são adicionados nos exemplos de código a seguir.

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

  # Carrega a integração com Grape
  Appsignal.load(:grape)

  # Adiciona o middleware Rack EventMiddleware do AppSignal
  # Requer a gem AppSignal for Ruby 4.7+
  use Appsignal::Rack::EventMiddleware

  # Requer o app
  require_relative "api"

  # Inicia o AppSignal
  Appsignal.start

  # Inicia o app
  run Acme::API
  ```
</CodeGroup>

O próximo passo é adicionar o middleware do AppSignal à classe API base da aplicação. Ele reportará qualquer exception não tratada da aplicação.

<CodeGroup>
  ```ruby Ruby theme={null}
  # api.rb

  module Acme
    class API < Grape::API
      # Adicione esta linha
      insert_before Grape::Middleware::Error, Appsignal::Rack::GrapeMiddleware # Inclua este middleware

      # ...
    end
  end
  ```
</CodeGroup>

### Instalação legada

Aplicações usando a gem AppSignal for Ruby 3.11 ou mais antiga, sigam estes passos para instalar o AppSignal em aplicações Grape.

A integração com Grape é requerida pela gem Ruby do AppSignal e os middlewares de event handler e instrumentation são adicionados nos exemplos de código a seguir.

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

  # Configura o AppSignal
  Appsignal.config = Appsignal::Config.new(
    Dir.pwd,        # A raiz do seu app
    ENV["RACK_ENV"] # O ambiente do seu app (development/production)
  )
  # Inicia o AppSignal
  Appsignal.start_logger # Não é necessário na gem Ruby 3.9.3+
  Appsignal.start

  # Adiciona o Rack EventHandler do AppSignal
  # Requer a gem AppSignal for Ruby 3.8+
  use ::Rack::Events, [Appsignal::Rack::EventHandler.new]

  # Requer o app
  require_relative "api"

  # Inicia o app
  run Acme::API
  ```
</CodeGroup>

O próximo passo é adicionar o middleware do AppSignal à classe API base da aplicação. Ele reportará qualquer exception não tratada da aplicação.

<CodeGroup>
  ```ruby Ruby theme={null}
  # api.rb

  module Acme
    class API < Grape::API
      # Adicione esta linha
      insert_before Grape::Middleware::Error, Appsignal::Grape::Middleware # Inclua este middleware

      # ...
    end
  end
  ```
</CodeGroup>

## Apps Grape montados

<Compatibility versions={[{ name: "AppSignal for Ruby", version: "3.9.3" }]} />

Montar aplicações Grape em aplicações Ruby on Rails é suportado. A gem Ruby precisa estar em uma versão recente para instrumentar adequadamente as requisições para apps Grape montados.

## Ignorando erros

<Compatibility versions={[{ name: "AppSignal for Ruby", version: "2.10.5" }]} />

Para ignorar um erro específico do Grape, defina a flag `grape.skip_appsignal_error` no environment da requisição. Definir essa flag como `true` instruirá o AppSignal a não reportar nenhum erro durante a requisição.

Use esta flag apenas se você precisa ignorar erros de uma aplicação Grape dinamicamente. Especifique classes de erro na [opção `ignore_errors`](/guides/filter-data/ignore-errors) para ignorá-las em toda a aplicação. Para mais informações sobre como silenciar notificações para erros específicos, veja nossa [documentação de notification settings](/application/notification-settings).

<CodeGroup>
  ```ruby Ruby theme={null}
  get "/" do
    env["grape.skip_appsignal_error"] = true # Adicione esta linha em um endpoint ou callback
    raise "uh oh" # Erro de exemplo, não copie isto
  end
  ```
</CodeGroup>

## Reportando erros do `rescue_from`

Se um erro é resgatado no app usando `rescue_from`, o AppSignal não o receberá nem o rastreará. Para ainda reportar o erro, chame `Appsignal.report_error` no bloco `rescue_from`. (Use o helper `Appsignal.set_error` ao usar a gem Ruby versão 3 ou mais antiga.)

<CodeGroup>
  ```ruby Ruby theme={null}
  class Api < ::Grape::API
    insert_before Grape::Middleware::Error, Appsignal::Grape::Middleware

    format :json

    rescue_from :all do |error|
      Appsignal.report_error(error)
      error!({ :error => "error message" }.to_json, 500)
    end
  end
  ```
</CodeGroup>