Questo tutorial mostra come scrivere, eseguire il deployment e chiamare un Cloud Run che genera report Metriche OTLP a Google Cloud Managed Service per Prometheus utilizzando il file collaterale OpenTelemetry.
Se hai un servizio Cloud Run che genera report Metriche di Prometheus, quindi utilizza il file collaterale di Prometheus per Cloud Run.
Obiettivi
- Scrivi, crea ed esegui il deployment di un servizio in Cloud Run con il sidecar OpenTelemetry.
- Genera metriche personalizzate e registrale in Google Cloud Managed Service per Prometheus.
Costi
In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:
Per generare una stima dei costi basata sull'utilizzo previsto,
utilizza il Calcolatore prezzi.
Prima di iniziare
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Run, Cloud Monitoring, Artifact Registry, and Cloud Build APIs.
- Installa e inizializza gcloud CLI.
- Aggiorna Google Cloud CLI:
gcloud components update
Ruoli obbligatori
Per ottenere le autorizzazioni necessarie per completare il tutorial, chiedi all'amministratore di concederti i seguenti ruoli IAM nel progetto:
-
Editor Cloud Build (
roles/cloudbuild.builds.editor
) -
Amministratore Cloud Run (
roles/run.admin
) -
Crea account di servizio (
roles/iam.serviceAccountCreator
) -
Amministratore IAM progetto (
roles/resourcemanager.projectIamAdmin
) -
Autore delle metriche di Monitoring (
roles/monitoring.metricWriter
) -
Utente account di servizio (
roles/iam.serviceAccountUser
) -
Consumer Service Usage (
roles/serviceusage.serviceUsageConsumer
) -
Storage Admin (
roles/storage.admin
)
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.
Tieni inoltre presente che l'identità del servizio Cloud Run deve disporre del ruolo Writer metriche di monitoraggio (roles/monitoring.metricWriter
). Il
service account predefinito di Compute Engine
potrebbe avere questo ruolo per impostazione predefinita, ma potrebbe essere necessario aggiungerlo se hai modificato
le sue autorizzazioni o se utilizzi un altro account di servizio.
Configurare i valori predefiniti di gcloud
Per configurare gcloud con i valori predefiniti per il tuo servizio Cloud Run:
Imposta il progetto predefinito:
gcloud config set project PROJECT_ID
Sostituisci PROJECT_ID con il nome del progetto per cui hai creato questo tutorial.
Configura gcloud per la regione scelta:
gcloud config set run/region REGION
Sostituisci REGION con il Cloud Run supportato regione di tua scelta.
Località Cloud Run
Cloud Run è regionale, il che significa che l'infrastruttura
dei tuoi servizi Cloud Run si trova in una regione specifica
gestiti da Google in modo che siano disponibili in modo ridondante
tutte le zone all'interno di quella regione.
La soddisfazione dei requisiti di latenza, disponibilità o durabilità è uno dei fattori principali per la selezione della regione in cui vengono eseguiti i servizi Cloud Run.
Generalmente puoi selezionare la regione più vicina ai tuoi utenti, ma devi considerare
la località dell'altro account Google Cloud
prodotti utilizzati dal tuo servizio Cloud Run.
L'utilizzo combinato dei prodotti Google Cloud in più località può influire
nonché la latenza del tuo servizio.
Cloud Run è disponibile nelle regioni seguenti:
Soggetto ai prezzi di Livello 1
asia-east1
(Taiwan)asia-northeast1
(Tokyo)asia-northeast2
(Osaka)europe-north1
(Finlandia) A basse emissioni di CO2europe-southwest1
(Madrid) A basse emissioni di CO2europe-west1
(Belgio) A basse emissioni di CO2europe-west4
(Paesi Bassi) A basse emissioni di CO2europe-west8
(Milano)europe-west9
(Parigi) A basse emissioni di CO2me-west1
(Tel Aviv)us-central1
(Iowa) A basse emissioni di CO2us-east1
(Carolina del Sud)us-east4
(Virginia del Nord)us-east5
(Colombo)us-south1
(Dallas) A basse emissioni di CO2us-west1
(Oregon) A basse emissioni di CO2
Soggetto ai prezzi di Livello 2
africa-south1
(Johannesburg)asia-east2
(Hong Kong)asia-northeast3
(Seul, Corea del Sud)asia-southeast1
(Singapore)asia-southeast2
(Giacarta)asia-south1
(Mumbai, India)asia-south2
(Delhi, India)australia-southeast1
(Sydney)australia-southeast2
(Melbourne)europe-central2
(Varsavia, Polonia)europe-west10
(Berlino) A basse emissioni di CO2europe-west12
(Torino)europe-west2
(Londra, Regno Unito) A basse emissioni di CO2europe-west3
(Francoforte, Germania) A basse emissioni di CO2europe-west6
(Zurigo, Svizzera) A basse emissioni di CO2me-central1
(Doha)me-central2
(Dammam)northamerica-northeast1
(Montreal) A basse emissioni di CO2northamerica-northeast2
(Toronto) A basse emissioni di CO2southamerica-east1
(San Paolo, Brasile) A basse emissioni di CO2southamerica-west1
(Santiago, Cile) A basse emissioni di CO2us-west2
(Los Angeles)us-west3
(Salt Lake City)us-west4
(Las Vegas)
Se hai già creato un servizio Cloud Run, puoi visualizzare nella dashboard di Cloud Run all'interno Console Google Cloud.
Creazione di un repository di immagini Artifact Registry
Crea un repository Docker Artifact Registry per ospitare l'immagine del servizio di esempio:
gcloud artifacts repositories create run-otel \ --repository-format=docker \ --location=REGION \ --project=PROJECT_ID
Sostituisci quanto segue:
- PROJECT_ID con il nome del progetto che hai creato per questo tutorial.
- REGION REGIONE con la regione Cloud Run supportata che preferisci.
Recupero dell'esempio di codice in corso
Per recuperare l'esempio di codice da utilizzare:
Clona il repository dell'app di esempio nella tua macchina locale:
Vai
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
In alternativa, puoi scarica l'esempio . come file ZIP ed estrarlo.
Passa alla directory che contiene l'esempio di Cloud Run codice:
Vai
cd golang-samples/run/custom-metrics/
Revisione del codice
Il codice di questo tutorial è costituito dai seguenti elementi:
- Un server che gestisce le richieste in entrata e genera una metrica denominata
sidecar_sample_counter
.
- Un elemento
Dockerfile
che definisce l'ambiente operativo del servizio.
L'esempio include anche i file nella sottodirectory collector
per creare un'immagine personalizzata
OpenTelemetry Collector:
Un file di configurazione per il raccoglitore OpenTelemetry.
Un
Dockerfile
che raggruppa la configurazione fornita in un raccoglitore a monte dell'immagine.
Spedizione del codice
Il codice di spedizione prevede tre passaggi: la creazione di un'immagine container con Cloud Build, caricando l'immagine container in Artifact Registry e il deployment dell'immagine container in Cloud Run.
Per spedire il codice:
-
Crea il tuo container di servizio di esempio e pubblicalo su Artifact Registry:
gcloud builds submit --tag REGION-docker.pkg.dev/PROJECT_ID/run-otel/sample-metrics-app
Se l'operazione riesce, dovresti visualizzare il messaggio SUCCESS contenente l'ID: data di creazione e nome immagine. L'immagine è archiviata in Artifact Registry e, se lo desideri, può essere riutilizzata.
-
Crea il tuo container di raccolta e pubblicalo su Artifact Registry:
gcloud builds submit collector --tag REGION-docker.pkg.dev/PROJECT_ID/run-otel/otel-collector-metrics
In caso di esito positivo, dovresti visualizzare un messaggio di successo contenente l'ID, la data e l'ora di creazione e il nome dell'immagine. L'immagine viene archiviata in Artifact Registry possono essere riutilizzati, se necessario.
-
Esegui il deployment dell'applicazione:
YAML
-
Crea un nuovo file denominato
service.yaml
con quanto segue:apiVersion: serving.knative.dev/v1 kind: Service metadata: name: SERVICE-NAME annotations: run.googleapis.com/launch-stage: BETA spec: template: metadata: annotations: run.googleapis.com/container-dependencies: "{app:[collector]}" spec: containers: - image: REGION-docker.pkg.dev/PROJECT_ID/run-otel/sample-metrics-app name: app ports: - containerPort: CONTAINER_PORT env: - name: "OTEL_EXPORTER_OTLP_ENDPOINT" value: "http://localhost:4317" - image: REGION-docker.pkg.dev/PROJECT_ID/run-otel/otel-collector-metrics name: collector startupProbe: httpGet: path: / port: 13133
-
Sostituisci quanto segue:
- CONTAINER_PORT con la porta su cui il container in entrata del tuo servizio rimane in ascolto. Il valore predefinito è
8080
. - SERVICE-NAME con un nome qualsiasi per il servizio, ad esempio
custom-metrics-sample-service
.
- CONTAINER_PORT con la porta su cui il container in entrata del tuo servizio rimane in ascolto. Il valore predefinito è
-
-
Crea il nuovo servizio con il comando seguente:
gcloud run services replace service.yaml
Questo comando restituisce l'URL di un servizio. Utilizza questo URL per provare l'applicazione di esempio in Prova.
Prova
Utilizzando l'URL dal comando gcloud run
in Spedizione del codice,
connettersi al servizio per generare alcune metriche di esempio (puoi eseguire questo
più volte per generare dati più interessanti):
curl -H \ "Authorization: Bearer $(gcloud auth print-identity-token)" \ SERVICE_URL
Sostituisci SERVICE_URL con l'URL del servizio.
Poi, vai a Esplora metriche.
nella sezione Cloud Monitoring della console Google Cloud e seleziona
sidecar_sample_counter
.
Puoi anche eseguire query sulle metriche con PromQL. Ad esempio, la query seguente filtrerà le metriche in base all'ID dell'istanza Cloud Run:
sidecar_sample_counter{instance="INSTANCE_ID"}
Sostituisci INSTANCE_ID con l'ID di qualsiasi istanza del tuo servizio (disponibile nei log dell'istanza o nel server dei metadati).
Questa query produce un grafico come quello seguente:
Esegui la pulizia
Se hai creato un nuovo progetto per questo tutorial, elimina il progetto. Se hai utilizzato un progetto esistente e vuoi mantenerlo senza l'aggiunta delle modifiche In questo tutorial, elimina le risorse create per il tutorial.
Elimina il progetto
Il modo più semplice per eliminare la fatturazione creato per il tutorial.
Per eliminare il progetto:
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Eliminazione delle risorse dei tutorial
Elimina il servizio Cloud Run di cui hai eseguito il deployment in questo tutorial:
gcloud run services delete SERVICE-NAME
Dove SERVICE-NAME è il nome del servizio che hai scelto.
I servizi Cloud Run possono essere eliminati anche Console Google Cloud.
Rimuovi la configurazione predefinita della regione gcloud che hai aggiunto durante il tutorial configurazione:
gcloud config unset run/region
Rimuovi la configurazione del progetto:
gcloud config unset project
Elimina altre risorse Google Cloud create in questo tutorial:
Passaggi successivi
Altri esempi, inclusi esempi di tracce e log, sono disponibili su GitHub.