Instrumentar os aplicativos PHP para o Error Reporting

Como ativar a biblioteca

É possível enviar relatórios de erros para o Error Reporting a partir de aplicativos PHP usando a biblioteca do Error Reporting para PHP. Use a biblioteca do Error Reporting para PHP para criar grupos de erros para os seguintes casos:

  • O bucket de registros tem chaves de criptografia gerenciadas pelo cliente (CMEK).
  • Os buckets de registros não estão na região global.
  • Você quer relatar eventos de erro personalizados.

O Error Reporting é integrado a alguns serviços do Google Cloud, como App Engine, Compute Engine e Google Kubernetes Engine. Essa ferramenta exibe os erros registrados no Cloud Logging por aplicativos em execução nesses serviços. Para mais informações, acesse Como executar no Google Cloud nesta página.

Também é possível enviar dados de erros para o Error Reporting usando o Logging. Para mais informações sobre os requisitos de formatação de dados, leia Como formatar mensagens de erro no Logging (em inglês).

Antes de começar

  1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.
  2. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  3. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

  4. Ative a Error Reporting API .

    Ative a API

  5. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  6. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

  7. Ative a Error Reporting API .

    Ative a API

Instale a biblioteca de cliente

Com a biblioteca do Error Reporting para PHP, você pode monitorar e visualizar os erros relatados por aplicativos PHP em execução em praticamente qualquer lugar.

Para mais informações sobre a instalação, leia a documentação da biblioteca do Error Reporting para PHP (em inglês). Além disso, use o rastreador de problemas (em inglês) para informá-los.

Configurar a biblioteca de cliente

É possível personalizar o comportamento da biblioteca do Error Reporting para PHP. Consulte a configuração da biblioteca para ver uma lista das opções possíveis.

Executar apps no Google Cloud

Para criar grupos de erros usando projects.events.report, sua conta de serviço exige o papel Gravador do Error Reporting (roles/errorreporting.writer).

Alguns serviços do Google Cloud concedem automaticamente o papel de Gravador do Error Reporting (roles/errorreporting.writer) à conta de serviço adequada. No entanto, você precisa conceder esse papel à conta de serviço apropriada para alguns serviços.

Ambiente flexível do App Engine

O App Engine concede automaticamente o papel Gravador do Error Reporting (roles/errorreporting.writer) à sua conta de serviço padrão.

A biblioteca do Error Reporting para PHP pode ser usada sem a necessidade de fornecer credenciais explicitamente.

Para ativar o Error Reporting no ambiente flexível do App Engine, siga estas etapas:

  1. Instale as bibliotecas necessárias com o comando a seguir:

    $ composer require google/cloud-error-reporting
  2. Adicione a seguinte linha à seção runtime_config em app.yaml:

enable_stackdriver_integration: true

Em seguida, a biblioteca coleta automaticamente todos os erros e exceções não identificadas no Error Reporting. Se você estiver usando uma biblioteca da Web que instala os próprios gerenciadores de exceção, consulte a seção Integrações de framework para mais informações.

Google Kubernetes Engine

Para usar o Error Reporting com o Google Kubernetes Engine, faça o seguinte:

  1. Verifique se a conta de serviço a ser usada pelo contêiner recebeu o papel Gravador do Error Reporting (roles/errorreporting.writer).

    É possível usar a conta de serviço padrão do Compute Engine ou uma conta de serviço personalizada.

    Para informações sobre como conceder papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

  2. Crie o cluster e conceda a ele o escopo de acesso cloud-platform.

    Por exemplo, o comando create a seguir especifica o escopo de acesso cloud-platform e uma conta de serviço:

    gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
    

Compute Engine

Para usar o Error Reporting com instâncias de VM do Compute Engine, faça o seguinte:

  1. Verifique se a conta de serviço a ser usada pela instância de VM recebeu o papel Gravador do Error Reporting (roles/errorreporting.writer).

    É possível usar a conta de serviço padrão do Compute Engine ou uma conta de serviço personalizada.

    Para informações sobre como conceder papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

  2. No painel de navegação do console do Google Cloud, selecione Compute Engine e, depois, Instâncias de VM:

    Acessar Instâncias de VM

  3. Selecione a instância de VM em que você quer receber o escopo de acesso cloud-platform.

  4. Clique em Parar e em Editar.

  5. Na seção Identidade e acesso à API, selecione uma conta de serviço que tenha o papel Gravador do Error Reporting (roles/errorreporting.writer).

  6. Na seção Escopos de acesso, selecione Permitir acesso completo a todas as APIs do Cloud e salve as alterações.

  7. Clique em Iniciar / retomar.

Exemplo

1. Instale as bibliotecas de nuvem com o seguinte comando:

$ composer require google/cloud-error-reporting
2. Adicione a seguinte linha ao seu php.ini, em que WORKSPACE é o caminho absoluto para o diretório raiz do seu espaço de trabalho:
auto_prepend_file='/WORKSPACE/vendor/google/cloud-error-reporting/src/prepend.php'

Esse arquivo de prefixo instala um gerenciador de exceções e um gerenciador de erros que enviam erros automaticamente ao Error Reporting.

Se você estiver usando o ambiente flexível do App Engine, consulte Ambiente flexível do App Engine nesta página.

Executar apps em um ambiente de desenvolvimento local

Para usar a biblioteca do Error Reporting para PHP em um ambiente de desenvolvimento local, como a execução da biblioteca na sua própria estação de trabalho, é preciso fornecer a biblioteca do Error Reporting para PHP com as credenciais padrão do aplicativo local. Para mais informações, consulte Autenticar no Error Reporting.

Para usar as amostras de PHP nesta página de um ambiente de desenvolvimento local, instale e inicialize a CLI gcloud e, em seguida, configure o Application Default Credentials com as credenciais de usuário.

  1. Instale a CLI do Google Cloud.
  2. Para inicializar a CLI gcloud, execute o seguinte comando:

    gcloud init
  3. Crie as credenciais de autenticação para sua Conta do Google:

    gcloud auth application-default login

Veja mais informações em: Configurar a autenticação para um ambiente de desenvolvimento local.

O método projects.events.report também aceita chaves de API. Se você quiser usar chaves de API na autenticação, não será necessário configurar um arquivo local do Application Default Credentials. Veja mais informações em Crie uma chave de API na documentação de autenticação do Google Cloud.

Como visualizar relatórios de erros

No painel de navegação do console do Google Cloud, selecione Error Reporting e escolha seu projeto do Google Cloud:

Acessar o Error Reporting

Para mais informações, consulte Como visualizar erros.

Integrações de biblioteca

Algumas bibliotecas da Web substituem o gerenciador de exceções. Veja a seguir exemplos para ativar o Error Reporting com o Symfony e o Laravel. Para outras estruturas, você pode usar Google\Cloud\ErrorReporting\Bootstrap::exceptionHandler como o manipulador de exceção.

Laravel

Editar a função report no arquivo app/Exceptions/Handler.php da seguinte maneira:

public function report(Exception $exception)
{
    if (isset($_SERVER['GAE_SERVICE'])) {
        // Ensure Stackdriver is initialized and handle the exception
        Bootstrap::init();
        Bootstrap::exceptionHandler($exception);
    } else {
        parent::report($exception);
    }
}

Também é preciso adicionar uma instrução use de uma linha no início do arquivo:

use Google\Cloud\ErrorReporting\Bootstrap;

Symfony

Crie um novo arquivo src/AppBundle/EventSubscriber/ExceptionSubscriber.php com o seguinte conteúdo:

// src/AppBundle/EventSubscriber/ExceptionSubscriber.php
namespace AppBundle\EventSubscriber;

use Google\Cloud\ErrorReporting\Bootstrap;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
use Symfony\Component\HttpKernel\KernelEvents;

class ExceptionSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents()
    {
        // return the subscribed events, their methods and priorities
        return [KernelEvents::EXCEPTION => [
            ['logException', 0]
        ]];
    }

    public function logException(ExceptionEvent $event)
    {
        $exception = $event->getThrowable();
        Bootstrap::exceptionHandler($exception);
    }
}