Página de registros de API en Jitterbit API Manager

Introducción

La página de Registros de API en el Administrador de API muestra una tabla con todos los registros de procesamiento de API y registros de depuración (si la depuración está habilitada). Se generan registros para APIs personalizadas, OData y proxy cuando se llaman a través del gateway de API en la nube o un gateway de API privado. Cuando una API activa una operación de Studio, los registros de operación resultantes también aparecen en la página de Registros de API, además de la vista de registros de operación de Studio y la página de Runtime de la Consola de Administración.

Las llamadas a la API generan cuatro tipos de registros:

• Registros de API: El Administrador de API genera automáticamente registros de API en la página de Registros de API para cada llamada a la API del Administrador de API. Los registros de API contienen información sobre la llamada a la API, incluyendo la marca de tiempo de la solicitud de API, el código de estado HTTP, el ID de solicitud, el método de solicitud, la URI de solicitud, el tiempo de respuesta, la IP de origen de la aplicación que llama, la aplicación de origen y cualquier mensaje de registro.

• Registros de depuración de API: Información de seguimiento detallada que muestra cada paso del procesamiento de la solicitud a través de la URL del servicio de una API del Administrador de API. La depuración de registros de API no está habilitada por defecto y debe habilitarse en una API del Administrador de API individual. Para habilitar el registro de depuración, consulte la pestaña de Configuración en la configuración de API personalizada, la configuración de API OData o la configuración de API proxy.

• Registros detallados de la API: Datos de carga útil de solicitud y respuesta recibidos o enviados a través de la URL del servicio de una API del API Manager. El registro detallado de la API no está habilitado por defecto y debe habilitarse en cada API del API Manager de forma individual. Para habilitar el registro detallado, consulte la pestaña Configuración en configuración de API personalizada, configuración de API OData o configuración de API proxy.

• Registros de operación del agente privado: Información sobre llamadas a la API escritas en el archivo jitterbit.log del agente privado ubicado en el directorio log. Estos registros contienen el inicio de una llamada a la API y el tiempo transcurrido. Los registros de operación del agente privado se configuran en el archivo de configuración del agente privado.

Para agregar información adicional de registro para APIs OData, incluyendo datos SQL enviados a la base de datos, edite el archivo de configuración del agente privado y establezca DebugJDML en true.

Acceder a la página de registros de la API

Para acceder a la página de Registros de la API, use el menú del portal Harmony para seleccionar API Manager > Registros de la API.

Controles de registros de la API

La página de Registros de la API tiene controles para filtrar los datos mostrados en la tabla de registros, establecer el rango de tiempo y gestionar el diseño de la tabla.

Puede ajustar los datos mostrados utilizando los controles de consulta guardada, la barra de búsqueda, el menú de rango de tiempo y los íconos de la barra de herramientas.

Consultas

La barra de búsqueda le permite filtrar las entradas de registro según los criterios que se enumeran a continuación. Ingrese uno o más términos de búsqueda en la barra de búsqueda para filtrar la tabla de entradas de registro.

Los términos de búsqueda utilizan uno de dos operadores:

• =: Devuelve entradas de registro donde el campo coincide con el valor.
• !=: Devuelve entradas de registro donde el campo no coincide con el valor.

Se admiten patrones comodín con ambos operadores:

• value%: Coincide con entradas donde el campo comienza con el valor.
• %value%: Coincide con entradas donde el campo contiene el valor.
• %value: Coincide con entradas donde el campo termina con el valor.

Estos son los criterios de búsqueda admitidos:

Combinar consultas

Las consultas pueden contener una combinación de criterios. Los criterios de búsqueda combinados deben estar separados por un punto y coma (;) entre cada criterio. Los operadores = y != se pueden usar juntos en la misma búsqueda. Estos son ejemplos de búsquedas combinadas válidas:

message=%Access Denied%;requesturi=%contacts%;

requestid=%yzaccwui%;message=%REJECT%;
requesturi=%contacts%;responsetime<=2;
responsetime>=5;sourceapp=%Chrome%;
responsetime>=5;sourceip=70.5%;
sourceapp=%Chrome%;message=%REJECT%;

sourceapp=%Mozilla%;responsetime<=1;

sourceip=70.5%;requesturi=%contacts%;

sourceapp!=Mozilla%;message=%REJECT%;
sourceapp!=%Chrome%;responsetime<=2;
message!=%Access Denied%;requesturi=%contacts%;
sourceip!=70.5%;sourceapp=%Chrome%;

Consultas guardadas

Las consultas se pueden guardar y reutilizar, luego editar o eliminar:

• Guardar una consulta: Haz clic en Guardar consulta. Se abre un formulario de consulta:

  • Nombre: Ingresa un nombre para la consulta guardada.
  • Consulta: Los términos de búsqueda actuales se completan automáticamente. Edita o agrega términos de consulta utilizando la misma sintaxis que la barra de búsqueda. Haz clic en el campo para mostrar una lista de términos de búsqueda disponibles, o escribe un término seguido de un punto y coma.

  Haz clic en Guardar para guardar la consulta.

• Usar una consulta guardada: Haz clic en Consultas guardadas para abrir la lista de consultas guardadas, luego haz clic en una consulta para aplicarla. Los términos de búsqueda se aplican a la barra de búsqueda y los resultados se actualizan automáticamente.

  Nota

  Los valores del rango de fechas de una consulta guardada se aplican al selector de período de tiempo, no a la barra de búsqueda.

• Editar una consulta guardada: Haz clic en Consultas guardadas, luego haz clic en el ícono Editar para la consulta que deseas editar. Actualiza el nombre o los términos de consulta, luego haz clic en Guardar.

• Eliminar una consulta guardada: Haz clic en Consultas guardadas, luego haz clic en el ícono Eliminar para la consulta que deseas eliminar. Confirma la eliminación cuando se te solicite.

Selector de período de tiempo

El selector de período de tiempo muestra el rango de tiempo actualmente seleccionado (por ejemplo, Últimas 24 horas) y te permite ajustar el marco de tiempo de los datos de registro de la API:

Haz clic en el selector de período de tiempo para abrir un diálogo con dos pestañas: Relativo y Absoluto.

Pestaña Relativa

La pestaña Relativa proporciona rangos de tiempo preestablecidos y un selector de período de tiempo relativo personalizado:

Selecciona uno de los rangos de tiempo preestablecidos:

• Últimas 24 horas: Muestra los datos de registro de API de las últimas 24 horas.

• Últimas 48 horas: Muestra los datos de registro de API de las últimas 48 horas.

• Últimas 72 horas: Muestra los datos de registro de API de las últimas 72 horas.

Para crear un período de tiempo relativo personalizado, utiliza los controles en la parte inferior del diálogo:

• Campo de número: Ingresa el número de unidades de tiempo (por ejemplo, 1, 7, 30).

• Desplegable de unidad: Selecciona la unidad de tiempo de Minutos, Horas, Días, Semanas o Meses.

• Cancelar: Cierra el diálogo sin aplicar cambios.

• Aplicar: Aplica el rango de tiempo seleccionado y cierra el diálogo.

Pestaña Absoluta

La pestaña Absoluta permite seleccionar un rango de fecha y hora específico dentro de los últimos 30 días:

El rango de fechas seleccionado se muestra en la parte superior del diálogo en el formato MM/DD/YYYY, HH:mm am/pm - MM/DD/YYYY, HH:mm am/pm.

Configura el rango de fecha y hora utilizando los siguientes controles:

• Campo de hora de inicio: Muestra la hora de inicio para el rango. Haz clic en para borrar, o haz clic en para ajustar la hora.

• Campo de hora de fin: Muestra la hora de fin para el rango. Haz clic en para borrar, o haz clic en para ajustar la hora.

• Selector de calendario: Usa el calendario para seleccionar las fechas de inicio y fin. Navega entre meses utilizando las flechas izquierda y derecha.

• Cancelar: Cierra el diálogo sin aplicar cambios.

• Aplicar: Aplica el rango de fecha y hora seleccionado y cierra el diálogo.

Controles adicionales

Controles adicionales aparecen en el lado derecho de la barra de herramientas:

• Descargar como CSV: Haz clic para descargar los datos del registro actual basados en los filtros y criterios de búsqueda aplicados.

  Nota

  El campo de fecha dentro del archivo CSV es un timestamp UNIX que requerirá conversión si deseas usar un formato de fecha y hora diferente.

• Actualizar: Haz clic para actualizar los datos del registro basados en los filtros y criterios de búsqueda aplicados.

• Filtrar columnas: Haz clic para cambiar la visibilidad y el orden de las columnas. El panel lateral de Columnas se abre con los siguientes controles:

  • Buscar: Ingresa parte o la totalidad de un nombre de columna para reducir la lista a aquellas que coincidan con el texto.

  • Mostrar todo: Hacer visibles todas las columnas.

  • Mover: Arrastra y suelta para cambiar la posición de la columna en relación con las demás.

  • Visible: La columna se muestra en la tabla. Haz clic para ocultarla.

  • Oculta: La columna no se muestra en la tabla. Haz clic para mostrarla.

  • Guardar: Guarda cualquier cambio en las columnas.

  • Cancelar: Cierra el editor de columnas sin guardar cambios.

Configuración de la página

La esquina superior derecha de la página contiene el interruptor de Vista del árbol de ejecución y el ícono de Configuración:

• Vista del árbol de ejecución: Interruptor para controlar cómo se muestran los resultados de búsqueda en la jerarquía padre-hijo de las entradas del registro. Cuando está habilitado, los resultados de búsqueda incluyen toda la cadena de ejecución para cada entrada coincidente: si la coincidencia es una entrada de registro de API, se muestran todas sus entradas de operación hijas; si la coincidencia es una entrada de operación, también se muestra su entrada de registro de API padre y cualquier operación hermana o hija. Cuando está deshabilitado, solo se muestran las entradas que coinciden directamente con los criterios de búsqueda, sin padres ni hijos.

• Configuración: Haz clic para abrir el panel de Configuración. Selecciona un intervalo de actualización automática, uno de Nunca (el predeterminado), 1 minuto, 5 minutos, 15 minutos o 30 minutos, y luego haz clic en Guardar.

Tabla de entradas de registro

Cada fila en la tabla de Registros de API muestra datos de registro para una llamada a la API o una operación desencadenada por esa llamada.

Las siguientes columnas están disponibles:

Pasa el cursor sobre una entrada de registro para revelar las acciones disponibles. Las acciones difieren según el tipo de registro:

Para entradas de registro de API personalizada, API proxy y API OData:

• Ver: Abre los detalles del registro de API.
• Abrir API: Abre la API en el Administrador de API.

Para entradas de registro de Operación:

• Ver: Abre los detalles del registro de API.
• Cancelar operación: Habilitado para operaciones que están en estado Enviado, Recibido, Pendiente o En ejecución. Cancelar operación envía una solicitud al agente para detener la operación. Una vez clicado, el estado Cancelación solicitada se muestra junto al estado de operación en tiempo real.
• Ir a operación: Abre el proyecto en Studio y selecciona la operación. Esta acción está disponible solo para operaciones de Studio, no para operaciones de Design Studio.

Cuando hay más de 100 entradas de registro, se dividen en páginas de 100 cada una. Usa los botones de navegación Página anterior y Página siguiente en la parte inferior de la tabla para moverte entre las páginas.

Detalles del registro de API

Para ver detalles adicionales o registros de depuración (si están habilitados) para una entrada de registro, haz clic en la entrada en la tabla. Se abre un panel en la parte inferior de la página con las siguientes pestañas, dependiendo del tipo de registro:

• Entradas de registro de API personalizada, API proxy y API OData: Mensajes y Registro de depuración.
• Entradas de registro de Operación: Mensajes, Registros de actividad y Registro de depuración.

El panel se titula Mensajes y Registros y muestra el nombre, estado, hora de inicio, hora de finalización y duración de la entrada de registro seleccionada.

Pestaña de Mensajes

El contenido de la pestaña Mensajes varía según el tipo de registro de la entrada seleccionada.

Entradas de registro de API

Cuando se selecciona una entrada de registro de API personalizada, API proxy o API OData, la pestaña Mensajes muestra detalles sobre la llamada a la API en las siguientes secciones colapsables: Información de la API, Información de la llamada, Registro de la llamada y Carga útil de la API (cuando está habilitado).

Información de la API

La sección de Información de la API muestra los siguientes detalles:

• API: El nombre de la API que activó la operación. Haz clic en para abrir la configuración de la API en una nueva pestaña en el Administrador de API.

• Versión: El número de versión de la API.

• Tipo de API: El tipo de la API, uno de los siguientes:

  • CUSTOM_API: Una API personalizada creada en el Administrador de API.
  • ODATA: Una API OData creada en el Administrador de API.

• Método de solicitud: El método HTTP utilizado para la llamada a la API. Los valores posibles incluyen GET, POST, PUT, DELETE, PATCH y MERGE.

• ID de solicitud de API: Un identificador único para la solicitud de API. Puedes usar este ID para correlacionar registros entre diferentes sistemas y para buscar solicitudes específicas. Haz clic en para copiar el valor.

• IP de origen: La dirección IP de la aplicación cliente o servidor que realizó la solicitud de API.

• Puerta de enlace de API: La puerta de enlace de API que procesó la solicitud. Este campo muestra el nombre de dominio de la puerta de enlace de API en la nube o puerta de enlace de API privada que manejó la llamada a la API.

• URL del servicio de API: La URL completa para llamar a la API, incluyendo la URL base, raíz del servicio, versión y cualquier parámetro de ruta. Esta es la URL del servicio de API completa tal como la consume el cliente.

• Aplicación de origen: La aplicación o navegador que realizó la solicitud a la API.

Información de la llamada

La sección de Información de la llamada muestra los encabezados de solicitud HTTP enviados con la llamada a la API bajo la etiqueta Encabezados de solicitud. Cada encabezado se muestra como un par clave-valor, como accept, accept_encoding, content_length, fulluri, host, user_agent y encabezados de reenvío.

Registro de llamadas

La sección de Registro de llamadas muestra mensajes de registro a nivel de sistema generados durante el procesamiento de la solicitud a la API. Haga clic en para copiar el registro en su portapapeles.

Carga útil de la API

La sección de Carga útil de la API muestra los datos de carga útil de solicitud y respuesta para la llamada a la API. Esta sección es visible cuando uno o ambos de los siguientes están habilitados en la pestaña de Configuración de la API: Habilitar modo de depuración hasta o Mostrar cargas útiles de solicitud y respuesta en los registros.

La sección se divide en dos paneles:

• Cuerpo de la solicitud: La carga útil enviada con la solicitud a la API.

• Cuerpo de la respuesta: La carga útil devuelta por la API. Si la carga útil de la respuesta excede el límite de visualización, se muestra con una etiqueta (Truncada).

Cada panel proporciona los siguientes controles:

• Buscar: Buscar en la carga útil una cadena específica.

• Copiar: Copiar la carga útil en su portapapeles.

• Descargar: Descargar la carga útil como un archivo.

Entradas del registro de operaciones

Cuando se selecciona una entrada de registro de Operación, la pestaña de Mensajes muestra lo siguiente:

• Registros de origen: Al usar una actividad de FTP o Base de datos como origen, se muestra el conteo de registros que se han leído del sistema de origen. Para otros conectores, el conteo muestra 0 independientemente del número de registros de origen.

• Registros de destino: Al usar una actividad de FTP o Base de datos como destino, se muestra el conteo de registros que se han publicado en el sistema de destino. Para otros conectores, el conteo muestra 0 independientemente del número de registros de destino.

• Mensaje: Detalles del registro para la operación, incluyendo cualquiera de los siguientes:

  • Mensajes generados por el sistema que indican que la operación se completó sin errores.
  • Mensajes de información y advertencia devueltos por los sistemas de origen o destino.
  • Advertencias de validación devueltas por los servicios de transformación, validación y scripting de Jitterbit.
  • Mensajes definidos por el usuario generados por la herramienta Invoke Operation (cuando Raise error if operation fails está habilitado) o la función WriteToOperationLog().

  Nota

  • Las fechas y horas en los mensajes de registro aparecen en su formato original del origen y no se convierten a la hora local del navegador.
  • Los mensajes de registro que exceden ~100 KB de tamaño (~99,000 caracteres) son truncados, denotados con message truncated apareciendo al final del registro.

  Haz clic en para copiar o para descargar los mensajes de registro.

• Mensajes registrados en scripts de pre-transformación: Mensajes generados durante la ejecución de scripts de pre-transformación. Haz clic en para copiar o para descargar.

Pestaña de Registros de Actividad

La pestaña Registros de Actividad contiene enlaces a archivos de éxito o fracaso creados por actividades de Salesforce, Salesforce Service Cloud, o ServiceMax que se ejecutan en un agente privado. Los archivos están en formato CSV. Haz clic en un enlace para descargar.

Los archivos de registro de actividad se eliminan automáticamente después de 14 días por el servicio de limpieza de archivos del agente privado. Puedes cambiar este comportamiento en la sección [ResultFiles] del archivo de configuración del agente privado jitterbit.conf, o cambiando las reglas del servicio de limpieza de archivos.

Los descargas del registro de actividad están deshabilitadas para los agentes en la nube. Puede ver enlaces de descarga, pero intentar descargar genera un mensaje de error.

Pestaña de Registro de Depuración

Cuando el registro de depuración está habilitado a nivel de operación (para agentes en la nube o para agentes privados) y la operación se ejecutó en un agente 10.48 o posterior, esta pestaña muestra los detalles de la jerarquía completa de ejecución de una operación de Studio. La vista del registro de operaciones muestra una vista dividida con los registros de operaciones en el panel izquierdo y la información detallada del registro para la operación seleccionada en el panel derecho. La vista utiliza los controles de tabla seleccionados para filtrar resultados. Si las operaciones están encadenadas con acciones de operación o la función RunOperation, esas operaciones se enumeran bajo la operación principal.

Cuando el registro de depuración de operaciones está habilitado, esta pestaña también puede mostrar datos de entrada y salida de componentes y datos de solicitud y respuesta de API (cuando la operación es activada por una API del API Manager). La carga útil de solicitud y respuesta se incluye solo cuando Mostrar cargas útiles de solicitud y respuesta en los registros también está habilitado en la pestaña de Configuración de la API.

Las operaciones principales (y cualquier operación secundaria debajo de ellas) se ordenan en orden ascendente por Iniciado. La tabla se puede ordenar (solo para operaciones de nivel superior) por Nombre, Iniciado, Finalizado, Duración o Estado haciendo clic en la fila de encabezado respectiva.

Cuando abre la vista del registro de operaciones, el primer registro de operación en la lista se selecciona por defecto. La información detallada del registro para esta operación aparece en el panel derecho.

• Nombre: El nombre de la operación o paso de operación. Los símbolos de flecha, que se pueden usar para expandir o colapsar filas adicionales, se muestran en las operaciones principales y en las operaciones para las cuales están disponibles los datos de entrada y salida de componentes:

• Operaciones padre: Cuando se expande una operación padre, aparecen filas adicionales para sus operaciones hijo en el orden en que se ejecutaron. Por defecto, todas las operaciones padre están expandidas. Utiliza los íconos colapsar lista o expandir lista para colapsar o expandir todas las operaciones padre.

• Iniciado: La fecha y hora en que la operación o paso de operación comenzó a ejecutarse, mostrada como la hora local del navegador.

• Finalizado: La fecha y hora en que la operación o paso de operación dejó de ejecutarse, mostrada como la hora local del navegador.

• Duración: El tiempo transcurrido entre Iniciado y Finalizado, reportado en segundos para operaciones y en milisegundos para pasos de operación.

• Estado: El estado de la operación o paso de operación. Para una lista completa de posibles estados, consulta la tabla de detalles de operación.

• Acciones: Estas acciones están disponibles para operaciones (no para pasos de operación):

  • Cancelar operación: Habilitado para operaciones que están en estado Enviado, Recibido, Pendiente o Ejecutándose. Cancelar operación envía una solicitud al agente para detener la operación. Una vez clicado, se muestra el estado Cancelación Solicitada junto al estado de operación en tiempo real.

    Nota

    Las operaciones que tienen un estado Cancelación Solicitada pueden seguir ejecutándose.

  • Ir a operación: Abre el proyecto en Studio y selecciona la operación.

• Actualizar: Haz clic para actualizar la lista de registros de operaciones.

• Filtrar Columnas: Haz clic para abrir un panel que te permite reordenar las columnas o ajustar su visibilidad en el panel de lista de operaciones:

  

  • Mostrar Todo: Hacer visibles todas las columnas.

  • Mover: Arrastra y suelta para cambiar la posición de la columna en relación con las demás.

  • Ocultar: La columna es visible. Haz clic para ocultarla.

• Mostrar: La columna está oculta. Haz clic para mostrarla.

• Redimensionar columnas: Arrastra la barra de Redimensionar de una columna para cambiar su tamaño.

• Registro de operaciones: Para mostrar u ocultar un registro de una operación individual, haz clic en una operación de la lista.

  • Mensajes de registro: Los mensajes de registro incluyen los detalles del registro para la operación seleccionada. La visualización de los mensajes de registro depende de los permisos y niveles de acceso del usuario actual y de si el registro en la nube está habilitado. Para más información, consulta la pestaña Mensajes más arriba en esta página.

    Nota

    Las fechas y horas mostradas dentro de los mensajes de registro no se convierten a la hora local del navegador, sino que se informan en su formato original desde la fuente del mensaje de registro.

  • Copiar: Copia los datos del registro en tu portapapeles.

  • Descargar: Descarga los mensajes de registro como un archivo de texto.
  • Mostrar / ocultar: Muestra u oculta los mensajes de registro.

Datos de entrada y salida del componente

Los datos de entrada y salida del componente se generan cuando una operación tiene habilitado el registro de depuración a nivel de operación (para agentes en la nube o para agentes privados) y la operación se ejecutó en un agente 10.48 o posterior.

Cuando hay datos de entrada y salida de componentes presentes, se muestra una representación gráfica de la operación o paso de operación en el panel de lista de operaciones.

Se muestran íconos para actividades y transformaciones utilizadas como pasos de operación. Se puede hacer clic en un paso de operación para mostrar u ocultar los datos de entrada y salida del componente para ese paso de operación individual. Cada entrada de registro de entrada y salida está limitada a 100 MB. Si los datos de una entrada de registro de entrada o salida individual superan los 100 MB, no se mostrará ningún dato.

• Buscar: Busca los datos para el texto ingresado.
• Copiar: Copia los datos del registro en tu portapapeles.
• Descargar: Descarga los datos de entrada o salida como un archivo en el formato de datos apropiado. El archivo se nombra con el nombre del paso de operación seguido de _input o _output según corresponda.

Datos de solicitud y respuesta de la API

Cuando una operación es activada por un API personalizado del API Manager o un API OData, la cantidad de información mostrada en los detalles de la entrada de registro depende de qué configuraciones estén habilitadas:

Para habilitar el registro de depuración de operaciones, consulta registro de depuración de operaciones para agentes en la nube o registro de depuración de operaciones para agentes privados. Para mostrar las cargas útiles de solicitud y respuesta, habilita Mostrar cargas útiles de solicitud y respuesta en los registros en la pestaña Configuración de la API.

API Manager Log Service API (Beta)

Como alternativa a descargar un archivo de registro de API haciendo clic en Descargar como CSV, se pueden recuperar los registros de API programáticamente utilizando el API Manager Log Service API (Beta).