Configurar Coleta de Logs da API REST

O Oracle Log Analytics já fornece a origem de log definida pela Oracle para coleta de logs da API REST. Verifique se você pode usar a origem de API REST definida pela Oracle disponível ou qualquer parser definido pela Oracle. Caso contrário, use as seguintes etapas para criar uma nova origem de log:

Antes de começar, se você precisar criar um novo parser adequado para seus logs, conclua-o. Consulte Criar um Parser.

1. Abra o menu de navegação e clique em Observabilidade e Gerenciamento. Em Log Analytics, clique em Administração.

   Os recursos administrativos são listados no painel esquerdo de navegação em Administração. Clique em Origens.

2. A página Origens é aberta. Clique em Criar Origem.

   Isso exibe a caixa de diálogo Criar Origem.

3. No campo Nome, informe o nome da origem de log.

4. Na lista Tipo de Origem, selecione REST API.

5. Clique em Tipo de Entidade e selecione o tipo que melhor identifica sua aplicação.

6. Clique em Parser e selecione um parser adequado para o tipo de logs que você deseja coletar.

7. Na guia Pontos Finais, clique em Adicionar ponto final de log ou Adicionar ponto final de lista para vários logs, dependendo do seu requisito:

   • Para fornecer um único URL de ponto final de log usando o qual os logs podem ser coletados continuamente, clique em Adicionar ponto final de log. A caixa de diálogo Adicionar ponto final de log é aberta.

     Forneça as seguintes informações:

     1. Informe o Nome do ponto final do log.

     2. Construa o URL de Log para coletar os logs periodicamente. Consulte URL do Ponto Final de Log em Tipos de URL do Ponto Final.

     3. Selecione o método de API GET ou POST.

        Se você tiver selecionado POST, digite o payload POST para o método e selecione o tipo de conteúdo da solicitação em JSON, Text, Javascript, HTML e XML.

     4. Opcionalmente, especifique o URL do servidor proxy de log.

     5. Opcionalmente, clique em Mostrar cabeçalhos de solicitação para expandir a seção e clique em Adicionar para fornecer qualquer cabeçalho de solicitação no formato de pares Nome-Valor.

     6. Opcionalmente, clique em Mostrar parâmetros de consulta para expandir a seção e clique em Adicionar para fornecer qualquer parâmetro de consulta no formato de pares Nome-Valor.

     7. Na seção Credenciais, selecione o Tipo de credencial de log. Consulte Selecionar o Tipo de Credencial para Coleta de Logs da API REST.

     8. Para validar as informações de configuração que você informou, clique em Validar. Se houver erros, corrija-os.

        Clique em Salvar Alterações.

   • Para fornecer um URL que retorne uma resposta JSON com as informações que podem ser usadas para gerar uma lista de URLs de ponto final de log para coletar vários logs, clique em Adicionar ponto final de lista para vários logs. A caixa de diálogo Adicionar ponto final da lista para vários logs é aberta.

     1. Guia Configurar ponto final da lista:

        • Informe o Nome do ponto final da lista de logs.

        • Construa o URL da lista de logs para obter as informações sobre os arquivos de log. Consulte URL do Ponto Final da Lista de Logs em Tipos de URL do Ponto Final. Por exemplo:

          https://example.org/fetchlogfiles_data

        • Opcionalmente, especifique o URL do servidor proxy de log.

        • Selecione o método de API GET ou POST.

          Se você tiver selecionado POST, digite o payload POST para o método e selecione o tipo de conteúdo da solicitação em JSON, Text, Javascript, HTML e XML.

        • Opcionalmente, clique em Mostrar cabeçalhos de solicitação para expandir a seção e clique em Adicionar para fornecer qualquer cabeçalho de solicitação no formato de pares Nome-Valor.

        • Opcionalmente, clique em Mostrar parâmetros de consulta para expandir a seção e clique em Adicionar para fornecer qualquer parâmetro de consulta no formato de pares Nome-Valor.

        • Na seção Credenciais, selecione o Tipo de credencial de log. Consulte Selecionar o Tipo de Credencial para Coleta de Logs da API REST.

        • Clique em Próximo.

     2. Guia Configurar ponto final de log:

        • Informe o Exemplo de resposta do endpoint da lista do log. Este é o exemplo da resposta que você obteria para o ponto final da lista de logs que você forneceu na guia anterior. Por exemplo:

          { "totalSize": 4, "records": [ {"id": "firstId", "type": "firstType"}, {"id": "secondId", "type": "secondType"} ] }

          No exemplo acima, o caminho records[*].id do JSON pode ser usado no URL do ponto final. Para obter mais detalhes sobre variáveis de caminho JSON, consulte Variáveis para Coleta de Logs da API REST.

        • Informe o Nome do ponto final do log.

        • Construa o URL de Log para coletar os logs periodicamente, incorporando as chaves de caminho JSON identificadas na resposta de exemplo ao ponto final da lista de logs. Consulte URL do Ponto Final de Log em Tipos de URL do Ponto Final. Por exemplo:

          https://example.org/fetchLogs?time={START_TIME}&id={testLogListEP:$.records[*].id}

        • Opcionalmente, especifique o URL do servidor proxy de log.

        • Selecione o método de API GET ou POST.

          Se você tiver selecionado POST, digite o payload POST para o método e selecione o tipo de conteúdo da solicitação em JSON, Text, Javascript, HTML e XML.

        • Opcionalmente, especifique o URL do servidor proxy de log.

        • Opcionalmente, clique em Mostrar cabeçalhos de solicitação para expandir a seção e clique em Adicionar para fornecer qualquer cabeçalho de solicitação no formato de pares Nome-Valor.

        • Opcionalmente, clique em Mostrar parâmetros de consulta para expandir a seção e clique em Adicionar para fornecer qualquer parâmetro de consulta no formato de pares Nome-Valor.

        • Na seção Credenciais, selecione o Tipo de credencial de log. Consulte Selecionar o Tipo de Credencial para Coleta de Logs da API REST.

        • Clique em Próximo.

     3. Guia Revisar e adicionar: As informações de configuração fornecidas nas guias anteriores são validadas. Verifique a lista de URLs da qual os logs serão coletados.

        Se houver erros, corrija-os.

        Clique em Salvar.

8. Clique em Criar Origem.

URL do Ponto Final da Lista de Logs: O URL do ponto final da lista de logs deve retornar uma resposta JSON com as informações que podem ser usadas para construir uma lista de URLs de ponto final de log para coletar os logs. Especifique as variáveis de caminho JSON necessárias para criar a lista de pontos finais de log com base na resposta JSON. Além disso, você pode usar as macros {START_TIME} e {CURR_TIME} para inserir os valores de tempo correspondentes dinamicamente no URL.

URL do Ponto Final do Log: O URL do ponto final do log é usado para coletar logs de um ponto final específico da API REST em intervalos regulares. Você pode usar as macros {START_TIME}, {CURR_TIME} e {TIME_WINDOW} para inserir os valores de tempo correspondentes dinamicamente no URL. A macro {OFFSET} pode ser usada para suportar paginação. Você também pode usar variáveis de caminho JSON da resposta da chamada de ponto final da lista de logs para substituir propriedades específicas.

• {START_TIME}: Para especificar o horário em que os logs devem ser coletados
• {OFFSET}: Para tratar a coleta de logs paginada
• {CURR_TIME}: Para fornecer o horário atual
• {TIME_WINDOW}: Para especificar um intervalo ou duração de coleta

Para obter mais informações sobre como usar as macros, consulte START_TIME Macro, CURR_TIME Macro, OFFSET Macro e TIME_WINDOW Macro.

Para obter mais informações sobre como usar as variáveis da resposta do ponto final da lista de logs que podem ser especificadas no URL do ponto final do log, exemplos de caminho JSON e uso de filtros de variáveis, consulte Variáveis para Coleta de Logs da API REST.

Use a macro START_TIME para especificar o horário a partir do qual os logs devem ser coletados. A macro START_TIME pode ser usada em um URL de ponto final, parâmetros de form ou payload POST.

O exemplo a seguir mostra o URL do ponto final que coleta logs com mais de um timestamp especificado pela macro START_TIME:

https://example.org/fetchLogs?sortBy=timestamp&sortOrder=ascending&filter=timestamp+gt+{START_TIME:yyyy-MM-dd'T'HH:mm:ss.SSSZ}

Sintaxe:

{START_TIME<+nX>:<epoch | timestamp format supported by SimpleDateFormat java class>.TZ=<timezone name>}

• n é o valor de hora do intervalo de datas. X é expresso em Dias (D), Horas (h), Minutos (m), Meses (M), Ano (Y).

• +nX é o número de dias, horas, minutos, meses ou anos para adicionar ao horário inicial. É opcional. Por exemplo, +3D.

• Os formatos de hora suportados são os mesmos da classe java SimpleDateFormat. O formato de hora padrão é yyyy-MM-dd'T'HH:mm:ss.SSSZ. Por exemplo, 2001-07-04T12:08:56.235-0700.

  A especificação do formato epoch ou de hora é opcional. Se a época for fornecida, a macro será substituída pelo valor de milissegundo da época.

  Para saber os formatos de timestamp suportados por SimpleDateFormat, consulte Java Platform Standard Ed. 8: Class SimpleDateFormat.

• TZ é para fornecer o fuso horário do timestamp. Não é aplicável se a época já foi fornecida. O formato suportado é o mesmo que os IDs de 3 letras na classe java TimeZone, por exemplo, UTC.

• Você pode incluir várias instâncias dessa macro no URL.

• Exemplos:

  1. {START_TIME:yyyy-MM-dd'T'HH:mm:ss.SSS.TZ=UTC}
  2. {START_TIME:epoch}

O valor da macro START_TIME é determinado de uma das seguintes maneiras:

• Quando a coleta é iniciada pela primeira vez para um ponto final, START_TIME é a data histórica baseada na propriedade de coleta do agente Dados Históricos. O valor padrão dessa propriedade é 30 days, ou seja, o valor do timestamp é 30 dias antes do timestamp atual.

• Se o campo Horário for definido no parser, nas coletas de logs subsequentes, o valor de START_TIME será o valor máximo do valor de timestamp extraído na coleta de logs anterior.

• Se o campo Horário não for extraído dos registros de log definindo-o no parser, o timestamp atual será o valor de START_TIME.

Caso haja filtros na API, use greater than equal to em vez de greater than para garantir que todos os registros de log com o mesmo timestamp sejam submetidos a upload.

Use a macro CURR_TIME para inserir o horário atual no URL do ponto final da API REST, nos parâmetros de form e no payload POST.

O exemplo a seguir mostra o URL do ponto final que usa a macro CURR_TIME no parâmetro de consulta:

https://example.org/fetchLogs?sortBy=timestamp&sortOrder=ascending&time={CURR_TIME:yyyy-MM-dd'T'HH:mm:ss.SSSZ}

• O formato para usar a macro é o mesmo da macro START_TIME.

• Você pode incluir várias instâncias dessa macro no URL.

Use a macro OFFSET para pontos finais que fornecem respostas paginadas ou para tratar o comportamento de deslocamento em uma resposta de API. A macro OFFSET pode ser usada no URL do ponto final da API REST, nos parâmetros de form e no payload POST para extrair várias páginas ou chunks em um único ciclo de coleta de logs.

Formato: {OFFSET(<start value>, <increment>)}

• A macro OFFSET é usada para chamar e coletar dados iterativamente por meio de resultados paginados de um ponto final de log específico para obter todos os registros disponíveis. A chamada inicial da solicitação da API REST começa com o valor inicial e é incrementada em cada chamada subsequente pelo valor de acréscimo. Essas chamadas recursivas baseadas em índice são interrompidas quando não há mais entradas de log encontradas. A compensação não é encaminhada para o próximo ciclo de coleta. Ele começa a partir do valor padrão ou inicial em cada ciclo de coleta.

• No formato acima, o valor de início é o valor inicial do índice e o valor padrão é 0. É opcional especificar o valor inicial.

  Valores possíveis: Inteiro positivo incluindo 0

• No formato acima, increment especifica o valor a ser adicionado ao valor de início nas chamadas subsequentes. O valor padrão é 1. É opcional especificar o valor de incremento.

  Valores possíveis: Somente inteiro positivo. Excluir 0.

• Você pode incluir apenas uma instância dessa macro no URL.

Os exemplos a seguir mostram diferentes maneiras de usar a macro OFFSET:

• {OFFSET}

  Utiliza valores padrão valor inicial = 0, acréscimo = 1.

• {OFFSET(5)}

  valor inicial = 5, acréscimo = 1 (padrão)

• {OFFSET(5,2)}

  valor inicial = 5, acréscimo = 2

O exemplo a seguir mostra o URL do ponto final que usa a macro OFFSET:

https://example.org/fetchLogs?startIndex={OFFSET(0,1000)}&count=1000

No exemplo acima, OFFSET(0,1000) indica que o valor de início é 0 na primeira chamada e, em seguida, nas chamadas subsequentes, incrementado em 1000. Portanto, quando a macro OFFSET for interpretada, o URL do ponto final para várias chamadas será o seguinte:

Primeira chamada: https://example.org/fetchLogs?startIndex=0&count=1000

Segunda chamada: https://example.org/fetchLogs?startIndex=1000&count=1000

Use a macro TIME_WINDOW para especificar o intervalo de coleta no qual os logs devem ser coletados. Ele pode ser usado no URL do ponto final da API REST para extrair logs em minutos, horas ou dias, independentemente do intervalo de coleta do agente. Por exemplo, se a janela de tempo for 1d (um dia) e o intervalo do agente for 10 minutos, a coleta de logs subsequente ocorrerá somente após um dia.

O exemplo a seguir define o intervalo de coleta de logs por 6 horas especificando TIME_WINDOW como 6h no URL do ponto final:

https://example.org/fetchLogs?timewindow={TIME_WINDOW(6h)}

Formato: {TIME_WINDOW(<number><timeunit>)}

No formato acima:

• número: Número de dígito maior que zero.

• unidade de tempo: h para horas, d para dias, m para minutos. O valor padrão é d (dias).

Certifique-se de que o intervalo de coleta do agente seja menor que o intervalo de tempo fornecido. Você só pode usar a macro TIME_WINDOW uma vez no ponto final.

Use as variáveis para substituir atributos fornecidos como parte da resposta pelo ponto final da lista de logs na solicitação do ponto final do log dinamicamente no run-time. As variáveis podem ser usadas no URL, nos parâmetros de form, no payload POST ou nos valores de cabeçalho de solicitação HTTP do ponto final de log.

Se a chamada para o ponto final da lista de logs falhar, as mensagens de log do ponto final de log não serão coletadas por causa da dependência.

Formato da variável no ponto final do log:

{<log_list_endpoint_name>:<json path(<filter_field_name>='<value>')>}

• No formato acima, log_list_endpoint_name é o nome do ponto final da lista de logs.

  O filtro (<filter_field_name>=<value>) é opcional. Somente o atributo que corresponde ao filter_field_name é selecionado na resposta JSON do ponto final da lista de logs e usado no ponto final do log. Por exemplo:

  https://www.example.com/log/{foo:$.items[*].links[*].href(rel='self')}

  Para obter um exemplo detalhado do filtro, consulte Exemplo de filtro.

• Somente o tipo de conteúdo JSON é suportado para extrair os valores de propriedade.

• A mesma variável pode ser especificada várias vezes.

• As variáveis só podem fazer referência a pontos finais de lista válidos e não a pontos finais de log.

• Os seguintes formatos de caminho JSON são suportados: Caminho JSON Simples, Caminho JSON de Array e Caminho JSON de Vários Arrays.

{
    "foo" : 
    {
        "abc" : "result"
    }
}

{
    "foo" : {
        "id" : "id1"
    },
    "foo2" : {
        "ID" : "id2",
        "id" : "id3"
    }
}

{
    "foo" : {
        "id" : "id1",
        "abcd" : "value1"
    },
    "foo2" : {
        "id" : "id2"
    }
}

{
     "records": [
         {"id": "firstId", "type":"firstType"},
         {"id":"secondId", "type":"secondType"}
     ],
     "items": [
         {"name":"firstName", "field":"value"},
         {"name":"secondName", "field":"value"},
         {"name":"thirdName", "field":"value"}
     ]
}

https://www.example.com/url_list

{
  "records": [ { "id": "firstId", "type": "firstType" }, { "id": "secondId", "type": "secondType" } ],
  "items": [ { "name": "firstName", "field": "value" }, { "name": "secondName", "field": "value" }, { "name": "thirdName", "field": "value" } ]
}

https://www.example.com/{getlist:$.records[*].id}/{getlist:$.items[*].name}

{
    "items": [
        {
            "BusinessEventCode": "JournalBatchApproved",
            "CreationDate": "2019-07-27T17:19:19.261+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "/erpBusinessEvents/self/100100120766717"
                },
                {
                    "rel": "canonical",
                    "href": "/erpBusinessEvents/rel/100100120766717"
                }
            ]
        }
    ]
}

https://www.example.com/log/{foo:$.items[*].links[*].href(rel='self')}

https://www.example.com/log/erpBusinessEvents/self/100100120766717

Para autorizar uma conexão entre o agente e a origem da API REST, primeiro configure a credencial da API no armazenamento de credenciais do agente. Depois de configurar as credenciais de origem no serviço Management Agent no lado do agente, você pode usar essas informações ao criar a origem de log da API REST.

Para configurar as credenciais de origem no serviço Management Agent para permitir que o Management Agent colete dados do host que emite log, consulte Credenciais de Origem do Management Agent.

Ao adicionar o ponto final do log ou o ponto final da lista de logs, forneça as informações da credencial no workflow selecionando o Tipo de credencial do log. Selecione uma entre as seguintes opções:

• Nenhum
• Autenticação Básica: Especifique o Nome da credencial de log da credencial criada no serviço Management Agent.
• Token Estático: Especifique o Nome da credencial de log da credencial criada no serviço Management Agent.
• Token Dinâmico (OAuth 2.0):

  Especifique o Nome da credencial do token do token criado no serviço Management Agent. Além disso, forneça as informações do token como Nome do Ponto Final do Token, URL do Ponto Final do Token, Tipo de Concessão e, opcionalmente, Escopo.

  Se o proxy de token for igual ao do ponto final do log, mantenha a caixa de seleção Proxy igual ao ponto final do log ativada. Caso contrário, desative a caixa de seleção e forneça o URL do servidor proxy do token.

Mapeamento de tipos de credencial para o tipo de autenticação:

As seguintes informações estão incluídas nos propriedades de armazenamento confiávelssl:

• "ssl_trustStoreType": Tipo de armazenamento, por exemplo, JKS.

• "ssl_trustStoreLocation": O caminho do armazenamento confiável

• "ssl_trustStorePassword": Senha do armazenamento confiável (opcional)

Observe os seguintes aspectos sobre os atributos no JSON da credencial:

• source: O valor deve ser lacollector.la_rest_api

• name: Qualquer nome adequado para a credencial em um dos formatos a seguir.

  • <cred_name>.<entity_name>: nome da credencial com nome da entidade
  • <cred name>: apenas o nome da credencial

  O agente procura o nome no primeiro formato. Se não for encontrado, ele procurará o nome no segundo formato.

• type: Deve ser um dos valores especificados na coluna Tipo de Credencial no Agente de Gerenciamento na tabela de tipos de credenciais acima.

Consulte Exemplos de JSON de Credenciais.

{
  "source":"lacollector.la_rest_api",
  "name":"ExampleRestAPICreds",
  "type":"HTTPSBasicAuthCreds",
  "description":"These are HTTPS (BasicAuth) credentials.",
  "properties":
  [
    { "name":"HTTPSUserName", "value":"CLEAR[admin]" },
    { "name":"HTTPSPassword", "value":"CLEAR[myHTTPSPassword]" }
  ]
}

{
  "source":"lacollector.la_rest_api",
  "name":"ExampleRestAPICreds",
  "type":"HTTPSCreds",
  "description":"These are HTTPS (BasicAuth) credentials.",
  "properties":
  [
    { "name":"HTTPSUserName", "value":"CLEAR[admin]" },
    { "name":"HTTPSPassword", "value":"CLEAR[myHTTPSPassword]" },
    { "name":"ssl_trustStoreType", "value":"JKS" },
    { "name":"ssl_trustStoreLocation", "value":"/scratch/certs/mycert.keystore" },
    { "name":"ssl_trustStorePassword", "value":"mySSLPassword" }
  ]
}

{
  "source":"lacollector.la_rest_api",
  "name":"ExampleRestAPICreds",
  "type":"HTTPSTokenCreds",
  "description":"These are HTTPS (Token) credentials.",
  "properties":
  [
    { "name": "HTTPSToken", "value": "CLEAR[token value]" },
    {"name": "HTTPSTokenType", "value": "CLEAR[Bearer]" }
  ]
}

{
  "source":"lacollector.la_rest_api",
  "name":"ExampleRestAPICreds",
  "type":"HTTPSTokenCreds",
  "description":"These are HTTPS (Token) credentials.",
  "properties":
  [
    { "name": "HTTPSToken", "value": "CLEAR[token value]" },
    {"name": "HTTPSTokenType", "value": "CLEAR[Bearer]" },
    { "name":"ssl_trustStoreType", "value":"JKS" },
    { "name":"ssl_trustStoreLocation", "value":"/scratch/certs/mycert.keystore" },
    { "name":"ssl_trustStorePassword", "value":"mySSLPassword" }
  ]
}

Siga estas etapas para coletar os Logs de Auditoria do Fusion Applications. Para obter a lista de origens disponíveis definidas pela Oracle para Fusion Applications, consulte Origens Definidas pela Oracle.

Tópicos:

• Pré-requisitos
• Configurar a Coleta de Logs de Auditoria do Fusion Applications