Framework wtyczek
Rozszerzaj funkcjonalność Xcellerate RMM za pomocą wtyczek społeczności i własnych wtyczek.
Przegląd
Framework wtyczek pozwala rozszerzać Xcellerate RMM o dodatkową funkcjonalność bez modyfikowania platformy bazowej. Wtyczki mogą dodawać nowe widżety pulpitu, niestandardowe monitory, typy raportów, konektory integracyjne, a nawet całkowicie nowe strony UI.
RMM Labs prowadzi oficjalny marketplace wtyczek z wtyczkami społeczności i własnymi. Możesz też tworzyć własne prywatne wtyczki za pomocą Plugin SDK i TypeScript/JavaScript.
Kluczowe pojęcia
- Wtyczka — samodzielny pakiet rozszerzenia z manifestem, kodem i opcjonalnymi zasobami (ikony, szablony). Instalowana na poziomie serwera.
- Marketplace wtyczek — wbudowany katalog do przeglądania, instalowania i aktualizacji wtyczek. Dostępny z Administration → Plugins.
- Plugin SDK — zestaw deweloperski z API do interakcji z danymi, komponentami UI i zdarzeniami Xcellerate RMM. Dostępny jako pakiet npm.
- Hook — punkt rozszerzenia platformy, w którym wtyczki mogą wstrzykiwać zachowanie (np.
onEndpointCreated,onAlertFired,beforePatchInstall). - Widżet — komponent dostarczony przez wtyczkę, który można dodać do pulpitu lub stron szczegółów punktu końcowego (np. niestandardowy wykres, przycisk szybkiej akcji).
- Ustawienia wtyczki — wartości konfiguracyjne udostępniane przez wtyczkę (np. klucz API do usługi zewnętrznej). Administratorzy ustawiają je po instalacji.
Instrukcja krok po kroku
Przeglądaj marketplace
Przejdź do Administration → Plugins → Marketplace. Przeglądaj według kategorii (monitorowanie, raportowanie, integracje, UI) lub szukaj po nazwie. Każda karta wtyczki pokazuje opis, autora, wersję, ocenę i liczbę instalacji.
Zainstaluj wtyczkę
Kliknij wtyczkę, aby zobaczyć stronę szczegółów, a następnie kliknij Install. Wtyczka jest pobierana i aktywowana. Niektóre wtyczki wymagają restartu serwera — UI poinformuje Cię, jeśli tak.
Skonfiguruj wtyczkę
Po instalacji przejdź do Administration → Plugins → Installed. Kliknij nazwę wtyczki i wypełnij wymagane ustawienia (np. klucze API, domyślne parametry). Zapisz.
Używaj wtyczki
W zależności od typu wtyczki możesz zobaczyć nowy element w menu bocznym, nowy widżet na pulpicie, dodatkowe opcje w menu kontekstowym lub nowy typ raportu. Sprawdź dokumentację wtyczki po szczegóły.
Aktualizuj lub usuń wtyczkę
Na stronie zainstalowanych wtyczek możesz sprawdzić aktualizacje (pojawia się znaczek przy nowej wersji) lub kliknąć Uninstall, aby czysto usunąć wtyczkę.
Tworzenie własnej wtyczki
Aby zbudować własną wtyczkę, zainstaluj Plugin SDK i wygeneruj nowy projekt:
npm install -g @xcellerate/plugin-sdk
xcellerate-plugin init my-custom-plugin
cd my-custom-plugin
npm run devWygenerowany projekt zawiera plik manifestu (plugin.json), punkt wejścia i przykładowe hooki. SDK dostarcza typy TypeScript dla wszystkich API platformy i lokalny serwer deweloperski z hot-reload na piaskowanej instancji Xcellerate.
Wskazówki i najlepsze praktyki
- Sprawdź marketplace przed budowaniem własnego rozwiązania — może już istnieć wtyczka robiąca to, czego potrzebujesz.
- Aktualizuj wtyczki na bieżąco — autorzy często naprawiają błędy i dodają nowe funkcje.
- Przy tworzeniu własnej wtyczki stosuj zasadę minimalnych uprawnień: żądaj tylko tych uprawnień API, które Twoja wtyczka faktycznie potrzebuje.
- Testuj własne wtyczki w środowisku testowym przed wdrożeniem na produkcję.
- Używaj hooków do logiki sterowanej zdarzeniami (np. automatyczne tagowanie punktów końcowych przy tworzeniu), zamiast odpytywać API.
- Publikuj przydatne wtyczki w marketplace, aby dzielić się nimi ze społecznością i otrzymywać feedback.