Creare un connettore personalizzato a un'origine dati

Questo argomento descrive come connettere un'origine dati personalizzata a CloudWatch. Puoi connettere un'origine dati personalizzata a CloudWatch in due modi:

Utilizzo dei modelli

L'utilizzo di un modello crea una funzione Lambda di esempio e può aiutarti a creare più velocemente il tuo connettore personalizzato. Queste funzioni di esempio forniscono codice di esempio per molti scenari comuni relativi alla creazione di un connettore personalizzato. Puoi esaminare il codice Lambda dopo aver creato un connettore con un modello, quindi modificarlo per utilizzarlo per connetterti alla tua origine dati.

Inoltre, se utilizzi il modello, CloudWatch si occupa di creare la policy di autorizzazione Lambda e di allegare i tag delle risorse alla funzione Lambda.

Creazione di un'origine dati personalizzata partendo da zero

Segui i passaggi descritti in questa sezione per creare una funzione Lambda che connetta CloudWatch a un'origine dati.

Fase 1: Creare la funzione

Un connettore di origine dati personalizzato deve supportare gli eventi GetMetricData di CloudWatch. Facoltativamente, puoi anche implementare un evento DescribeGetMetricData per fornire la documentazione su come utilizzare il connettore agli utenti nella console CloudWatch. La risposta DescribeGetMetricData può essere utilizzata anche per impostare le impostazioni predefinite usate nel generatore di query personalizzato di CloudWatch.

CloudWatch fornisce frammenti di codice come esempi per iniziare. Per maggiori informazioni, consulta l'archivio di esempi all'indirizzo https://github.com/aws-samples/cloudwatch-data-source-samples.

Vincoli

Evento GetMetricData

Payload della richiesta

Di seguito è riportato un esempio di payload della richiesta GetMetricData inviato come input alla funzione Lambda.

{
  "EventType": "GetMetricData",
  "GetMetricDataRequest": {
    "StartTime": 1697060700,
    "EndTime": 1697061600,
    "Period": 300,
    "Arguments": ["serviceregistry_external_http_requests{host_cluster!=\"prod\"}"] 
  }
}

Payload della risposta

Di seguito è riportato un esempio di payload di risposta GetMetricData per la funzione Lambda.

{
   "MetricDataResults": [
      {
         "StatusCode": "Complete",
         "Label": "CPUUtilization",
         "Timestamps": [ 1697060700, 1697061000, 1697061300 ],
         "Values": [ 15000, 14000, 16000 ]
      }
   ]
}

Il payload di risposta conterrà un campo MetricDataResults o un campo Error, ma non entrambi.

Un campo MetricDataResults è un elenco di campi di serie temporali di tipo MetricDataResult. Ciascuno di questi campi di serie temporali può includere i seguenti campi.

Per ulteriori informazioni sull'utilizzo degli oggetti Error, consulta le sezioni successive.

Formati di risposta di errore

Puoi utilizzare la risposta di errore per fornire ulteriori informazioni sugli errori. Ti consigliamo di restituire un errore con Code Validation quando si verifica un errore di convalida, ad esempio quando un parametro manca o è del tipo sbagliato.

Di seguito è riportato un esempio di risposta per un caso in cui la funzione Lambda vuole generare un'eccezione di convalida GetMetricData.

{
   "Error": {
      "Code": "Validation",
      "Value": "Invalid Prometheus cluster"
   }
}

Di seguito è riportato un esempio di risposta per un caso in cui la funzione Lambda indica che non è in grado di restituire dati a causa di un problema di accesso. La risposta viene tradotta in una singola serie temporale con un codice di stato di Forbidden.

{
   "Error": {
      "Code": "Forbidden",
      "Value": "Unable to access ..."
   }
}

Di seguito è riportato l'esempio di un caso in cui la funzione Lambda genera un'eccezione InternalError generale, che viene tradotta in una singola serie temporale con un codice di stato di InternalError e un messaggio. Ogni volta che un codice di errore ha un valore diverso da Validation o Forbidden, CloudWatch presume che si tratti di un errore interno generico.

{
   "Error": {
      "Code": "PrometheusClusterUnreachable",
      "Value": "Unable to communicate with the cluster"
   }
}

Evento DescribeGetMetricData

Payload della richiesta

Di seguito è riportato un esempio di payload della richiesta DescribeGetMetricData.

{
  "EventType": "DescribeGetMetricData"
}

Payload della risposta

Di seguito è riportato un esempio di payload della risposta DescribeGetMetricData.

{
    "Description": "Data source connector",
    "ArgumentDefaults": [{
        Value: "default value"
     }]
}

Considerazioni importanti sugli allarmi CloudWatch

Se intendi utilizzare l'origine dati per impostare gli allarmi CloudWatch, devi configurarla affinché restituisca i dati con timestamp a CloudWatch ogni minuto. Per ulteriori informazioni e altre considerazioni sulla creazione di allarmi sui parametri provenienti da origini dati connesse, consulta Creazione di un allarme basato su un'origine dati connessa.

(Facoltativo) Utilizzo di Gestione dei segreti AWS per memorizzare le credenziali

Se la tua funzione Lambda deve utilizzare credenziali per accedere all'origine dati, ti consigliamo di utilizzare Gestione dei segreti AWS per archiviare queste credenziali invece di codificarle nella funzione Lambda. Per ulteriori informazioni sull'uso di Gestione dei segreti AWS con Lambda, consulta Utilizzo dei segreti Gestione dei segreti AWS nelle funzioni AWS Lambda.

(Facoltativo) Connessione a un'origine dati in un VPC

Se la tua origine dati si trova in un VPC gestito da Amazon Virtual Private Cloud, devi configurare la funzione Lambda per accedervi. Per ulteriori informazioni, consulta Connessione della rete in uscita alle risorse in un VPC.

Potrebbe anche essere necessario configurare gli endpoint del servizio VPC per accedere a servizi come Gestione dei segreti AWS. Per ulteriori informazioni, consulta Accesso a un servizio AWS utilizzando un endpoint VPC di interfaccia.

Fase 2: creazione di una policy di autorizzazioni Lambda

È necessario creare un'istruzione di policy che conceda a CloudWatch l'autorizzazione a utilizzare la funzione Lambda creata. Puoi utilizzare AWS CLI o la console Lambda per creare l'istruzione di policy.

Fase 3: collegamento di un tag delle risorse alla funzione Lambda

La console CloudWatch determina quali delle funzioni Lambda sono connettori di origine dati utilizzando un tag. Quando crei un'origine dati utilizzando una delle procedure guidate, il tag viene applicato automaticamente dallo stack CloudFormation che lo configura. Quando crei personalmente un'origine dati, puoi usare il tag seguente per la tua funzione Lambda. In questo modo il connettore viene visualizzato nel menu a discesa Origine dati nella console CloudWatch quando esegui una query sui parametri.