Esta sección ayuda a los desarrolladores de software que desean desarrollar aplicaciones mediante el uso de herramientas de supervisión de Dotcom-Monitor.
Hay varias maneras de ver e interactuar con los datos de supervisión más allá de la interfaz del sitio web de Dotcom-Monitor, incluido el uso de la fuente XML para consumir datos y la interacción con la API de Dotcom-Monitor para supervisar y actualizar los agentes de supervisión instalados.
Con la fuente XML, los desarrolladores pueden suscribirse a los datos deseados y presentarlos en su propio formato utilizando sus propios informes personalizados. Vea Usar la herramienta XML Reporting Service (XRS) para obtener más información.
Los usuarios de la API Dotcom-Monitor pueden crear sus propios scripts o aplicaciones personalizados para interactuar con la configuración y ver los datos supervisados en su propio entorno personalizado. Nuestro sistema utiliza la API REST que permite la interacción con el sitio web de Dotcom-Monitor mediante programación utilizando los métodos más populares para trabajar con datos a través de solicitudes HTTP (GET, POST, PUT, DELETE). Se puede acceder a casi todos los objetos dotcom-monitor a través de la API REST y se pueden administrar casi todos los aspectos de la funcionalidad del servicio Dotcom-Monitor. Mediante llamadas a la API, los desarrolladores pueden crear y eliminar dispositivos y tareas, posponerlos e iniciarlos, crear y administrar grupos de alertas, plantillas, filtros y programadores, obtener información sobre el estado del dispositivo y muchas otras opciones.
En general, la API Dotcom-Monitor se puede utilizar en las siguientes tareas:
- Integración de terceros con la solución Dotcom-Monitor Monitoring.
- Descarga y carga de datos.
- Modificación de datos.
Las acciones más comunes ejecutadas a través de la API rest:
- Acceso a listas de plataformas de supervisión, dispositivos, destinos, programadores, ubicaciones, grupos de alertas, filtros, plantillas de alertas.
- Acceso a información detallada sobre plataformas, dispositivos y objetivos.
- Edición de dispositivos, destinos, programadores, grupos de alertas y plantillas, filtros.
- Creación de un nuevo objeto puntocom-Monitor (dispositivos, destinos, programadores, etc.).
- Administración de objetos de auditoría.
API
de recopilador personalizadaLa API MetricsView independiente es un conjunto de métodos para cargar métricas de cualquier fuente, independientemente de una plataforma, en Dotcom-Monitor inc. para su posterior procesamiento y análisis.
La API de Dotcom-Monitor se divide en 10 tipos de recursos:
- Plataforma: Todas las tareas de supervisión se dividen en una de las cinco plataformas diferentes.
- Dispositivos: Un dispositivo supervisado es un “conjunto” organizado de tareas de supervisión que contiene una sola tarea de supervisión, una secuencia de tareas de supervisión, un script de supervisión que incluye tareas o una combinación de las tres.
- Tareas: Una tarea es cualquier actividad de monitoreo individual, como monitorear un destino (URL, servidor de correo, servidor FTP, etc.).
- Frecuencia: Define la frecuencia con la que se ejecutarán las sesiones de supervisión.
- Programador: Un programador detalla cuándo se ejecutará o no una tarea.
- Ubicación: Una ubicación de monitoreo disponible dentro de la red de monitoreo de Dotcom-Monitor en todo el mundo.
- Grupo de alertas: La configuración de un grupo coloca a los destinatarios de un informe o alerta en un grupo. Cada destinatario del grupo puede tener una plantilla de alerta única.
- Plantilla de alerta: La plantilla define el formato de las alertas.
- Filtro: Un filtro es un conjunto de reglas que determinan cómo se procesan y muestran las respuestas de supervisión.
- Auditoría: Proporciona información histórica sobre todas y cada una de las modificaciones de la cuenta.
Debe autenticarse en Dotcom-Monitor antes de cualquier solicitud de API. La autenticación expira después de 60 segundos de inactividad.
La tabla siguiente muestra qué tipo de solicitud y acción admite cada tipo de recurso. Consulte la sección Métodos de supervisión para obtener descripciones detalladas.
| Tipo | Método de | URI(s) | Descripción |
|---|---|---|---|
| Plataforma | OBTENER | /Plataformas | Devolver la lista de plataformas disponibles |
| Dispositivo | OBTENER | /Dispositivos/{platform} | Obtenga la lista de dispositivos por plataforma. |
| OBTENER | /dispositivo/{deviceId} | Obtener información del dispositivo | |
| EXPONER | /devices?verbo=PONER | Crear nuevo dispositivo | |
| PONER | /Dispositivos | ||
| EXPONER | /device/{deviceId}/DisableAlert/ | Desactivar alertas | |
| EXPONER | /dispositivo/{deviceId} | Editar dispositivo | |
| EXPONER | /device/{deviceId}?verb=delete | Eliminar dispositivo | |
| BORRAR | /dispositivo/{deviceId} | ||
| Tarea | OBTENER | /device/{deviceid}/tasks | Obtener una lista de tareas en un dispositivo |
| EXPONER | /tareas?verbo=PONER | Crear nueva tarea | |
| PONER | /Tareas | ||
| OBTENER | /tarea/{TaskId} | Obtener información de la tarea | |
| EXPONER | /tarea/{TaskId} | Editar tarea | |
| EXPONER | /task/{TaskId}?verb=delete | Eliminar tarea | |
| BORRAR | /tarea/{TaskId} | ||
| Frecuencia | Obtener | /frequencies/{platform_name} | Obtener freq disponible. por plataforma. |
| Programador | OBTENER | /Programadores | Obtener lista de programadores |
| OBTENER | /Programador/{Scheduler_ID} | Obtener información específica del programador | |
| EXPONER | /schedulers?verbo=PONER | Crear un nuevo programador | |
| PONER | Programadores | ||
| EXPONER | /scheduler/{ ID del programador} | Programador de edición | |
| EXPONER | /programador/{Scheduler_Id}?verbo=eliminar | Eliminar programador | |
| BORRAR | /Programador/{Scheduler_Id} | ||
| Ubicación | OBTENER | /Ubicaciones/{platform_name} | Obtener lista de ubicaciones disponibles |
| Grupo de | OBTENER | /grupos | Obtener lista de grupos de alerta |
| EXPONER | /grupos?verbo=PONER/grupos | Crear grupo de alerta | |
| PONER | Grupos/Grupos | ||
| OBTENER | /Grupo/{Group_ID} | Obtener información del grupo de alertas | |
| EXPONER | /Grupo/{Group_ID} | Editar grupo de alertas | |
| EXPONER | /Grupo/{Group_Id}?verbo=borrar | Eliminar grupo | |
| BORRAR | Grupo/{Group_Id} | ||
| Plantilla de | OBTENER | /Plantillas | Obtener lista de plantillas de alerta |
| EXPONER | /plantillas?verbo=PONER/plantillas | Crear una nueva plantilla de alerta | |
| PONER | /plantillas/plantillas | ||
| OBTENER | /plantilla/{Template_ID} | Obtener información de la plantilla de alerta | |
| EXPONER | /plantilla/{Template_ID} | Editar plantilla de alerta | |
| EXPONER | /template/{Template_Id}?verb=delete | Eliminar plantilla | |
| BORRAR | /plantilla/{Template_Id} | ||
| Filtro | OBTENER | /filtros | Obtener lista de filtros |
| EXPONER | /filtros?verbo=PONER | Crear un nuevo filtro | |
| PONER | /filtros | ||
| OBTENER | /filtro/{filter_ID} | Obtener información específica sobre el filtro | |
| EXPONER | /filtro/{filter_ID} | Filtro de edición | |
| EXPONER | /filter/{filter_ID}?verb=delete | Eliminar filtro | |
| BORRAR | /filtro/{filter_ID} | ||
| Auditoría | OBTENER | /auditoría/lista | Obtenga la lista de objetos auditados para el usuario actual durante las últimas 24 horas. |
| OBTENER | /audit/object/{ID de muestra} | Obtener el contenido de la auditoría para el ID en particular | |
| EXPONER | /auditoría/lista | Obtenga una lista filtrada de objetos auditados. |
-
Web API Monitoring: How to Start and What Approach to Use
Antes de comenzar con el tema Supervisión de API web, hablemos brevemente sobre los enfoques que se usan comúnmente para intercambiar datos entre diferentes tipos de software.
Es difícil imaginar una empresa moderna donde todos los procesos de negocio se ejecutan en un solo producto de software. Por lo general, hay varias aplicaciones de escritorio y web que se utilizan para admitir las operaciones empresariales a lo largo de todo su ciclo de vida. Algunas aplicaciones lista para usar pueden interactuar con productos de software relacionados, mientras que otras necesitan alguna configuración adicional o servicios de terceros. Por ejemplo, las prácticas comunes que se introdujeron en el mercado del software para apoyar la integración de software son:
- Servicios web.
- Intercambio de archivos a través de FTP.
- Solicitudes HTTP no estructuradas.
- Otros enfoques como sockets web, puertos dedicados, etc.
Mientras que todos los demás enfoques de integración de software no tienen procesos estandarizados de intercambio de datos, los servicios web proporcionan una forma estandarizada de integración. Un servicio web es una tecnología que permite a las aplicaciones comunicarse entre sí a través de una red. En pocas palabras, un servicio web es una dirección en Internet, un enlace al que se puede acceder para obtener datos o realizar una acción. Normalmente, los servicios web que se ejecutan a través de HTTP se denominan API web. La ventaja de utilizar HTTP como protocolo de transporte es que hace que los servicios web sean independientes de los lenguajes de programación. En el caso de los servicios web, el cliente que realiza la solicitud al recurso y el servidor api que proporciona la respuesta pueden utilizar cualquier lenguaje de programación o marco. De esta forma no importa si las aplicaciones que queremos conectar se desarrollan utilizando los mismos lenguajes de programación o no.
Las API web se implementan normalmente mediante las siguientes tecnologías:
- XML-RPC (eXtensible Markup Language Remote Procedure Call): el protocolo que utiliza HTTP como protocolo de transporte y XML para codificar las llamadas.
- JSON-RPC (JSON Remote Procedure Call) – un análogo de XML-RPC excepto que los mensajes se transfieren en formato JSON.
- SOAP (Protocolo simple de acceso a objetos): el protocolo estandarizado que utiliza WSDL (Lenguaje de descripción de servicios Web) basado en XML para describir una estructura de mensaje.
- REST (Representational State Transfer) – no es un protocolo sino una arquitectura de interacción de software en una red basada en los métodos del protocolo HTTP.
- Protocolos especializados diseñados para trabajar en una tarea específica, como GraphQL que se utiliza para crear una consulta a un servidor de API y cargar datos de esa API a una aplicación cliente.
¿Qué es la supervisión de API?
Una vez que haya implementado una API web para la aplicación y considere la posibilidad de hacerlo público, debe asegurarse de que todas las funciones de la API funcionan de acuerdo con la lógica de negocios de la aplicación. Además, controlar el rendimiento de la API web es crucial independientemente de si usted mismo es un consumidor del servicio de API o si proporciona el servicio a aplicaciones de terceros. Cualquier degradación en el rendimiento del servicio de API puede causar pérdidas significativas para las empresas relacionadas y afectar a la experiencia de los usuarios.
El propósito principal de la supervisión de API es encontrar y corregir de forma proactiva todos los errores dentro de la API a medida que se producen e incluso antes de que los usuarios los noten.
¿Por qué necesitamos supervisar la API de su aplicación web o sitio web? ¿Por qué las pruebas de iu no son suficientes para asegurarse de que la aplicación web funciona correctamente? Las pruebas de iu realmente son la mejor manera de simular el comportamiento real del usuario (ver las ventajas de las pruebas de aplicaciones web en un navegador real con Dotcom-Monitor EveryStep Scripting Tool). Sin embargo, la funcionalidad del sitio web que tendemos a supervisar a través de la interfaz de usuario generalmente ya se puede comprobar mediante pruebas de supervisión de API. Por ejemplo, una llamada a la API que carga la lista de elementos en stock en la tienda en línea se cambió en el back-end, pero permaneció igual en la interfaz de usuario y el sistema no devolverá la lista en la acción del usuario correspondiente en el sitio web. En este caso, la supervisión de la interfaz de usuario devolverá el error, pero no se detectará el verdadero origen del error (puede ser un problema de conectividad, sobrecarga del servidor, errores de la interfaz de usuario, una llamada a la API incorrecta, etc.). Por otro lado, la supervisión de la API web mostrará que la llamada al punto de conexión de la API de destino no devuelve la respuesta. Para la verificación adicional del resultado de la llamada a la API, se puede usar la validación del contenido de la respuesta.
¿Cómo funciona la supervisión de API?
La supervisión de la API web se centra en los recursos y el acceso a estos recursos. En la API web, los recursos presentan diferentes tipos de información. Se puede acceder a los recursos a través de direcciones URL (localizadores uniformes de recursos). Cuando navega a una dirección URL determinada en el explorador, se conecta al recurso que corresponde a esa dirección URL. Lo mismo sucede cuando envía una solicitud de API a una dirección URL del recurso desde aplicaciones como Postman o mediante CURL. Para dejar claro al servicio web qué acción desea realizar en el recurso, se usan los métodos HTTP, incluidos GET (lectura), POST (crear), PUT (actualizar) y DELETE (eliminar). Consulte Carga rest – Cómo insertar en la API web para obtener una explicación detallada sobre cómo usar Dotcom-Monitor para supervisar las API RESTful.
Cada solicitud va seguida de una respuesta del servidor de API. La respuesta son los datos que se devuelven desde la API en respuesta a la solicitud. Las respuestas pueden devolver datos diferentes, incluido un objeto JSON.
La ruta de acceso completa al recurso que incluye los parámetros de solicitud y proporciona acceso al recurso se denomina punto de conexión de api web. Por ejemplo, el punto de conexión al que se va a enviar una llamada a la API puede tener este aspecto:
http://example.com/wp-json/wp/v2/tests
En pocas palabras, los puntos de conexión son lo que comprobamos al ejecutar llamadas de supervisión de la API web para nuestros sitios web y aplicaciones. En general, los pasos de supervisión de puntos de conexión de API incluyen:
- Solicitud a un extremo.
- Respuesta del servidor de API.
- Verificación y análisis de respuestas.
Beneficios de usar Dotcom-Monitor como su herramienta de monitoreo de API
Dotcom-Monitor es una solución integral que se puede utilizar para todos los tipos de supervisión de API web (consulte cómo configurar la supervisión de servicios web SOAP y la supervisión de API web REST). Además de la supervisión de API, Dotcom-Monitor proporciona herramientas de supervisión para aplicaciones web, sitios web, páginas web individuales, servidores web y otros tipos de recursos web.
Para llevar el proceso de monitoreo a un nuevo nivel, Dotcom-Monitor permite a los usuarios probar sus aplicaciones web de destino en una ventana de navegador real. Las pruebas basadas en explorador garantizan que la prueba de supervisión se ejecute lo más cerca posible de un escenario de la vida real y repita la experiencia real del usuario. Puede elegir entre varios motores de explorador para ejecutar su aplicación o sitio web, incluidos los motores de explorador de escritorio y móviles.
Los informes de rendimiento detallados con gráficos de cascada elemento por elemento, capturas de pantalla y vídeo grabado durante las sesiones de supervisión le brindan una comprensión completa de lo que sucede exactamente detrás de la escena de la interfaz de usuario: qué elementos ralentizan la aplicación y causan los errores y cuellos de botella en su rendimiento.
El sistema de alertas Dotcom-Monitor altamente personalizado le proporciona un servicio de notificación de alertas eficiente. El sistema se puede configurar para enviar notificaciones de alerta a las direcciones dedicadas cuando se detectan errores durante la supervisión. Consulte los mecanismos de alerta admitidos en el artículo Mecanismos de entrega de alertas de nuestra Base de conocimientos.