Configurando a criação de log de atividade

Editar online

É possível configurar suas preferências de criação de log para a atividade da API que é armazenada no Analytics, substituindo o comportamento de criação de log de atividade padrão.

Sobre essa tarefa

Nota: esta tarefa está relacionada à configuração de uma definição de API do OpenAPI 2.0 Para obter detalhes sobre como configurar uma definição de API OpenAPI 3.0 , consulte Editando uma definição de API OpenAPI 3.0.

É possível concluir essa tarefa usando o aplicativo da UI do API Designer ou usando a UI do API Manager baseado em navegador.

Um registro de eventos da API existe para cada evento de execução da API no servidor Gateway. Por padrão, o tipo de conteúdo para uma execução de API bem-sucedida é atividade, e carga útil para uma chamada de API que resulta em um código de erro. Ao editar as definição da API, é possível alterar o tipo de conteúdo a ser registrado nesses registros de evento de API. Durante a execução da API, os dados de atividade são armazenados na variável de contexto log , que preenche o registro de eventos da API na conclusão da execução da API; para obter informações adicionais, consulte Variáveis de contexto de criação de log da atividade da API.

Nota:

A criação de log de atividades que chama a criação de log de dados de Analítica no caso de êxito não se aplica ao provedor OAuth. O provedor OAuth registra dados de Analítica para casos de falha, mas não registra casos bem-sucedidos.

A qualquer momento, você pode acessar diretamente o arquivo YAML de origem do ` OpenAPI ` clicando no ícone "Fonte Ícone de origem OpenAPI". Para voltar ao formulário de criação, clique no ícone Ícone de formulárioFormulário.

Procedimento

  1. Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 2.0 ..
  2. Selecione a guia Gateway , expanda Configurações de Gateway e Portale, em seguida, clique em Log de Atividades.
  3. Selecione Ativadoe, em seguida, selecione as opções para os campos Conteúdo de Êxito e Conteúdo de Erro conforme a seguir:
    Tabela 1. Nome do campo e Descrição
    Rótulo do campo Descrição
    Conteúdo de sucesso Define o tipo de conteúdo a ser registrado quando a operação é bem-sucedida.
    • none: indica que não ocorrerá nenhuma criação de log.
      Restrição: esta opção desativa as notificações para os desenvolvedores de aplicativos que utilizam o seu Portal do Desenvolvedor.
    • activity: somente chamada de logs; somente o URI do recurso é registrado.
    • cabeçalho : Registra a atividade e o cabeçalho; os cabeçalhos HTTP, além do URI do recurso, são registrados.
    • carga útil: registra atividade, cabeçalho e carga útil; todas as informações, incluindo a carga útil que é recebida em uma solicitação ou retornada em uma resposta, são registradas.

    O valor padrão é activity.
    Conteúdo de erro Indica qual conteúdo deverá ser registrado quando ocorrer um erro.
    • none: indica que não ocorrerá nenhuma criação de log.
      Restrição: esta opção desativa as notificações para os desenvolvedores de aplicativos que utilizam o seu Portal do Desenvolvedor.
    • activity: somente chamada de logs; somente o URI do recurso é registrado.
    • cabeçalho : Registra a atividade e o cabeçalho; os cabeçalhos HTTP, além do URI do recurso, são registrados.
    • carga útil: registra atividade, cabeçalho e carga útil; todas as informações, incluindo a carga útil que é recebida em uma solicitação ou retornada em uma resposta, são registradas.

    O valor padrão é payload.
    Cabeçalho de solicitação preservado Clique em Incluir para especificar cabeçalhos de solicitação customizados a serem preservados para criação de log para analítica.
    Cabeçalho de resposta preservado Clique em Incluir para especificar cabeçalhos de resposta customizados a serem preservados para criação de log para analítica.
  4. Clique em Salvar para salvar as mudanças.