Framework de complementos
Extiende la funcionalidad de Xcellerate RMM con complementos de la comunidad y personalizados.
Descripción general
El Framework de complementos te permite extender Xcellerate RMM con funcionalidad adicional sin modificar la plataforma central. Los complementos pueden agregar nuevos widgets al panel, monitores personalizados, tipos de informes, conectores de integración e incluso páginas de interfaz completamente nuevas.
RMM Labs mantiene un marketplace de complementos oficial con complementos contribuidos por la comunidad y de primera parte. También puedes desarrollar tus propios complementos privados usando el Plugin SDK y TypeScript/JavaScript.
Conceptos clave
- Complemento — un paquete de extensión autónomo con un manifiesto, código y activos opcionales (iconos, plantillas). Se instala a nivel de servidor.
- Marketplace de complementos — el catálogo integrado donde puedes explorar, instalar y actualizar complementos. Accesible desde Administration → Plugins.
- Plugin SDK — un kit de desarrollo que proporciona APIs para interactuar con datos de Xcellerate RMM, componentes de interfaz y eventos. Disponible como paquete npm.
- Hook — un punto de extensión en la plataforma donde los complementos pueden inyectar comportamiento (p. ej.
onEndpointCreated,onAlertFired,beforePatchInstall). - Widget — un componente proporcionado por el complemento que puede agregarse al panel o a las páginas de detalles de puntos finales (p. ej. un gráfico personalizado, un botón de acción rápida).
- Configuración del complemento — valores de configuración expuestos por el complemento (p. ej. una clave API para un servicio de terceros). Los administradores los configuran después de la instalación.
Guía paso a paso
Explora el marketplace
Ve a Administration → Plugins → Marketplace. Explora por categoría (monitorización, informes, integraciones, interfaz) o busca por nombre. Cada tarjeta de complemento muestra una descripción, autor, versión, calificación y número de instalaciones.
Instala un complemento
Haz clic en un complemento para ver su página de detalles, luego haz clic en Install. El complemento se descarga y activa. Algunos complementos requieren un reinicio del servidor — la interfaz te lo indicará si es necesario.
Configura el complemento
Después de la instalación, ve a Administration → Plugins → Installed. Haz clic en el nombre del complemento y completa la configuración requerida (p. ej. claves API, parámetros predeterminados). Guarda.
Usa el complemento
Dependiendo del tipo de complemento, podrías ver un nuevo elemento en el menú lateral, un nuevo widget en el panel, opciones adicionales en menús contextuales o un nuevo tipo de informe. Consulta la documentación del complemento para más detalles.
Actualiza o elimina un complemento
En la página de complementos instalados, puedes verificar actualizaciones (aparece una insignia cuando hay una nueva versión disponible) o hacer clic en Uninstall para eliminar un complemento de forma limpia.
Desarrollar un complemento personalizado
Para construir tu propio complemento, instala el Plugin SDK y crea un nuevo proyecto:
npm install -g @xcellerate/plugin-sdk
xcellerate-plugin init my-custom-plugin
cd my-custom-plugin
npm run devEl proyecto creado incluye un archivo de manifiesto (plugin.json), un punto de entrada y hooks de ejemplo. El SDK proporciona tipos TypeScript para todas las APIs de la plataforma y un servidor de desarrollo local que recarga tu complemento automáticamente contra una instancia sandboxed de Xcellerate.
Consejos y mejores prácticas
- Revisa el marketplace antes de construir una solución personalizada — puede que ya exista un complemento que haga lo que necesitas.
- Mantén los complementos actualizados — los autores frecuentemente corrigen errores y agregan funciones en nuevas versiones.
- Al desarrollar un complemento personalizado, sigue el principio de mínimo privilegio: solo solicita los permisos de API que tu complemento realmente necesita.
- Prueba los complementos personalizados en un entorno de staging antes de desplegarlos en producción.
- Usa hooks para lógica basada en eventos (p. ej. etiquetar automáticamente puntos finales al crearlos) en lugar de consultar la API periódicamente.
- Envía complementos útiles al marketplace para compartir con la comunidad y recibir retroalimentación.