Importa dashboard Grafana in Cloud Monitoring

Questo documento descrive come importare i file di dashboard in Grafana in Cloud Monitoring. Puoi Puoi importare le dashboard Grafana nei seguenti modi:

Il processo di importazione converte i file della dashboard nel formato JSON utilizzato da Grafana nel formato JSON utilizzato da Cloud Monitoring. Una dashboard convertita potrebbe essere diversa dalla dashboard originale di Grafana. Se, ad esempio, un Grafana usa funzionalità che non sono disponibili nelle dashboard di Cloud Monitoring, questi aspetti della dashboard di Grafana non vengono convertiti. Queste differenze vengono elencate nei risultati dell'importazione.

Puoi importare solo dashboard che utilizzano espressioni PromQL e Prometheus diverse origini dati. Le dashboard che utilizzano altre forme di query o origini dati potrebbero Importazione non riuscita.

Per informazioni sull'importazione degli avvisi Prometheus in Cloud Monitoring, consulta Esegui la migrazione delle regole di avviso e dei destinatari da Prometheus.

Per informazioni generali sulla gestione delle dashboard importate, consulta Creare e gestire dashboard personalizzate.

Prima di iniziare

Se utilizzi la console Google Cloud o lo strumento di importazione per importare le tue dashboard, devi disporre di un'autorizzazione sufficiente e richiedono le dashboard per l'importazione. Quando si utilizza l'importatore esistono prerequisiti aggiuntivi.

Autorizzazione

Per ottenere le autorizzazioni necessarie per creare e modificare le dashboard personalizzate, chiedi all'amministratore di concederti Ruolo IAM Editor Monitoring (roles/monitoring.editor) per il progetto. Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite la ruoli o altri ruoli predefiniti ruoli.

Per ulteriori informazioni sui ruoli, consulta Controlla l'accesso con Identity and Access Management.

Raccogli le dashboard Grafana da importare

Per importare le dashboard di Grafana, devi archiviarle localmente in formato JSON. Potresti voler creare una directory specifica per questi file della dashboard.

Importa le dashboard utilizzando la console Google Cloud

Puoi importare le dashboard di Grafana in Cloud Monitoring dal nella console Google Cloud:

  • La scheda Elenco dashboard nelle dashboard di Monitoring .
  • La sezione Dashboard dell'elenco di controllo per l'onboarding nella pagina Panoramica di Monitoring.

Importa dashboard Grafana

Per importare una o più dashboard Grafana, segui questi passaggi

  1. Vai alla pagina Dashboard o Panoramica in Monitoraggio:

    • Nella console Google Cloud, vai alla pagina Dashboard :

      Vai a Dashboard

      Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

    • Nella console Google Cloud, vai alla pagina Panoramica di Monitoring:

      Vai a Panoramica

      Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Fai clic su  Importa dashboard Grafana.

  3. Fai clic su Sfoglia per passare alla directory in cui hai archiviato il tuo alle dashboard di Grafana in formato JSON e seleziona quelle che vuoi per l'importazione.

    Dopo la selezione, ogni file JSON viene messo in fasi. File temporanei indica se ci sono problemi nella conversione.

    • Fai clic su  Visualizza JSON convertito per visualizzare i risultati della conversione.
    • Fai clic su  Rimuovi file per rimuovere una dashboard dall'operazione di importazione.

  4. Fai clic su  Importa. Il riquadro Risultati dell'importazione indica se non tutte le dashboard sono state importate correttamente.

  5. Per visualizzare una dashboard importata correttamente, fai clic su  Visualizza.

Visualizza le dashboard importate

Per visualizzare le dashboard importate, segui questi passaggi:

  1. Nella console Google Cloud, vai alla pagina Dashboard :

    Vai a Dashboard

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Individua la dashboard che vuoi visualizzare nell'elenco. Per filtrare l'elenco delle dashboard, puoi procedere nel seguente modo:

    • Seleziona la categoria Personalizzata per visualizzare solo le dashboard definite dall'utente.
    • Seleziona l'etichetta cloud-monitoring-dashboard-importer per visualizzare solo Grafana le dashboard importate tramite la console Google Cloud.
    • Utilizza la ricerca nella barra dei filtri per nome.

Importa le dashboard con lo strumento di importazione

Puoi utilizzare lo strumento di importazione per convertire le dashboard di Grafana e caricarle a Cloud Monitoring come singola operazione oppure puoi eseguire la conversione e la procedura di caricamento separatamente. Potresti scegliere questo approccio se vuoi modificare le dashboard convertite prima di caricarle.

Prerequisiti aggiuntivi

Prima di installare ed eseguire l'utilità di importazione della dashboard, devi:

  1. Utilizzare un ambiente che supporti la shell Bash script.
  2. Avere o installare Git.
  3. Avere o installare Node.js, versione 20.4.1 oppure più recenti.
  4. Avere o installare Google Cloud CLI. Se hai già gcloud CLI installato, assicurati di avere la versione eseguendo gcloud components update .

Ottieni lo strumento di importazione della dashboard

Lo strumento di importazione della dashboard è archiviato in monitoring-dashboard-samples GitHub di ASL. Per scaricare l'importatore, procedi nel seguente modo:

  1. Clona il repository:

    git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples

  2. Passa alla directory per l'importazione della dashboard:

    cd monitoring-dashboard-samples/scripts/dashboard-importer

Lo strumento di importazione della dashboard include i seguenti script:

  • import.sh, che converte le dashboard carica facoltativamente le dashboard convertite in Cloud Monitoring.

  • upload.sh, che carica il file convertito o qualsiasi dashboard di Monitoring, per e configurazione in Cloud Monitoring. Lo script import.sh chiama questo elemento per eseguire il caricamento.

Quando utilizzi lo script import.sh, devi specificare il campo posizione delle dashboard di Grafana da convertire. L'importatore crea un'istanza contenente le dashboard convertite e altre informazioni. Queste directory sono descritte nelle sezioni seguenti.

Dashboard di Grafana per la conversione

Puoi utilizzare lo strumento di importazione delle dashboard per convertire una o più dashboard in volta specificando un percorso dei file delle dashboard.

  • Puoi specificare il percorso di una directory che contiene le dashboard. Vengono elaborati solo i file nella directory con estensione .json.

  • Puoi specificare il percorso di un singolo file JSON. Il nome file deve avere l'estensione .json.

Dashboard convertite e altre informazioni

Alla prima esecuzione, l'importatore crea una sottodirectory reports. Ogni volta che esegui l'importazione, ottieni una nuova directory di output nel Directory reports, denominata in base alla data e all'ora. Il nome dell'output ha la seguente struttura:
reports/YYYY-M-D/HH:MM:SS

Per ogni chiamata all'importatore, la directory di output contiene seguenti:

  • Uno o più file con gli stessi nomi delle dashboard originali di Grafana, ma ora in formato JSON di Cloud Monitoring.
  • Un file report.json, che registra le seguenti informazioni per ogni dashboard convertita:
    • Il nome e la posizione del file della dashboard Grafana che è stato convertito.
    • Il nome e la località della dashboard di Monitoring convertita .
    • Avvisi sulle funzionalità della dashboard Grafana che non contengono la caratteristica corrispondente in Cloud Monitoring. Di conseguenza, Essere incluso nella dashboard convertita.
    • Eventuali errori che si sono verificati nella conversione.

Se hai caricato le dashboard, la directory del report include anche un file upload_HH:MM:SS.txt, che include l'URL a cui la dashboard è stata caricata.

Importa dashboard Grafana

Per convertire le dashboard di Grafana e caricarle su Cloud Monitoring, usa lo script import.sh:

./import.sh PATH_TO_DIRECTORY_OR_FILE PROJECT_ID

Questo script esegue le seguenti operazioni:

  1. Converte le dashboard in PATH_TO_DIRECTORY_OR_FILE dal formato JSON utilizzato da Grafana nel formato JSON utilizzato da Cloud Monitoring.

  2. Carica le dashboard convertite nel tuo progetto Google Cloud PROJECT_ID con Google Cloud CLI.

    Se non hai eseguito l'autenticazione a gcloud CLI, esegui gcloud auth login prima di eseguire il comando Script import.sh.

Puoi importare tutte le dashboard di Grafana in una directory oppure specificare un'unica dashboard nella directory da importare.

  • Per importare tutte le dashboard nella directory GRAFANA_DASHBOARDS_DIR nel progetto Google Cloud PROJECT_ID, specificare la directory relativa alla directory dell'importatore e ID progetto di destinazione quando richiami lo script:

    ./import.sh GRAFANA_DASHBOARDS_DIR PROJECT_ID

  • Per convertire solo la dashboard MY_GRAFANA_DASHBOARD.json nel GRAFANA_DASHBOARDS_DIR, includi il nome file della dashboard, rispetto alla directory di importazione, quando richiami lo script:

    ./import.sh GRAFANA_DASHBOARDS_DIR/MY_GRAFANA_DASHBOARD.json PROJECT_ID

Lo strumento per l'importazione della dashboard include una dashboard Grafana di esempio examples/k8s_cluster_example.json. Il comando seguente importa quella dashboard nel progetto specificato:

./import.sh examples/k8s_cluster_example.json PROJECT_ID

Se richiamato con PROJECT_ID my-project-test-1, l'output è simile a le seguenti:

Converting: Kubernetes Cluster Overview
✓ Kubernetes Cluster Overview converted successfully

Conversion of examples/k8s_cluster_example.json complete. Conversion Report located at: reports/2023-9-28/22:14:57/report.json


To upload these dashboard(s) manually, you can run:
./upload.sh reports/2023-9-28/22:14:57/ <PROJECT_ID>

Conversion Complete. Proceeding to uploading...

Now running: ./upload.sh reports/2023-9-28/22:14:57/ my-project-test-1

Uploading 1 dashboard(s) from a directory with the following args:
Directory: reports/2023-9-28/22:14:57/
Project: my-project-test-1

The following are your dashboards:
- k8s_cluster_example.json

Dopo che lo script import.sh ha creato la directory di output e convertito le dashboard, ma prima di caricarle al progetto, ti verrà chiesto di conferma. Inserisci y e lo script carica la dashboard e stampa l'URL della nuova dashboard:

Would you like to continue? (y/n) y

✓ k8s_cluster_example.json successfully uploaded:
https://console.cloud.google.com/monitoring/dashboards/builder/9c341ef8-cfef-4bdd-98d5-821571c520ef?project=my-project-test-1

Upload log created in reports/2023-9-28/22:14:57/upload_22:14:57.txt

Need to troubleshoot? Please visit:
https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples/tree/master/scripts/dashboard-importer/README.md#troubleshooting

Converti le dashboard di Grafana senza caricarle

Se vuoi esaminare o modificare le dashboard convertite prima del caricamento oppure ometti il valore PROJECT_ID quando richiami il metodo import.sh script:

./import.sh PATH_TO_DIRECTORY_OR_FILE

L'importatore converte le dashboard come descritto in Importare le dashboard di Grafana ma non carica le dashboard convertite in Cloud Monitoring.

Puoi eseguire il passaggio di caricamento in un secondo momento utilizzando l'upload.sh manualmente lo script.

Carica manualmente le dashboard

Per caricare manualmente le dashboard in formato JSON di Cloud Monitoring, utilizza lo script upload.sh.

    ./upload.sh PATH_TO_DIRECTORY_OR_FILE PROJECT_ID

Lo script upload.sh utilizza Google Cloud CLI per caricare i file JSON. Se non hai eseguito l'autenticazione al gcloud CLI, quindi esegui gcloud auth login prima di eseguire lo script upload.sh.

  • Per caricare tutte le dashboard in una directory reports/YYYY-M-D/HH:MM:SS, specificare la directory in relazione alla directory dell'importatore e l'ID progetto di destinazione quando richiami lo script:

    ./upload.sh reports/YYYY-M-D/HH:MM:SS PROJECT_ID

    Durante il caricamento di tutte le dashboard da una directory, lo script ti chiede di continuare o di uscire prima di caricare le dashboard.

  • Per caricare una dashboard specifica in una directory reports/YYYY-M-D/HH:MM:SS: specificare la directory e il nome file in base alla directory dell'importatore e l'ID progetto di destinazione quando richiami lo script:

    ./upload.sh reports/YYYY-M-D/HH:MM:SS/MY_MONITORING_DASHBOARD.json PROJECT_ID

    Quando carichi una singola dashboard da una directory, lo script viene eseguito senza avvisarti prima di caricare le dashboard.

Ad esempio, il comando seguente carica una dashboard in una sottodirectory reports del progetto Google Cloud my-project-test-1:

./upload.sh reports/2023-9-26/22:48:31/k8s_cluster_example.json my-project-test-1
Uploading json file: k8s_cluster_example.json to project: my-project-test-1...

✓ k8s_cluster_example.json successfully uploaded:
https://console.cloud.google.com/monitoring/dashboards/builder/25956d9a-93e2-410c-ada1-ec6872cb6665?project=my-project-test-1

Visualizza le dashboard caricate

Per visualizzare le dashboard caricate, segui questi passaggi:

  1. Nella console Google Cloud, vai alla pagina Dashboard :

    Vai a Dashboard

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Individua la dashboard che vuoi visualizzare nell'elenco. Per filtrare l'elenco delle dashboard, puoi procedere nel seguente modo:

    • Seleziona la categoria Personalizzata per visualizzare solo le dashboard definite dall'utente.
    • Seleziona l'etichetta cloud-ops-grafana-importer per visualizzare solo Grafana le dashboard importate con lo strumento di importazione.
    • Utilizza la ricerca nella barra dei filtri per nome.

Risoluzione dei problemi

A volte pubblichiamo piccoli aggiornamenti e correzioni di bug per lo strumento. Prima del giorno durante ulteriori tentativi di risoluzione dei problemi, prova innanzitutto a risolvere il problema usando git pull per estrarre del repository, per poi eseguire di nuovo l'importazione.

Per informazioni sui problemi relativi alle dashboard convertite, ad esempio i grafici che non mostrano dati, consulta README.

Passaggi successivi