Adicionando Registro em Log a Implantações de API

Usando a Console para Configurar e Ativar Logs no Oracle Cloud Infrastructure Logging

Para configurar e ativar logs de implantação de API usando a Console para armazenar logs no Oracle Cloud Infrastructure Logging:

1. Crie ou atualize uma implantação de API usando a Console, selecione a opção Criar implantação e informe detalhes na página Informações Básicas.

   Para obter mais informações, consulte Implantando uma API em um Gateway da API Criando uma Implantação de API e Updating an API Gateway.

2. Na seção Políticas de registro de API da página de Informações básicas, especifique uma das seguintes opções como o nível de log de execução para registrar informações sobre o processamento no gateway da APIs:

   • Informações: Registre um resumo de cada estágio de processamento. Esta é a opção padrão.
   • Advertência: Registre somente erros transitórios que ocorrem durante o processamento. Por exemplo, uma redefinição de conexão.
   • Erro: Registre somente erros persistentes que ocorrem durante o processamento. Por exemplo, um erro interno ou uma chamada para uma função que retorna uma mensagem 404.

3. Selecione Próximo duas vezes para informar detalhes de rotas individuais na implantação de API na página Rotas, selecione Adicionar rota e Mostrar Políticas de Registro em Log de Rota.

4. Especifique uma das seguintes opções como a Substituição do Nível de Log da Execução que se aplica a uma rota individual:

   • Herdado da implantação: Herda o nível de log de execução da implantação de API.
   • Informações: Registre um resumo de cada estágio de processamento.
   • Advertência: Registre somente erros transitórios que ocorrem durante o processamento. Por exemplo, uma redefinição de conexão.
   • Erro: Registre somente erros persistentes que ocorrem durante o processamento. Por exemplo, um erro interno ou uma chamada para uma função que retorna uma mensagem 404.
5. Selecione Próximo para revisar os detalhes informados para a implantação de API.
6. Selecione Criar ou Atualizar para criar ou atualizar a implantação de API.

   A implantação de API é mostrada na página de detalhes da implantação de API.

7. Na guia Logs, selecione Ativar log no menu Ações (três pontos) ao lado da categoria de log (Logs de Execução ou Logs de Acesso) para a qual você deseja criar e ativar um novo log de implantação de API no serviço Oracle Cloud Infrastructure Logging no painel de entrada Criar Log:
   • Compartimento: Por padrão, o compartimento atual.
   • Grupo de logs: Por padrão, o primeiro grupo de logs no compartimento.
   • Nome de log: Por padrão, <deployment-name>_execution ou <deployment-name>_access, dependendo de qual categoria você seleciona.
   • Retenção de logs: O período de retenção padrão para o log em incrementos de 30 dias, até um máximo de 180 dias.
   Para obter mais informações, consulte Ativando o Registro em Log para um Recurso.
8. Selecione Ativar log para criar o novo log e ativá-lo.

Editando um Arquivo JSON para Definir o Nível de Log de Execução para Logs Armazenados no Oracle Cloud Infrastructure Logging

Para editar a especificação de implantação de API em um arquivo JSON para definir o nível de log dos logs de execução armazenados no Oracle Cloud Infrastructure Logging:

1. Usando seu editor JSON preferencial, edite a especificação existente de implantação da API na qual você deseja definir o nível de log para logs de execução armazenados no Oracle Cloud Infrastructure Logging ou crie uma nova especificação da implantação da API (consulte Criando uma Especificação de Implantação da API).

   No mínimo, a especificação de implantação de API incluirá uma seção routes contendo:

   • Um caminho. Por exemplo, /hello
   • Um ou mais métodos. Por exemplo, GET
   • Uma definição de um back-end. Por exemplo, um URL ou o OCID de uma função no OCI Functions.

   Por exemplo, a seguinte especificação básica de implantação de API define uma função simples sem servidor Hello World no OCI Functions como um único back-end:

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         }
       }
     ]
   }

2. (Opcional) Para definir o nível de log para logs de execução que se aplica globalmente a todas as rotas na especificação de implantação de API:

   1. Insira uma seção loggingPolicies antes da seção routes. Por exemplo:

      
      {
        "loggingPolicies": {},
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

   2. Especifique o nível de detalhe a ser registrado sobre o processamento dentro do gateway de API para todas as rotas, incluindo a política executionLog na seção loggingPolicies e definindo a propriedade logLevel como uma das seguintes:

      • INFO para registrar um resumo de cada estágio do processamento.
      • WARN para registrar somente erros transitórios que ocorrem durante o processamento. Por exemplo, uma redefinição de conexão.
      • ERROR para registrar somente erros persistentes que ocorrem durante o processamento. Por exemplo, um erro interno ou uma chamada para uma função que retorna uma mensagem 404.

      Por exemplo:

      
      {
        "loggingPolicies": {
          "executionLog": {
            "logLevel": "INFO"
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

3. (Opcional) Para definir o nível de log para logs de execução de uma rota específica (substituindo o nível de log de execução global herdado da implantação da API):

   1. Insira uma seção loggingPolicies após a seção backend da rota. Por exemplo:

      
      {
        "loggingPolicies": {
          "executionLog": {
            "logLevel": "INFO"
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "loggingPolicies": {}
          }
        ]
      }

   2. Especifique o nível de detalhe a ser registrado sobre o processamento dentro do gateway de API para a rota incluindo a política executionLog na seção loggingPolicies e definindo a propriedade logLevel como uma das seguintes opções:

      • INFO para registrar um resumo de cada estágio do processamento.
      • WARN para registrar somente erros transitórios que ocorrem durante o processamento. Por exemplo, uma redefinição de conexão.
      • ERROR para registrar somente erros persistentes que ocorrem durante o processamento. Por exemplo, um erro interno ou uma chamada para uma função que retorna uma mensagem 404.

      Por exemplo:

      
      {
        "loggingPolicies": {
          "executionLog": {
            "logLevel": "INFO"
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
               "type": "ORACLE_FUNCTIONS_BACKEND",
               "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            },
            "loggingPolicies": {
              "executionLog": {
                "logLevel": "ERROR"
              }
            }
          }
        ]
      }

4. Salve o arquivo JSON que contém a especificação de implantação de API.

5. Use a especificação de implantação de API ao criar ou atualizar uma implantação de API das seguintes formas:

   • especificando o arquivo JSON na Console quando você seleciona a opção Fazer Upload de uma API de implantação existente
   • especificando o arquivo JSON em uma solicitação à API REST do serviço API Gateway

   Para obter mais informações, consulte Implantando uma API em um Gateway de API por meio da Criação de uma Implantação de API.

6. Tendo definido o nível de log para logs de execução, siga as instruções em Ativando o Registro em Log para um Recurso para criar e ativar um novo log de implantação de API no serviço Oracle Cloud Infrastructure Logging.

Exibindo Logs no Oracle Cloud Infrastructure Logging

Você pode exibir o conteúdo de um log da implantação de API no Oracle Cloud Infrastructure Logging na página de detalhes da implantação de API. Na guia Logs, selecione o nome do log que você deseja exibir.

Como alternativa, você pode exibir o conteúdo de um log de implantação da API na página Pesquisa de Log do Oracle Cloud Infrastructure Logging. Consulte Como Obter Detalhes de um Log.

Para obter mais informações sobre o conteúdo dos logs de acesso e execução, consulte:

• Log de Acesso de Implantação de API
• Log de Execução de Implantação de API