Loading
Aprimorar o Salesforce com código
Configurar sinalizadores de rastreamento do acionador e classe do Apex

Configurar sinalizadores de rastreamento do acionador e classe do Apex

Você pode configurar uma classe do Apex ou acionar um sinalizador de rastreamento na Configuração do Salesforce, no Developer Console ou criando objetos da API do conjunto de ferramentas com comandos do Salesforce CLI. Esses sinalizadores de rastreamento têm o tipo de log de depuração CLASS_TRACING e substituem os níveis de log de depuração dos sinalizadores de rastreamento USER_DEBUG e DEVELOPER_LOG.

Edições obrigatórias

Disponível em: Salesforce Classic (não disponível em todas as organizações) e Lightning Experience
Disponível em: Enterprise, Performance, Unlimited, Developer e Database.com Editions
Permissões necessárias ao usuário
Para usar o Developer Console: API ativada E Visualizar todos os dados
Para exibir, reter e excluir registros de depuração: Visualizar todos os dados
Para executar anônimo no Apex: Criar Apex
Para salvar as alterações às classes de Apex e acionadores: Criar Apex
Para usar o Salesforce CLI e executar consultas da API do conjunto de ferramentas: API ativada
Dica
Dica Para obter um exemplo aplicado de uso de classe do Apex e sinalizadores de rastreamento de acionador, consulte Filtragem de registro de depuração para classes do Apex e acionadores do Apex.

Criar sinalizadores de rastreamento do acionador e classe do Apex em Configuração

Nota
Nota Embora você possa configurar uma classe do Apex ou acionar um sinalizador de rastreamento em Configuração, esses sinalizadores de rastreamento não aparecem na lista de registros na página Registros de depuração. A página mostra apenas tipos de log USER_DEBUG e DEVELOPER_LOG, não tipos de CLASS_TRACING. Você ainda pode acessar os tipos de registro de CLASS_TRACING criados em Configuração na classe do Apex ou na página Configuração do acionador, no Developer Console ou com a API do conjunto de ferramentas.
  1. Em Configuração, insira Registros de depuração na caixa Busca rápida e clique em Registros de depuração.
  2. Clique em Novo.
  3. Para Tipo de entidade rastreada, selecione Classe do Apex ou Acionador do Apex.
  4. Para Nome da entidade rastreada, insira o nome da classe do Apex ou do acionador ao qual você deseja adicionar um sinalizador de rastreamento.
  5. Para definir um período durante o qual o sinalizador de rastreamento está ativo, insira uma Data de início e uma Data de expiração.
  6. Para definir um perfil de nível de depuração, insira o nome de um perfil de nível de depuração que você já definiu ou clique em Novo nível de depuração.

    Se você clicar em Nível de depuração, uma nova janela será aberta. Para definir um novo perfil de nível de depuração, na nova janela, insira um nome para o perfil de nível de depuração. Em seguida, selecione um nível de registro de depuração para cada categoria de registro de depuração. Salve suas alterações.

  7. Salve o sinalizador de rastreamento.

Visualizar, editar ou excluir a classe do Apex e acionar sinalizadores de rastreamento em Configuração

  1. Navegue para a classe do Apex apropriada ou acione a página Configuração.
    1. Para sinalizadores de rastreamento de classe do Apex, em Configuração, insira Classes do Apex na caixa Busca rápida e clique em Classes do Apex.
    2. Para sinalizadores de rastreamento de acionador do Apex, em Configuração, insira Acionadores do Apex na caixa Busca rápida e clique em Acionadores do Apex.
  2. Clique no nome da classe do Apex ou do acionador que deseja examinar.
  3. Clique na opção desejada.
    1. Para criar um sinalizador de rastreamento, clique em Novo. Em seguida, insira uma data de início, uma data de expiração e um perfil de nível de depuração para o sinalizador de rastreamento.
    2. Para excluir um sinalizador de rastreamento, na coluna Ação do sinalizador de rastreamento, clique em Excluir.
    3. Para modificar a data de início, a data de expiração ou o perfil de nível de depuração de um sinalizador de rastreamento, clique em Editar.
    4. Para modificar os níveis de depuração de um sinalizador de rastreamento, clique em Filtros. Em seguida, selecione o nível de depuração desejado para cada categoria.
    5. Para excluir todos os sinalizadores de rastreamento da classe ou do acionador do Apex, clique em Excluir tudo.
  4. Salve suas alterações.

Criar sinalizadores de rastreamento do acionador e classe do Apex no Developer Console

  1. No Developer Console, clique em Debular | Alterar níveis de log....
    A janela Alterar níveis de registro no Developer Console, em que você pode definir sinalizadores de rastreamento de depuração.
  2. Na seção Substituições de rastreamento de acionador e classe, clique em Adicionar.
  3. Selecione a classe ou o acionador ao qual deseja adicionar um sinalizador de rastreamento.
  4. Para definir um período durante o qual o sinalizador de rastreamento está ativo, clique na célula Data de início da classe ou do acionador e insira ou selecione uma hora de início válida. Em seguida, clique na célula Data de expiração e insira ou selecione uma hora de término válida.
  5. Para definir um perfil de nível de depuração, clique em Adicionar/Alterar na célula DebugLevel Action da classe ou do acionador. Em seguida, execute uma destas ações.
    1. Para definir o nível de depuração para um perfil de nível de depuração que você já definiu, clique no nome do perfil de nível de depuração para que sua linha seja destacada. Então clique em Concluído.
    2. Para ajustar os níveis de depuração de um perfil de nível de depuração que você já definiu, clique no nome do perfil de nível de depuração para que sua linha seja destacada. Selecione um novo nível de depuração nos menus suspensos para cada categoria de registro de depuração que você deseja ajustar. Então clique em Concluído.
    3. Para adicionar um novo perfil de nível de depuração, clique em Adicionar. Na nova janela, insira um Nome de DebugLevel. Em seguida, selecione um nível de depuração nos menus suspensos para cada categoria de registro de depuração. Clique em Adicionar e depois em Concluído.
    4. Para excluir um perfil de nível de depuração, clique no nome do perfil de nível de depuração e, em seguida, clique em Remover. Então clique em Concluído.
      Aviso: Essa ação remove o perfil de registro de depuração de todos os sinalizadores de rastreamento atribuídos.
    A janela Alterar DebugLevel no Developer Console, em que você pode criar e modificar perfis de nível de log de depuração.

Criar sinalizadores de rastreamento do acionador e classe do Apex usando os comandos do Salesforce CLI

Nota
Nota Quando possível, alteramos termos não inclusivos para estarem alinhados ao valor de igualdade da nossa empresa. Mantivemos alguns termos para evitar qualquer efeito sobre as implementações do cliente.
  1. Se você não tiver um perfil de nível de depuração existente que deseje usar, crie primeiro um registro DebugLevel com a API do conjunto de ferramentas usando o comando sf data create record. Substitua os valores de espaço reservado pelo nome desejado do perfil de nível de depuração e o nível de depuração desejado para cada categoria de registro de depuração.
    sf data create record --use-tooling-api --sobject DebugLevel --values "DeveloperName='DEBUG_LEVEL_PROFILE_NAME' MasterLabel='DEBUG_LEVEL_PROFILE_NAME' Workflow='FINER' ApexCode='FINE' System='DEBUG' Validation='INFO' Database='INFO' Callout='INFO' Visualforce='INFO' ApexProfiling='INFO'"
  2. Obtenha o ID do registro de DebugLevel para o perfil de nível de depuração usando o comando sf data query. Substitua o valor de espaço reservado pelo DeveloperName do perfil de nível de depuração.
    sf data query --query "SELECT Id FROM DebugLevel WHERE DeveloperName='DEBUG_LEVEL_PROFILE_NAME'"
  3. Obtenha o ID da classe do Apex ou do acionador que deseja rastrear usando o comando sf data query. Substitua o valor de espaço reservado pelo nome da classe ou do acionador do Apex.
    sf data query --query "SELECT Id FROM ApexClass WHERE Name='APEX_CLASS_NAME'" 
  4. Crie um registro de TraceFlag com a API do conjunto de ferramentas. Substitua os valores de espaço reservado.
    sf data create record --use-tooling-api --sobject TraceFlag --values "TracedEntityId='APEX_CLASS_OR_TRIGGER_ID' DebugLevelId='DEBUG_LEVEL_ID' LogType='CLASS_TRACING' StartDate='START_TIME_UTC' ExpirationDate='END_TIME_UTC'"
  5. Se ainda não tiver feito isso, crie outro registro de TraceFlag no usuário cujas ações você deseja rastrear. Classe do Apex ou sinalizadores de rastreamento do acionador não geram registros de depuração sozinhos.
    sf data create record --use-tooling-api --sobject TraceFlag --values "TracedEntityId='USER_ID' DebugLevelId='DEBUG_LEVEL_ID' LogType='USER_DEBUG' StartDate='START_TIME_UTC' ExpirationDate='END_TIME_UTC'"

Para trabalhar com registros de depuração, use estes comandos:

  • Para buscar o registro especificado ou determinado número de registros mais recentes da organização, use o comando apex get log.
  • Para exibir uma lista de IDs e informações gerais sobre logs de depuração, use o comando apex list log.
  • Para ativar um registro de depuração para o usuário atual e transmitir o registro de depuração para o console, use o sf apex tail og command.
 
Carregando
Salesforce Help | Article