Configurar recopilación de logs de API de REST

Oracle Log Analytics ya proporciona un origen de log definido por Oracle para la recopilación de logs de la API de REST. Compruebe si puede utilizar el origen de API de REST definido por Oracle disponible o cualquier analizador definido por Oracle. Si no es así, utilice los siguientes pasos para crear un nuevo origen de log:

Antes de empezar, si debe crear un nuevo analizador que sea adecuado para sus logs, rellénelo. Consulte Creación de un analizador.

1. Abra el menú de navegación y haga clic en Observación y gestión. En Log Analytics, haga clic en Administración.

   Los recursos de administración se muestran en el panel en Administración en la izquierda. Haga clic en Orígenes.

2. Se abre la página Orígenes. Haga clic en Crear origen.

   Aparecerá el cuadro de diálogo Crear origen.

3. En el campo Nombre, introduzca el nombre del origen de log.

4. En la lista Tipo de origen, seleccione API de REST.

5. Haga clic en Tipo de entidades y seleccione el tipo que mejor identifique la aplicación.

6. Haga clic en Analizador y seleccione un analizador adecuado para el tipo de logs que desea recopilar.

7. En el separador Puntos finales, haga clic en Agregar punto final de log o Agregar punto final de lista para varios logs según sus requisitos:

   • Para proporcionar una única URL de punto final de log mediante la que se pueden recopilar continuamente los logs, haga clic en Agregar punto final de log. Se abre el cuadro de diálogo Agregar punto final de log.

     Proporcione la siguiente información:

     1. Introduzca el nombre de punto final de log.

     2. Cree la URL de log para recopilar los logs periódicamente. Consulte URL de punto final de log en Tipos de URL de punto final.

     3. Seleccione el método de API GET o POST.

        Si ha seleccionado POST, introduzca la carga útil de POST para el método y seleccione el tipo de contenido de solicitud de JSON, Text, Javascript, HTML y XML.

     4. De manera opcional, especifique la URL de servidor proxy de log.

     5. Si lo desea, haga clic en Mostrar cabeceras de solicitud para ampliar la sección y haga clic en Agregar para proporcionar cualquier cabecera de solicitud con el formato de pares Nombre-Valor.

     6. Opcionalmente, haga clic en Mostrar parámetros de consulta para ampliar la sección y haga clic en Agregar para proporcionar cualquier parámetro de consulta con el formato de pares Nombre-Valor.

     7. En la sección Credenciales, seleccione el tipo de credencial de log. Consulte Selección del tipo de credencial para la recopilación de logs de API de REST.

     8. Para validar la información de configuración que ha introducido, haga clic en Validar. Si hay errores, corríjalos.

        Haga clic en Guardar cambios.

   • Para proporcionar una URL que devuelva una respuesta JSON con la información que se puede utilizar para generar una lista de URL de punto final de log para recopilar varios logs, haga clic en Agregar punto final de lista para varios logs. Se abre el cuadro de diálogo Agregar punto final de lista para varios logs.

     1. Separador Configurar punto final de lista:

        • Introduzca el nombre de punto final de lista de logs.

        • Cree la URL de lista de logs para obtener la información sobre los archivos log. Consulte URL de punto final de lista de logs en Tipos de URL de punto final. Por ejemplo:

          https://example.org/fetchlogfiles_data

        • De manera opcional, especifique la URL de servidor proxy de log.

        • Seleccione el método de API GET o POST.

          Si ha seleccionado POST, introduzca la carga útil de POST para el método y seleccione el tipo de contenido de solicitud de JSON, Text, Javascript, HTML y XML.

        • Si lo desea, haga clic en Mostrar cabeceras de solicitud para ampliar la sección y haga clic en Agregar para proporcionar cualquier cabecera de solicitud con el formato de pares Nombre-Valor.

        • Opcionalmente, haga clic en Mostrar parámetros de consulta para ampliar la sección y haga clic en Agregar para proporcionar cualquier parámetro de consulta con el formato de pares Nombre-Valor.

        • En la sección Credenciales, seleccione el tipo de credencial de log. Consulte Selección del tipo de credencial para la recopilación de logs de API de REST.

        • Haga clic en Siguiente.

     2. Separador Configurar punto final de log:

        • Proporcione el ejemplo de respuesta de punto final de listas de logs. Este es el ejemplo de la respuesta que obtendría para el punto final de la lista de logs que proporcionó en el separador anterior. Por ejemplo:

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

          En el ejemplo anterior, la ruta de acceso JSON records[*].id se puede utilizar en la URL de punto final. Para obtener más información sobre las variables de ruta de acceso JSON, consulte Variables para la recopilación de logs de API de REST.

        • Introduzca el nombre de punto final de log.

        • Cree la URL de log para recopilar los logs periódicamente mediante la incorporación de las claves de ruta de acceso JSON identificadas en la respuesta de ejemplo al punto final de la lista de logs. Consulte URL de punto final de log en Tipos de URL de punto final. Por ejemplo:

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

        • De manera opcional, especifique la URL de servidor proxy de log.

        • Seleccione el método de API GET o POST.

          Si ha seleccionado POST, introduzca la carga útil de POST para el método y seleccione el tipo de contenido de solicitud de JSON, Text, Javascript, HTML y XML.

        • De manera opcional, especifique la URL de servidor proxy de log.

        • Si lo desea, haga clic en Mostrar cabeceras de solicitud para ampliar la sección y haga clic en Agregar para proporcionar cualquier cabecera de solicitud con el formato de pares Nombre-Valor.

        • Opcionalmente, haga clic en Mostrar parámetros de consulta para ampliar la sección y haga clic en Agregar para proporcionar cualquier parámetro de consulta con el formato de pares Nombre-Valor.

        • En la sección Credenciales, seleccione el tipo de credencial de log. Consulte Selección del tipo de credencial para la recopilación de logs de API de REST.

        • Haga clic en Siguiente.

     3. Separador Revisar y agregar: se valida la información de configuración proporcionada en los separadores anteriores. Verifique la lista de direcciones URL de las que se recopilarán los logs.

        Si hay errores, corríjalos.

        Haga clic en Guardar.

8. Haga clic en Crear origen.

URL de punto final de lista de logs: la URL de punto final de lista de logs debe devolver una respuesta JSON con la información que se puede utilizar para crear una lista de URL de punto final de log para recopilar los logs. Especifique las variables de ruta de acceso JSON necesarias para crear la lista de puntos finales de log a partir de la respuesta de JSON. Además, puede utilizar las macros {START_TIME} y {CURR_TIME} para insertar los valores de tiempo correspondientes de forma dinámica en la URL.

URL de punto final de log: la URL de punto final de log se utiliza para recopilar logs de un punto final de API de REST específico a intervalos regulares. Puede utilizar las macros {START_TIME}, {CURR_TIME} y {TIME_WINDOW} para insertar los valores de tiempo correspondientes de forma dinámica en la URL. La macro {OFFSET} se puede utilizar para soportar la paginación. También puede utilizar variables de ruta de acceso JSON de la respuesta de la llamada de punto final de lista de logs para sustituir propiedades específicas.

• {START_TIME}: para especificar la hora desde la que se deben recopilar los logs
• {OFFSET}: para manejar la recopilación de logs paginados
• {CURR_TIME}: para proporcionar la hora actual
• {TIME_WINDOW}: para especificar un intervalo de recopilación o una duración

Para obtener más información sobre el uso de las macros, consulte START_TIME Macro, CURR_TIME Macro, OFFSET Macro y TIME_WINDOW Macro.

Para obtener más información sobre el uso de las variables de la respuesta de punto final de lista de logs que se pueden especificar en la URL de punto final de log, ejemplos de ruta de acceso JSON y el uso de filtros de variables, consulte Variables para la recopilación de logs de API de REST.

Utilice la macro START_TIME para especificar el tiempo desde el que se deben recopilar los logs. La macro START_TIME se puede utilizar en una URL de punto final, parámetros de formulario o carga útil POST.

En el siguiente ejemplo se muestra la URL de punto final que recopila logs superiores a un registro de hora especificado por la macro START_TIME:

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

Sintaxis:

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

• n es el valor de tiempo del rango de fechas. La X se expresa en Días (D), Horas (h), Minutos (m), Meses (M), Año (Y).

• +nX es el número de días, horas, minutos, meses o años que se agregarán a la hora de inicio. Es opcional. Por ejemplo, +3D.

• Los formatos de hora soportados son los mismos que los de la clase java SimpleDateFormat. El formato de hora por defecto es yyyy-MM-dd'T'HH:mm:ss.SSSZ. Por ejemplo, 2001-07-04T12:08:56.235-0700.

  La especificación del formato de hora o epoch es opcional. Si se proporciona una época, la macro se sustituye por un valor de milisegundos de época.

  Para conocer los formatos de registro de hora admitidos por SimpleDateFormat, consulte Java Platform Standard Ed. 8: Class SimpleDateFormat.

• TZ sirve para proporcionar la zona horaria del registro de hora. No es aplicable si ya se ha proporcionado una época. El formato admitido es el mismo que los ID de 3 letras de la clase java TimeZone, por ejemplo UTC.

• Puede incluir varias instancias de esta macro en la URL.

• Ejemplos:

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

El valor de la macro START_TIME se determina de una de las siguientes maneras:

• Cuando la recopilación se inicia por primera vez para un punto final, START_TIME es la fecha histórica basada en la propiedad de recopilación de agentes Datos históricos. El valor por defecto de esta propiedad es 30 days, es decir, el valor del registro de hora es 30 días antes que el registro de hora actual.

• Si el campo Hora está definido en el analizador, en las recopilaciones de logs posteriores, el valor de START_TIME es el valor máximo del valor de registro de hora extraído en la recopilación de logs anterior.

• Si el campo Hora no se extrae de los registros de log definiéndolo en el analizador, el registro de hora actual es el valor de START_TIME.

En caso de que haya filtros en la API, utilice greater than equal to en lugar de greater than para asegurarse de que se cargan todos los registros de log que tengan el mismo registro de hora.

Utilice la macro CURR_TIME para insertar la hora actual en la URL de punto final de la API de REST, los parámetros de formulario y la carga útil POST.

En el siguiente ejemplo se muestra la URL de punto final que utiliza la macro CURR_TIME en el parámetro de consulta:

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

• El formato para utilizar la macro es el mismo que el de la macro START_TIME.

• Puede incluir varias instancias de esta macro en la URL.

Utilice la macro OFFSET para puntos finales que proporcionan respuestas paginadas o para manejar el comportamiento de desplazamiento en una respuesta de API. La macro OFFSET se puede utilizar en la URL de punto final de la API de REST, los parámetros de formulario y la carga útil POST para recuperar varias páginas o fragmentos en un único ciclo de recopilación de logs.

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

• La macro OFFSET se utiliza para llamar y recopilar datos de forma iterativa sobre los resultados paginados de un punto final de log específico para obtener todos los registros disponibles. La llamada de solicitud de API de REST inicial comienza con el valor de inicio y se incrementa en cada llamada posterior por el valor de incremento. Estas llamadas basadas en índices recursivos se paran cuando no se encuentran más entradas de log. El desplazamiento no se traslada al siguiente ciclo de toma. Comienza a partir del valor por defecto o inicial en cada ciclo de recopilación.

• En el formato anterior, el valor de inicio es el valor inicial del índice y el valor por defecto es 0. Es opcional especificar el valor de inicio.

  Valores posibles: entero positivo, incluido 0

• En el formato anterior, incremento especifica el valor que se agregará al valor de inicio en las llamadas posteriores. El valor por defecto es 1. Es opcional especificar el valor de incremento.

  Valores posibles: solo entero positivo. Excluir 0.

• Solo puede incluir una instancia de esta macro en la URL.

Los siguientes ejemplos muestran diferentes formas de utilizar la macro OFFSET:

• {OFFSET}

  Utiliza los valores predeterminados valor de inicio = 0, incremento = 1.

• {OFFSET(5)}

  valor de inicio = 5, incremento = 1 (valor por defecto)

• {OFFSET(5,2)}

  valor de inicio = 5, incremento = 2

En el siguiente ejemplo se muestra la URL de punto final que utiliza la macro OFFSET:

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

En el ejemplo anterior, OFFSET(0,1000) indica que valor de inicio es 0 en la primera llamada y, a continuación, en las llamadas posteriores, incrementado en 1000. Por lo tanto, cuando se interpreta la macro OFFSET, la URL de punto final para varias llamadas sería la siguiente:

Primera llamada: https://example.org/fetchLogs?startIndex=0&count=1000

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

Utilice la macro TIME_WINDOW para especificar el intervalo de recopilación en el que se deben recopilar los logs. Se puede utilizar en la URL de punto final de la API de REST para recuperar logs en minutos, horas o días, independientemente del intervalo de recopilación del agente. Por ejemplo, si la ventana de tiempo es 1d (un día) y el intervalo del agente es de 10 minutos, la recopilación de logs posterior se realiza solo después de un día.

En el siguiente ejemplo se define el intervalo de recopilación de logs durante 6 horas especificando TIME_WINDOW como 6h en la URL de punto final:

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

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

En el formato anterior:

• número: número de dígito mayor que cero.

• timeunit: h para horas, d para días, m para minutos. El valor por defecto es d (días).

Asegúrese de que el intervalo de recopilación de agentes es menor que la ventana de tiempo proporcionada. Puede utilizar la macro TIME_WINDOW solo una vez en el punto final.

Utilice las variables para sustituir atributos proporcionados como parte de la respuesta por el punto final de la lista de logs en la solicitud del punto final de log de forma dinámica en tiempo de ejecución. Las variables se pueden utilizar en los valores de URL, parámetros de formulario, carga útil POST o cabecera de solicitud HTTP del punto final de log.

Si la llamada al punto final de la lista de logs falla, los mensajes de log del punto final de log no se recopilan debido a la dependencia.

Formato de la variable en el punto final de log:

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

• En el formato anterior, log_list_endpoint_name es el nombre del punto final de la lista de logs.

  El filtro (<filter_field_name>=<value>) es opcional. Solo el atributo que coincide con filter_field_name se selecciona de la respuesta JSON del punto final de la lista de logs y se utiliza en el punto final de log. Por ejemplo:

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

  Para obtener un ejemplo detallado del filtro, consulte Ejemplo de filtro.

• Solo está soportado el tipo de contenido JSON para recuperar los valores de propiedad.

• La misma variable se puede especificar varias veces.

• Las variables solo pueden hacer referencia a puntos finales de lista válidos y no a puntos finales de log.

• Están soportados los siguientes formatos de ruta de acceso JSON: ruta de acceso JSON simple, ruta de acceso JSON de matriz y ruta de acceso JSON de varias matrices.

{
    "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 una conexión entre el agente y el origen de la API de REST, primero configure la credencial de API en el almacén de credenciales del agente. Después de configurar las credenciales de origen en el servicio Management Agent en el agente, puede utilizar esta información al crear el origen de log de la API de REST.

Para configurar las credenciales de origen en el servicio Management Agent para permitir que Management Agent recopile datos del host emisor de logs, consulte Credenciales de origen de Management Agent.

Al agregar el punto final de log o el punto final de lista de logs, proporcione la información de credenciales en el flujo de trabajo seleccionando el tipo de credencial de log. Seleccione una de las siguientes opciones:

• Ninguno
• Autenticación básica: especifique el nombre de credencial de log de la credencial que ha creado en el servicio Management Agent.
• Token estático: especifique el nombre de credencial de log de la credencial que ha creado en el servicio Management Agent.
• Token dinámico (OAuth 2.0):

  Especifique el nombre de credencial de token del token que ha creado en el servicio Management Agent. Además, proporcione la información del token, como Nombre de punto final de token, URL de punto final de token, Tipo de otorgamiento y, opcionalmente, Ámbito

  Si el proxy de token es el mismo que el del punto final de log, mantenga activada la casilla de control Proxy igual que el punto final de log. Si no es así, desactive la casilla de control y proporcione la URL de servidor proxy de token.

Asignación de tipos de credenciales al tipo de autenticación:

En propiedades del almacén de confianzassl, se incluye la siguiente información:

• "ssl_trustStoreType": tipo de almacén, por ejemplo, JKS.

• "ssl_trustStoreLocation": ruta del almacén de confianza

• "ssl_trustStorePassword": contraseña de almacén de confianza (opcional)

Tenga en cuenta los siguientes aspectos sobre los atributos en el JSON de credencial:

• source: el valor debe ser lacollector.la_rest_api

• name: cualquier nombre adecuado para la credencial

• type: debe ser uno de los valores especificados en la columna Tipo de credencial en Management Agent de la tabla de tipos de credenciales anterior.

Consulte Ejemplos de JSON de credencial.

{
  "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 estos pasos para recopilar los logs de auditoría de Fusion Applications. Para obtener una lista de los orígenes definidos por Oracle disponibles para Fusion Applications, consulte Orígenes definidos por Oracle.

Temas:

• Requisitos
• Configurar recopilación de logs de auditoría desde Fusion Applications