Tutorial: risoluzione dei problemi locali di un servizio Cloud Run

Questo tutorial mostra come uno sviluppatore di servizi può risolvere i problemi relativi a un guasto Servizio Cloud Run che utilizza gli strumenti di Google Cloud Observability per il rilevamento e e un flusso di lavoro di sviluppo.

Questo "case study" dettagliato associato al guida alla risoluzione dei problemi utilizza un progetto di esempio che provoca errori di runtime al momento del deployment, che dovrai individuare e correggere risolvere il problema.

Obiettivi

  • Scrivi, crea ed esegui il deployment di un servizio in Cloud Run
  • Utilizzare Error Reporting e Cloud Logging per identificare un errore
  • Recupera l'immagine container da Container Registry per un'analisi delle cause principali
  • Correggi il problema "production" e migliorare il servizio per mitigare i problemi futuri

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. I nuovi utenti di Google Cloud potrebbero essere idonei per una prova gratuita.

Prima di iniziare

  1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  6. Abilita l'API Cloud Run Admin
  7. Installa e inizializza gcloud CLI.
  8. Aggiorna i componenti: 
    gcloud components update
  9. Segui le istruzioni per installare Docker in locale

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per completare il tutorial: chiedi all'amministratore di concederti i seguenti ruoli IAM sul tuo progetto:

Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso.

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

Configurazione dei valori predefiniti di gcloud

Per configurare gcloud con i valori predefiniti per il tuo servizio Cloud Run:

  1. Imposta il progetto predefinito:

    gcloud config set project PROJECT_ID

    Sostituisci PROJECT_ID con il nome del progetto per cui hai creato questo tutorial.

  2. 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 affinché siano disponibili in modo ridondante tutte le zone all'interno di quella regione.

Soddisfare i requisiti di latenza, disponibilità o durabilità è fondamentale i fattori necessari per selezionare la 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

Soggetto ai prezzi di Livello 2

Se hai già creato un servizio Cloud Run, puoi visualizzare nella dashboard di Cloud Run all'interno Console Google Cloud.

Assemblaggio del codice

Crea passo dopo passo un nuovo servizio di messaggistica di Cloud Run. Ti ricordiamo che questo servizio crea un errore di runtime per risoluzione dei problemi dell'allenamento.

  1. Crea un nuovo progetto:

    Node.js

    Creare un progetto Node.js definendo il pacchetto di servizio, le dipendenze iniziali e alcune operazioni comuni.

    1. Crea una nuova directory hello-service:

      mkdir hello-service
cd hello-service

    2. Crea un nuovo progetto Node.js generando un file package.json:

      npm init --yes
npm install --save express@4

    3. Apri il nuovo file package.json nell'editor e configura un start per eseguire node index.js. Al termine, il file avrà il seguente aspetto:

      {
  "name": "hello-broken",
  "description": "Broken Cloud Run service for troubleshooting practice",
  "version": "1.0.0",
  "private": true,
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
    "test": "echo \"Error: no test specified\" && exit 0",
    "system-test": "NAME=Cloud c8 mocha -p -j 2 test/system.test.js --timeout=360000 --exit"
  },
  "engines": {
    "node": ">=16.0.0"
  },
  "author": "Google LLC",
  "license": "Apache-2.0",
  "dependencies": {
    "express": "^4.17.1"
  },
  "devDependencies": {
    "c8": "^8.0.0",
    "google-auth-library": "^9.0.0",
    "got": "^11.0.0",
    "mocha": "^10.0.0"
  }
}

    Se continui a sviluppare questo servizio oltre il tutorial immediato, valuta inserendo la descrizione, l'autore e valutando la licenza. Per ulteriori dettagli, leggi la documentazione dipackage.json.

    Python

    1. Crea una nuova directory hello-service:

      mkdir hello-service
cd hello-service

    2. Crea un file requirements.txt e copia le tue dipendenze al suo interno: 

      Flask==3.0.3
pytest==8.2.0; python_version > "3.0"
# pin pytest to 4.6.11 for Python2.
pytest==4.6.11; python_version < "3.0"
gunicorn==22.0.0
Werkzeug==3.0.3

    Vai

    1. Crea una nuova directory hello-service:

      mkdir hello-service
cd hello-service

    2. Crea un progetto Go inizializzando un nuovo modulo Go:

      go mod init example.com/hello-service

    Puoi aggiornare il nome specifico come preferisci: devi aggiornare il nome se viene pubblicato in un repository di codice raggiungibile dal web.

    Java

    1. Crea un nuovo progetto Maven:

      mvn archetype:generate \
  -DgroupId=com.example.cloudrun \
  -DartifactId=hello-service \
  -DarchetypeArtifactId=maven-archetype-quickstart \
  -DinteractiveMode=false

    2. Copia le dipendenze nell'elenco delle dipendenze pom.xml (tra gli elementi <dependencies>):

      <dependency>
  <groupId>com.sparkjava</groupId>
  <artifactId>spark-core</artifactId>
  <version>2.9.4</version>
</dependency>
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>2.0.12</version>
</dependency>
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-simple</artifactId>
  <version>2.0.12</version>
</dependency>

    3. Copia l'impostazione della build in pom.xml (sotto gli elementi <dependencies>):

      <build>
  <plugins>
    <plugin>
      <groupId>com.google.cloud.tools</groupId>
      <artifactId>jib-maven-plugin</artifactId>
      <version>3.4.0</version>
      <configuration>
        <to>
          <image>gcr.io/PROJECT_ID/hello-service</image>
        </to>
      </configuration>
    </plugin>
  </plugins>
</build>

  2. Crea un servizio HTTP per gestire le richieste in entrata:

    Node.js 

    const express = require('express');
const app = express();

app.get('/', (req, res) => {
  console.log('hello: received request.');

  const {NAME} = process.env;
  if (!NAME) {
    // Plain error logs do not appear in Stackdriver Error Reporting.
    console.error('Environment validation failed.');
    console.error(new Error('Missing required server parameter'));
    return res.status(500).send('Internal Server Error');
  }
  res.send(`Hello ${NAME}!`);
});
const port = parseInt(process.env.PORT) || 8080;
app.listen(port, () => {
  console.log(`hello: listening on port ${port}`);
});

    Python 

    import json
import os

from flask import Flask


app = Flask(__name__)


@app.route("/", methods=["GET"])
def index():
    """Example route for testing local troubleshooting.

    This route may raise an HTTP 5XX error due to missing environment variable.
    """
    print("hello: received request.")

    NAME = os.getenv("NAME")

    if not NAME:
        print("Environment validation failed.")
        raise Exception("Missing required service parameter.")

    return f"Hello {NAME}"


if __name__ == "__main__":
    PORT = int(os.getenv("PORT")) if os.getenv("PORT") else 8080

    # This is used when running locally. Gunicorn is used to run the
    # application on Cloud Run. See entrypoint in Dockerfile.
    app.run(host="127.0.0.1", port=PORT, debug=True)

    Vai 

    
// Sample hello demonstrates a difficult to troubleshoot service.
package main

import (
	"fmt"
	"log"
	"net/http"
	"os"
)

func main() {
	log.Print("hello: service started")

	http.HandleFunc("/", helloHandler)


	port := os.Getenv("PORT")
	if port == "" {
		port = "8080"
		log.Printf("Defaulting to port %s", port)
	}

	log.Printf("Listening on port %s", port)
	log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", port), nil))
}

func helloHandler(w http.ResponseWriter, r *http.Request) {
	log.Print("hello: received request")

	name := os.Getenv("NAME")
	if name == "" {
		log.Printf("Missing required server parameter")
		// The panic stack trace appears in Cloud Error Reporting.
		panic("Missing required server parameter")
	}

	fmt.Fprintf(w, "Hello %s!\n", name)
}

    Java 

    import static spark.Spark.get;
import static spark.Spark.port;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class App {

  private static final Logger logger = LoggerFactory.getLogger(App.class);

  public static void main(String[] args) {
    int port = Integer.parseInt(System.getenv().getOrDefault("PORT", "8080"));
    port(port);

    get(
        "/",
        (req, res) -> {
          logger.info("Hello: received request.");
          String name = System.getenv("NAME");
          if (name == null) {
            // Standard error logs do not appear in Stackdriver Error Reporting.
            System.err.println("Environment validation failed.");
            String msg = "Missing required server parameter";
            logger.error(msg, new Exception(msg));
            res.status(500);
            return "Internal Server Error";
          }
          res.status(200);
          return String.format("Hello %s!", name);
        });
  }
}

  3. Crea un Dockerfile per definire l'immagine container utilizzata per il deployment del servizio:

    Node.js 

    
# Use the official lightweight Node.js image.
# https://hub.docker.com/_/node
FROM node:20-slim
# Create and change to the app directory.
WORKDIR /usr/src/app

# Copy application dependency manifests to the container image.
# A wildcard is used to ensure copying both package.json AND package-lock.json (when available).
# Copying this first prevents re-running npm install on every code change.
COPY package*.json ./

# Install dependencies.
# if you need a deterministic and repeatable build create a
# package-lock.json file and use npm ci:
# RUN npm ci --omit=dev
# if you need to include development dependencies during development
# of your application, use:
# RUN npm install --dev

RUN npm install --omit=dev

# Copy local code to the container image.
COPY . ./

# Run the web service on container startup.
CMD [ "npm", "start" ]

    Python 

    
# Use the official Python image.
# https://hub.docker.com/_/python
FROM python:3.11

# Allow statements and log messages to immediately appear in the Cloud Run logs
ENV PYTHONUNBUFFERED True

# Copy application dependency manifests to the container image.
# Copying this separately prevents re-running pip install on every code change.
COPY requirements.txt ./

# Install production dependencies.
RUN pip install -r requirements.txt

# Copy local code to the container image.
ENV APP_HOME /app
WORKDIR $APP_HOME
COPY . ./

# Run the web service on container startup.
# Use gunicorn webserver with one worker process and 8 threads.
# For environments with multiple CPU cores, increase the number of workers
# to be equal to the cores available.
# Timeout is set to 0 to disable the timeouts of the workers to allow Cloud Run to handle instance scaling.
CMD exec gunicorn --bind :$PORT --workers 1 --threads 8 --timeout 0 main:app

    Vai 

    
# Use the offical golang image to create a binary.
# This is based on Debian and sets the GOPATH to /go.
# https://hub.docker.com/_/golang
FROM golang:1.21-bookworm as builder

# Create and change to the app directory.
WORKDIR /app

# Retrieve application dependencies.
# This allows the container build to reuse cached dependencies.
# Expecting to copy go.mod and if present go.sum.
COPY go.* ./
RUN go mod download

# Copy local code to the container image.
COPY . ./

# Build the binary.
RUN go build -v -o server

# Use the official Debian slim image for a lean production container.
# https://hub.docker.com/_/debian
# https://docs.docker.com/develop/develop-images/multistage-build/#use-multi-stage-builds
FROM debian:bookworm-slim
RUN set -x && apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y \
    ca-certificates && \
    rm -rf /var/lib/apt/lists/*

# Copy the binary to the production image from the builder stage.
COPY --from=builder /app/server /server

# Run the web service on container startup.
CMD ["/server"]

    Java

    Questo esempio utilizza Jib per creare utilizzando strumenti Java comuni. Jib ottimizza le build di container senza la necessità di un Dockerfile o di avere Docker installato. Scopri di più sulla creazione di container Java con Jib.

    <plugin>
  <groupId>com.google.cloud.tools</groupId>
  <artifactId>jib-maven-plugin</artifactId>
  <version>3.4.0</version>
  <configuration>
    <to>
      <image>gcr.io/PROJECT_ID/hello-service</image>
    </to>
  </configuration>
</plugin>

Spedizione del codice

Il codice di spedizione prevede tre passaggi: la creazione di un'immagine container con Cloud Build, caricando l'immagine container in Container Registry il deployment dell'immagine container in Cloud Run.

Per spedire il codice:

  1. Crea il tuo container e pubblicalo su Container Registry:

    Node.js 

    gcloud builds submit --tag gcr.io/PROJECT_ID/hello-service

    Dove PROJECT_ID è l'ID progetto Google Cloud. Puoi controllare ID progetto attuale con gcloud config get-value project.

    Se l'operazione riesce, dovresti vedere il messaggio SUCCESS contenente l'ID, la creazione ora e nome dell'immagine. L'immagine è archiviata in Container Registry e può essere se lo desideri,

    Python 

    gcloud builds submit --tag gcr.io/PROJECT_ID/hello-service

    Dove PROJECT_ID è l'ID progetto Google Cloud. Puoi controllare ID progetto attuale con gcloud config get-value project.

    Se l'operazione riesce, dovresti vedere il messaggio SUCCESS contenente l'ID, la creazione ora e nome dell'immagine. L'immagine è archiviata in Container Registry e può essere se lo desideri,

    Vai 

    gcloud builds submit --tag gcr.io/PROJECT_ID/hello-service

    Dove PROJECT_ID è l'ID progetto Google Cloud. Puoi controllare ID progetto attuale con gcloud config get-value project.

    Se l'operazione riesce, dovresti vedere il messaggio SUCCESS contenente l'ID, la creazione ora e nome dell'immagine. L'immagine è archiviata in Container Registry e può essere se lo desideri,

    Java

    1. Utilizza gcloud credentials helper per autorizzare Docker a eseguire il push al tuo Container Registry. 
      gcloud auth configure-docker
    2. Utilizza il plug-in Jib Maven per creare il container ed eseguirne il push in Container Registry. 
      mvn compile jib:build -Dimage=gcr.io/PROJECT_ID/hello-service

    Dove PROJECT_ID è l'ID progetto Google Cloud. Puoi controllare ID progetto attuale con gcloud config get-value project.

    Se l'operazione riesce, dovresti visualizzare il messaggio BUILD SUCCESS. L'immagine è archiviata in in Container Registry e può essere riutilizzato, se necessario.

  2. Esegui questo comando per eseguire il deployment della tua app:

    gcloud run deploy hello-service --image gcr.io/PROJECT_ID/hello-service

    Sostituisci PROJECT_ID con l'ID del tuo progetto Google Cloud. hello-service è sia il nome dell'immagine container sia il nome del servizio Cloud Run. Nota che viene eseguito il deployment dell'immagine container nel servizio configurata in precedenza in Configurazione di gcloud

    Rispondi y, "Sì", alla richiesta consenti non autenticati. Consulta Gestire l'accesso per ulteriori dettagli su Autenticazione basata su IAM.

    Attendi il completamento del deployment: l'operazione può richiedere circa mezzo minuto. Se l'operazione riesce, la riga di comando visualizza l'URL del servizio.

Prova

Prova il servizio per verificare di averlo eseguito correttamente. Richieste dovrebbe restituire un errore HTTP 500 o 503 (i membri della classe Errori del server 5xx). Il tutorial illustra la risoluzione dei problemi relativi a questa risposta di errore.

Al servizio viene assegnato automaticamente un URL navigabile.

  1. Accedi a questo URL con il tuo browser web:

    1. Apri un browser web

    2. Trova l'output dell'URL del servizio con il comando di deployment precedente.

      Se il comando di deployment non ha fornito un URL, si è verificato un problema. Esamina il messaggio di errore e agisci di conseguenza, se non esistono indicazioni strategiche è presente, consulta la guida alla risoluzione dei problemi ed eventualmente riprovare.

    3. Accedi all'URL copiandolo nella barra degli indirizzi del browser e premendo INVIO.

  2. Visualizza l'errore HTTP 500 o HTTP 503.

    Se ricevi un errore HTTP 403, potresti aver rifiutato allow unauthenticated invocations al prompt del deployment. Per risolvere il problema, concedi l'accesso non autenticato al servizio:

    gcloud run services add-iam-policy-binding hello-service \
  --member="allUsers" \
  --role="roles/run.invoker"

Per ulteriori informazioni, consulta Consentire l'accesso pubblico (non autenticato).

Analisi del problema

Verifica che l'errore HTTP 5xx riscontrato in Prova è stato riscontrato come un errore di runtime di produzione. Questo tutorial illustra una processo formale per gestirlo. Sebbene i processi di risoluzione degli errori di produzione variano notevolmente, questo tutorial presenta una sequenza particolare di passaggi per mostrare l'applicazione di strumenti e tecniche utili.

Per esaminare questo problema dovrai seguire queste fasi:

  • Raccogliere maggiori dettagli sull’errore segnalato per supportare ulteriori indagini e impostare una strategia di mitigazione.
  • Allevia l'impatto degli utenti decidendo se eseguire una correzione o eseguire il rollback a una versione integro nota.
  • Riproduci l'errore per confermare che sono stati raccolti i dettagli corretti e che l'errore non è un glitch una tantum
  • Esegui un'analisi della causa principale del bug per trovare il codice, la configurazione processo che ha creato l'errore

All'inizio dell'indagine hai un URL, un timestamp e il messaggio "Errore interno del server".

Raccolta di ulteriori dettagli

Raccogliere ulteriori informazioni sul problema per capire cosa è successo e determinare i passaggi successivi.

Utilizza gli strumenti di Google Cloud Observability disponibili per raccogliere ulteriori dettagli:

  1. Usa la console di Error Reporting, che fornisce una dashboard con i dettagli e il monitoraggio delle ricorrenze per gli errori con un tracciamento dello stack.

    Vai alla console di Error Reporting

    Screenshot dell&#39;elenco di errori con le colonne &quot;Stato risoluzione&quot;, Occorrenze, Errore e &quot;Visto in&quot;.
    . Elenco degli errori registrati. Gli errori vengono raggruppati per messaggio tra revisioni, servizi e piattaforme.

  2. Fai clic sull'errore per visualizzare i dettagli dell'analisi dello stack, incluse le chiamate di funzione appena prima dell'errore.

    Screenshot di una singola analisi dello stack analizzata, che mostra un profilo comune di questo errore.
    . "Esempio di traccia dello stack" nella pagina dei dettagli dell'errore mostra una singola istanza dell'errore. Puoi esaminare ogni singola istanza.

  3. Usa Cloud Logging per rivedere la sequenza di operazioni che portano problema, inclusi i messaggi di errore non inclusi nel nella console di Error Reporting a causa dell'assenza di un analisi dello stack di errori:

    Vai alla console di Cloud Logging

    Seleziona Revisione Cloud Run > hello-service dal primo menu a discesa . In questo modo le voci di log verranno filtrate in base a quelle generate dal servizio.

Scopri di più sulla visualizzazione dei log in Cloud Run

Esegui il rollback a una versione integro

Se si tratta di un servizio consolidato che funziona, ci sarà una precedente del servizio in Cloud Run. Questo tutorial utilizza un nuovo servizio senza versioni precedenti, quindi non puoi eseguire un rollback.

Tuttavia, se hai un servizio con versioni precedenti a cui puoi eseguire il rollback, consulta la sezione Visualizzazione dei dettagli della revisione per estrarre il nome del container e i dettagli di configurazione necessari per creare un nuovo deployment funzionante del servizio.

Riproduzione dell'errore in corso...

Utilizzando i dettagli ottenuti in precedenza, conferma si verifica sempre in condizioni di test.

Invia la stessa richiesta HTTP riprovando e controlla se vengono segnalati lo stesso errore con i relativi dettagli. I dettagli dell'errore possono richiedere del tempo che vengano mostrati.

Poiché il servizio di esempio in questo tutorial è di sola lettura e non attiva alcuno complicando gli effetti collaterali, la riproduzione degli errori in produzione è sicura. Tuttavia, per molti servizi reali, non sarà così: potresti dover riprodurre gli errori in un ambiente di test o limitare questo passaggio alle indagini locali.

La riproduzione dell'errore stabilisce il contesto per ulteriori lavori. Ad esempio: Se gli sviluppatori non riescono a riprodurre l'errore, potrebbero essere necessarie ulteriori indagini strumentazione aggiuntiva del servizio.

Esecuzione dell'analisi delle cause principali

L'analisi delle cause principali è un passaggio importante risoluzione dei problemi efficace per assicurarti di risolvere il problema anziché un sintomo.

In precedenza in questo tutorial hai riprodotto il problema in Cloud Run che conferma che il problema è attivo quando il servizio è ospitato su in Cloud Run. Ora riproduci il problema in locale per determinare se è isolato al codice o se emerge solo nell'hosting di produzione.

  1. Se non hai utilizzato l'interfaccia a riga di comando Docker in locale con Container Registry, esegui l'autenticazione con gcloud:

    gcloud auth configure-docker

    Per gli approcci alternativi, vedi Metodi di autenticazione di Container Registry.

  2. Se il nome dell'immagine container utilizzato più di recente non è disponibile, il servizio contiene le informazioni sull'immagine container di cui è stato eseguito il deployment più recente:

    gcloud run services describe hello-service

    Trova il nome dell'immagine container all'interno dell'oggetto spec. Un tipo di campagna kubectl può recuperarlo direttamente:

    gcloud run services describe hello-service \
   --format="value(spec.template.spec.containers.image)"

    Questo comando rivela il nome di un'immagine container come gcr.io/PROJECT_ID/hello-service.

  3. Esegui il pull dell'immagine container da Container Registry al tuo ambiente, potrebbe richiedere diversi minuti per scaricare l'immagine container:

    docker pull gcr.io/PROJECT_ID/hello-service

    È possibile recuperare gli aggiornamenti successivi all'immagine container che riutilizzano questo nome con lo stesso comando. Se salti questo passaggio, utilizza il comando docker run riportato di seguito esegue il pull di un'immagine container se non è presente sulla macchina locale.

  4. Esegui in locale per verificare che il problema non sia univoco di Cloud Run:

    PORT=8080 && docker run --rm -e PORT=$PORT -p 9000:$PORT \
   gcr.io/PROJECT_ID/hello-service

    Analizziamo gli elementi del comando precedente,

    • La variabile di ambiente PORT viene utilizzata dal servizio per determinare la per rimanere in ascolto all'interno del container.
    • Il comando run avvia il container, utilizzando come impostazione predefinita il punto di ingresso definito nel Dockerfile o in un'immagine container padre.
    • Il flag --rm elimina l'istanza di container all'uscita.
    • Il flag -e assegna un valore a una variabile di ambiente. -e PORT=$PORT sta propagando la variabile PORT dal sistema locale al container con lo stesso nome di variabile.
    • Il flag -p pubblica il container come servizio disponibile su localhost sulla porta 9000. Le richieste a localhost:9000 verranno indirizzate al sulla porta 8080. Ciò significa che l'output del servizio relativo alla porta numero in uso non corrisponderà alla modalità di accesso al servizio.
    • L'argomento finale gcr.io/PROJECT_ID/hello-service è l'immagine container tag, un'etichetta leggibile per l'immagine container l'identificatore hash sha256. Se non è disponibile localmente, Docker cerca di per recuperare l'immagine da un registro remoto.

    Nel browser, apri http://localhost:9000. Controlla l'output del terminale per messaggi di errore che corrispondono a quelli su {ops_name}}.

    Se il problema non è riproducibile localmente, potrebbe essere univoco nell'ambiente Cloud Run. Esamina il Guida alla risoluzione dei problemi di Cloud Run per aree specifiche da esaminare.

    In questo caso l'errore viene riprodotto localmente.

Ora che l'errore è confermato doppiamente come permanente e causato dal servizio anziché sulla piattaforma di hosting, è il momento di esaminare il codice in modo più approfondito.

Ai fini di questo tutorial, è consigliabile presupporre il codice all'interno del container e il codice nel sistema locale è identico.

Riesamina l'analisi dello stack del report sugli errori ed esegui un controllo incrociato con il codice per trovare sulle specifiche linee in errore.

Node.js

Individua l'origine del messaggio di errore nel file index.js intorno alla riga numero chiamato nell'analisi dello stack mostrata nei log: 
const {NAME} = process.env;
if (!NAME) {
  // Plain error logs do not appear in Stackdriver Error Reporting.
  console.error('Environment validation failed.');
  console.error(new Error('Missing required server parameter'));
  return res.status(500).send('Internal Server Error');
}

Python

Individua l'origine del messaggio di errore nel file main.py intorno alla riga numero chiamato nell'analisi dello stack mostrata nei log: 
NAME = os.getenv("NAME")

if not NAME:
    print("Environment validation failed.")
    raise Exception("Missing required service parameter.")

Vai

Individua l'origine del messaggio di errore nel file main.go intorno alla riga numero chiamato nell'analisi dello stack mostrata nei log:

name := os.Getenv("NAME")
if name == "" {
	log.Printf("Missing required server parameter")
	// The panic stack trace appears in Cloud Error Reporting.
	panic("Missing required server parameter")
}

Java

Individua l'origine del messaggio di errore nel file App.java, intorno al numero di riga indicato nell'analisi dello stack mostrata nei log:

String name = System.getenv("NAME");
if (name == null) {
  // Standard error logs do not appear in Stackdriver Error Reporting.
  System.err.println("Environment validation failed.");
  String msg = "Missing required server parameter";
  logger.error(msg, new Exception(msg));
  res.status(500);
  return "Internal Server Error";
}

Durante l'esame di questo codice, vengono eseguite le seguenti azioni quando l'ambiente NAME non è impostata:

  • Viene registrato un errore in Google Cloud Observability
  • Viene inviata una risposta di errore HTTP

Il problema è causato da una variabile mancante, ma la causa principale è più specifica: la modifica al codice che aggiungeva la dipendenza rigida su una variabile di ambiente che includa le modifiche correlate agli script di deployment e alla documentazione sui requisiti di runtime.

Risoluzione della causa principale

Ora che abbiamo raccolto il codice e identificato la potenziale causa principale, possiamo adottare alcune misure per risolverlo.

  • Controlla se il servizio funziona localmente con l'ambiente NAME disponibile in uso:

    1. Esegui il container in locale con la variabile di ambiente aggiunta:

      PORT=8080 && docker run --rm -e PORT=$PORT -p 9000:$PORT \
 -e NAME="Local World!" \
 gcr.io/PROJECT_ID/hello-service

    2. Vai all'indirizzo http://localhost:9000 nel browser.

    3. Vedi "Hello Local World!" appaiono sulla pagina

  • Modifica l'ambiente di servizio Cloud Run in esecuzione in modo da includere questa variabile:

    1. Esegui il comando services update per aggiungere una variabile di ambiente:

      gcloud run services update hello-service \
  --set-env-vars NAME=Override

    2. Attendi qualche secondo mentre Cloud Run crea una nuova revisione basata sul revisione precedente con la nuova variabile di ambiente aggiunta.

  • Verifica che il servizio sia stato risolto:

    1. Vai nel browser all'URL del servizio Cloud Run.
    2. Vedi "Hello Override!" vengono visualizzate nella pagina.
    3. Verifica che non vengano visualizzati messaggi o errori imprevisti in Cloud Logging oppure Error Reporting.

Migliorare la velocità futura di risoluzione dei problemi

In questo problema di produzione di esempio, l'errore era correlato alle operazioni configurazione. Alcune modifiche al codice ridurranno al minimo l'impatto di questa problema in futuro.

  • Migliora il log degli errori in modo da includere dettagli più specifici.
  • Invece di restituire un errore, fai in modo che il servizio utilizzi un valore predefinito sicuro. Se l'utilizzo di un valore predefinito rappresenta un cambiamento alla funzionalità normale, utilizza un avviso a fini di monitoraggio.

Vediamo come rimuovere la variabile di ambiente NAME come dipendenza rigida.

  1. Rimuovi il codice di gestione NAME esistente:

    Node.js 

    const {NAME} = process.env;
if (!NAME) {
  // Plain error logs do not appear in Stackdriver Error Reporting.
  console.error('Environment validation failed.');
  console.error(new Error('Missing required server parameter'));
  return res.status(500).send('Internal Server Error');
}

    Python 

    NAME = os.getenv("NAME")

if not NAME:
    print("Environment validation failed.")
    raise Exception("Missing required service parameter.")

    Vai 

    name := os.Getenv("NAME")
if name == "" {
	log.Printf("Missing required server parameter")
	// The panic stack trace appears in Cloud Error Reporting.
	panic("Missing required server parameter")
}

    Java 

    String name = System.getenv("NAME");
if (name == null) {
  // Standard error logs do not appear in Stackdriver Error Reporting.
  System.err.println("Environment validation failed.");
  String msg = "Missing required server parameter";
  logger.error(msg, new Exception(msg));
  res.status(500);
  return "Internal Server Error";
}

  2. Aggiungi un nuovo codice che imposti un valore di riserva:

    Node.js 

    const NAME = process.env.NAME || 'World';
if (!process.env.NAME) {
  console.log(
    JSON.stringify({
      severity: 'WARNING',
      message: `NAME not set, default to '${NAME}'`,
    })
  );
}

    Python 

    NAME = os.getenv("NAME")

if not NAME:
    NAME = "World"
    error_message = {
        "severity": "WARNING",
        "message": f"NAME not set, default to {NAME}",
    }
    print(json.dumps(error_message))

    Vai 

    name := os.Getenv("NAME")
if name == "" {
	name = "World"
	log.Printf("warning: NAME not set, default to %s", name)
}

    Java 

    String name = System.getenv().getOrDefault("NAME", "World");
if (System.getenv("NAME") == null) {
  logger.warn(String.format("NAME not set, default to %s", name));
}

  3. Esegui test in locale ricreando ed eseguendo il container tramite di configurazione:

    Node.js 

    docker build --tag gcr.io/PROJECT_ID/hello-service .

    Python 

    docker build --tag gcr.io/PROJECT_ID/hello-service .

    Vai 

    docker build --tag gcr.io/PROJECT_ID/hello-service .

    Java 

    mvn compile jib:build

    Verifica che la variabile di ambiente NAME continui a funzionare:

    PORT=8080 && docker run --rm -e PORT=$PORT -p 9000:$PORT \
 -e NAME="Robust World" \
 gcr.io/PROJECT_ID/hello-service

    Verifica che il servizio funzioni senza la variabile NAME:

    PORT=8080 && docker run --rm -e PORT=$PORT -p 9000:$PORT \
 gcr.io/PROJECT_ID/hello-service

    Se il servizio non restituisce alcun risultato, conferma la rimozione del codice nel nel primo passaggio non ha rimosso le righe aggiuntive, come quelle utilizzate per scrivere la risposta.

  4. Per il deployment, consulta la sezione Deployment del codice.

    Ogni deployment in un servizio crea una nuova revisione e avvia automaticamente per gestire il traffico quando è pronto.

    Per cancellare le variabili di ambiente impostate in precedenza:

    gcloud run services update hello-service --clear-env-vars

Aggiungi la nuova funzionalità per il valore predefinito alla copertura dei test automatici per il servizio.

Individuazione di altri problemi nei log

Potresti visualizzare altri problemi nel visualizzatore log per questo servizio. Ad esempio, un la chiamata di sistema non supportata verrà visualizzata nei log come "Limitazione di Container Sandbox".

Ad esempio, i servizi Node.js a volte generano questo messaggio di log:

Container Sandbox Limitation: Unsupported syscall statx(0xffffff9c,0x3e1ba8e86d88,0x0,0xfff,0x3e1ba8e86970,0x3e1ba8e86a90). Please, refer to https://gvisor.dev/c/linux/amd64/statx for more information.

In questo caso, la mancanza di assistenza non influisce sul servizio di esempio hello-service.

Risoluzione dei problemi di Terraform

Per la risoluzione dei problemi o per domande relative a Terraform, consulta Risoluzione dei problemi di convalida dei criteri Terraform oppure contatta l'assistenza di Terraform.

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:

  1. Nella console Google Cloud, vai alla pagina Gestisci risorse.

    Vai a Gestisci risorse

  2. Nell'elenco dei progetti, seleziona il progetto che vuoi eliminare, quindi fai clic su Elimina.
  3. Nella finestra di dialogo, digita l'ID del progetto e fai clic su Chiudi per eliminare il progetto.

Eliminazione delle risorse del tutorial in corso...

  1. 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.

  2. Rimuovi la configurazione predefinita della regione gcloud che hai aggiunto durante il tutorial configurazione:

     gcloud config unset run/region

  3. Rimuovi la configurazione del progetto:

     gcloud config unset project

  4. Elimina altre risorse Google Cloud create in questo tutorial:

Passaggi successivi