 |
This is a machine translation based on the English version of the article. It might or might not have already been subject to text preparation. If you find errors, please file a GitHub issue that states the paragraph that has to be improved. |
1. Introduzione
Checkmk offre una serie di interfacce diverse, prima fra tutte l'API REST, con la quale è possibile fare molto di ciò che è possibile fare anche tramite l'interfaccia web. Tuttavia, esistono anche API per i plug-in dell'agente, per l'inventario hardware/software, per l'agent bakery e così via. Ci sono articoli, riferimenti e altre risorse per tutte queste interfacce, distribuite in questa User Guide, nel sito web e in Checkmk stesso.
In questo articolo forniremo una panoramica di tutte le interfacce e le risorse e daremo alcuni suggerimenti sulla gestione generale. Molti link in questo articolo sono ridondanti, poiché le informazioni sono destinate a tre approcci o domande diverse:
Quali API fornisce Checkmk?
Quali articoli relativi alle API si trovano nel Manuale dell'utente?
Quali risorse rilevanti per le API sono disponibili in Checkmk?
L'interfaccia più importante è senza dubbio l'API REST di Checkmk, che può essere utilizzata per fare quasi tutto ciò che dal punto di vista della programmazione può essere eseguito anche tramite l'interfaccia web.
 |
L'interfaccia interattiva API REST GUI offre un'introduzione pratica e veloce all'API REST. Qui puoi inviare e, facoltativamente, modificare query predefinite. Puoi trovare l'interfaccia GUI in Checkmk stesso all'indirizzo Help > Developer resources > REST API interactive GUI. |
La seconda interfaccia principale è costituita dalle API Plugin per lo sviluppo delle tue estensioni. A seconda della tua esperienza, puoi iniziare con il nostro articolo introduttivo o con il riferimento, che puoi trovare direttamente in Checkmk:Help > Developer resource > Plug-in API references.
Nelle tabelle che seguono troverai queste API, ma anche interfacce meno conosciute, come quella per l'inventario hardware/software, sotto-interfacce per lo sviluppo di plug-in di controllo, come l'API esplicita per il grafico, nonché quasi-interfacce, come il formato di output dei controlli locali, il semplice precursore, basato su script, dei plug-in veri e propri.
2. API in Checkmk
| API | Manuale dell'utente | Web | Descrizione |
|---|---|---|---|
API REST |
Funzionalmente è un sottoinsieme dell'interfaccia web. |
||
API di controllo |
Codifica dei plug-in di controllo. |
||
API bakery |
In Checkmk: |
Includi i plug-in di controllo nella bakery dell'agente. |
|
Chiamate API lato server |
tbd |
In Checkmk: |
Sviluppa active check e special agent. |
API per i grafici |
Personalizzazione della visualizzazione delle metriche nel plug-in di controllo basato sull'agente articolo |
In Checkmk: |
Includere metriche, grafici, Perf-O-Meter. |
API dei set di regole |
Set di regole per i parametri del check nell'articolo del plug-in di controllo basato sull'agente |
In Checkmk: |
Sviluppa i tuoi set di regole. |
API DCD |
tbd |
In Checkmk: |
Connettori personalizzati per il demone della configurazione dinamica (DCD). |
API HW/SW |
n.d. |
API web per interrogare i dati dell'inventario. |
|
Livestatus |
Recupero dei dati di stato tramite Livestatus, riferimento al comando Livestatus |
n.d. |
Recupero diretto dei dati di stato tramite Livestatus Query Language (LQL). |
Interfaccia della Console degli Eventi |
L'interfaccia di stato della Console degli Eventi |
n.d. |
Accesso allo stato interno ed esecuzione di comandi tramite socket Unix. |
Controlli locali |
n.d. |
Una "mini-interfaccia" per i tuoi controlli basati su script. |
3. Articoli del Manuale dell'utente
| Area API | Guida per l'utente | Descrizione |
|---|---|---|
Automazione |
Descrizione dell'API REST, della sua documentazione e dei suoi possibili utilizzi. |
|
Una panoramica dell'interfaccia dati per le informazioni su host e servizi. |
||
Tutte le tabelle, le intestazioni, i filtri e gli operatori. |
||
Descrizione dell'API web dell'inventario per l'accesso esterno. |
||
Interfaccia di stato della Console degli Eventi |
I dati possono essere letti dalla Console degli Eventi e i comandi possono essere inviati tramite socket Unix e un sottoinsieme del protocollo Livestatus. |
|
Programmazione |
Articolo panoramico con tutte le possibilità di estensione e link a ulteriori informazioni. |
|
Descrizione dettagliata di come sviluppare un plug-in di controllo. |
||
Descrizione dettagliata dello sviluppo di un plug-in di controllo per i dati SNMP. |
4. Risorse in Checkmk
| In Checkmk | Descrizione |
|---|---|
Help > Developer resources > Plug-in API references |
Un riferimento basato su Sphinx di tutte le API rilevanti per lo sviluppo dei plug-in di controllo. |
Help > Developer resources > REST API documentation |
Riferimento basato su ReDoc/OpenAPI per tutte le query rilevanti per Check, inclusi esempi di codice per Requests (Python), Urllib (Python), httpie e curl. |
Help > Developer resources > REST API interactive GUI |
Interfaccia web interattiva per testare tutti gli endpoint API, con feedback direttamente sulla pagina. |
Help > Developer resources > Plug-in API references > Agent based ("Check API") |
Nella sezione Version 2 > New in this version troverai informazioni importanti per la migrazione dei vecchi plug-in alla versione attuale delle API. |
5. Risorse sul web
| Risorse | Descrizione |
|---|---|
Video tutorial (in inglese) con esempi pratici di utilizzo dell'API REST, ad esempio per impostare tempi di manutenzione programmata. |
|
Esempi di Curl nella Knowledge Base di Checkmk per query concrete, ad es. con collegamento AND. |
|
Nel negozio di plug-in di Checkmk troverai molte implementazioni pratiche delle API, compreso il codice sorgente. |