Política de registro de atividades

Editar online

Configure a política de log da atividade para gerenciar o nível de detalhes dos dados armazenados em eventos da API (interface de programação de aplicativos)

Ao configurar uma API na IU do API Manager , você escolhe quais dados são armazenados nos registros de eventos da API para chamadas para essa API com a propriedade activity log A propriedade activity log possui configurações separadas para chamadas API bem-sucedidas e para chamadas API com falha. As opções de log de atividades são:
  • none - os eventos da API não são registrados.
  • activity - Registra o URI do recurso da API. activity é a configuração de log padrão para chamadas de API bem-sucedidas
  • header - registra o URI do recurso da API e os cabeçalhos HTTP.
  • payload - Registra o URI do recurso da API, cabeçalhos HTTP e payloads de solicitação e resposta. payload é a configuração de log padrão para as chamadas API com falha, pois a carga útil de resposta pode ter informações úteis sobre a causa da falha.
Nota:

Se o seu gateway estiver configurado para autenticar todas as chamadas de API com um provedor OAuth, os dados relacionados à chamada OAuth só serão incluídos nos dados do evento de API quando a chamada OAuth falhar. A autenticação bem-sucedida do OAuth não é registrada nos dados de eventos da API.

Importante: o tamanho máximo do registro de eventos da API é de 19 Mb. O subsistema de análise rejeita qualquer registro de evento de API maior que 19 Mb.

Definindo a configuração de log na UI do API Manager

  1. Na visualização Desenvolver da UI do API Manager , selecione a API com a qual deseja trabalhar. Se você não estiver familiarizado com a visualização “Desenvolver” da interface do usuário do API Manager, consulte “Trabalhando com definições de API ”.
  2. Selecione a guia Gateway , expanda Configurações de Gateway e Portale, em seguida, selecione Log de Atividades.
  3. Selecione Ativado, em seguida, selecione a configuração de log preferencial para Conteúdo de Sucesso e Conteúdo de Erro:
    • none - os eventos da API não são registrados.
    • activity - Registra o URI do recurso da API. activity é a configuração de log padrão para chamadas de API bem-sucedidas
    • header - registra o URI do recurso da API e os cabeçalhos HTTP.
    • payload - Registra o URI do recurso da API, cabeçalhos HTTP e payloads de solicitação e resposta. payload é a configuração de log padrão para as chamadas API com falha, pois a carga útil de resposta pode ter informações úteis sobre a causa da falha.
  4. Clique em Save (Salvar ) para salvar suas alterações.

Definindo a configuração de log na origem para DataPower® API Gateway

Use a extensão activity-log para configurar suas preferências de criação.

activity-log:
  success-content: <success log setting: none, activity, header, payload>
  error-content: <failure log setting: none, activity, header, payload>
  enabled: <if activity logging is enabled: true or false>
Nota: se a criação de log de carga útil estiver ativada, o gateway para capturar o armazenamento em buffer de cargas úteis também deverá ser ativado.
activity-log:
  success-content: <success log setting: none, activity, header, payload>
  error-content: <failure log setting: none, activity, header, payload>
  enabled: <if activity logging is enabled: true or false>
buffering: true
Exemplo
Sem registro de chamadas bem-sucedidas, registro de cabeçalho para chamadas com falha
activity-log:
    success-content: none
    error-content: header
    enabled: true
Desativar criação de log de atividade
activity-log:
    enabled: false