Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.
Guía de inicio rápido: Escribe y consulta entradas de registro con la CLI de gcloud

Escribe y consulta entradas de registro con gcloud CLI

En este documento, se presentan algunas de las funciones de Cloud Logging y se explica cómo hacer lo siguiente:

  • Escribe entradas de registro mediante Google Cloud CLI.
  • Enumera las entradas de registro con la CLI de gcloud.
  • Mostrar una lista de entradas de registro con la API de Logging
  • Ver y consultar las entradas del registro mediante el explorador de registros

Antes de comenzar

Debes tener un proyecto de Google Cloud con la facturación habilitada para completar esta guía de inicio rápido. Si no tienes un proyecto de Cloud o si no habilitaste la facturación para tu proyecto de Cloud, haz lo siguiente:
  1. Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.
  2. En la página del selector de proyectos de Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  3. Comprueba que la facturación esté habilitada en tu proyecto.

    Descubre cómo puedes habilitar la facturación

  4. En la página del selector de proyectos de Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  5. Comprueba que la facturación esté habilitada en tu proyecto.

    Descubre cómo puedes habilitar la facturación

Cómo comenzar

La CLI de gcloud tiene un grupo de comandos, gcloud logging, que proporciona una interfaz de línea de comandos para la API de Cloud Logging.

Puedes usar el entorno de Cloud Shell o una instancia de máquina virtual (VM) de Compute Engine para los comandos de la CLI de gcloud en esta guía de inicio rápido. La CLI de gcloud está preinstalada en el entorno de Cloud Shell.

Cloud Shell

Verifica que la CLI de gcloud esté configurada para usar el proyecto de Cloud correcto:

  1. En Google Cloud Console, haz clic en Activar Cloud Shell:

    Captura de pantalla del botón de Cloud Shell en Google Cloud Console.

    Cloud Shell se abre en una ventana y muestra un mensaje de bienvenida. El mensaje de bienvenida muestra el ID del proyecto configurado:

    Captura de pantalla de Cloud Shell en la que se muestra un mensaje de bienvenida.

  2. Si quieres usar un proyecto de Cloud diferente del que se indica en el mensaje de bienvenida, ejecuta el siguiente comando después de reemplazar PROJECT_ID por el ID del proyecto:

       gcloud config set project PROJECT_ID
       

    Para obtener el ID del proyecto, consulta Identifica proyectos.

Instancia de VM

Para crear una instancia de VM de Compute Engine en Google Cloud Console, sigue estos pasos:

  1. En Google Cloud Console, selecciona Compute Engine y, luego, Instancias de VM.

  2. Selecciona Crear instancia.

  3. En Identidad y acceso a la API, en Permisos de acceso, selecciona Configurar el acceso para cada API.

  4. Desplázate por las API hasta encontrar la API de Stackdriver Logging. Activa o desactiva el acceso a Completo.

  5. Deja el resto de la configuración con sus valores predeterminados y haz clic en Crear. Tu instancia de VM está lista para usar.

  6. Haz clic en SSH para conectarte a la shell de tu instancia de VM. Después de un momento, se abrirá una shell de Debian GNU/Linux en una ventana y mostrará un mensaje de bienvenida.

  7. Ejecuta el siguiente comando a fin de verificar que la CLI de gcloud esté configurada para tu proyecto de Compute Engine:

    gcloud config list
    
  8. Si quieres usar un proyecto de Cloud diferente, ejecuta el siguiente comando después de reemplazar PROJECT_ID por el ID del proyecto:

      gcloud config set project PROJECT_ID
      

    Para obtener el ID del proyecto, consulta Identifica proyectos.

Escribe entradas de registro con la CLI de gcloud

Logging admite entradas de registro con datos estructurados y no estructurados. Los datos estructurados constan de una estructura de datos JSON; por ejemplo, {"weather": "partly cloudy"}. Los datos no estructurados son una string de caracteres, por ejemplo, "A simple entry". En los siguientes pasos, usarás la CLI de gcloud para escribir una entrada de registro con datos no estructurados y una con datos estructurados:

  1. Escribe una entrada de registro con datos no estructurados en el registro my-test-log:

    gcloud logging write my-test-log "A simple entry."
    

    Cuando el comando finalice, verás el mensaje: Created log entry.

  2. Escribe una entrada de registro con datos estructurados en el registro my-test-log:

    gcloud logging write --payload-type=json my-test-log '{ "message": "My second entry", "weather": "partly cloudy"}'
    

    Cuando escribes una entrada de registro con datos estructurados, debes incluir --payload-type=json. Si omites este campo, Logging interpretará la carga útil como datos no estructurados.

Si el registro my-test-log no existe, Logging creará el registro cuando se reciba la entrada de registro.

Enumera las entradas de registro con la CLI de gcloud

Puedes recuperar entradas de registro de Logging y mostrarlas con la CLI de gcloud. Por ejemplo, para recuperar y mostrar las entradas de registro con un tipo de recurso de global, ejecuta el siguiente comando:

gcloud logging read "resource.type=global"

El comando mostrará un resultado similar al siguiente:

---
insertId: jpj9zjf73t1mn
jsonPayload:
  message: My second entry
  weather: partly cloudy
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:31.114507977Z'
resource:
  labels:
    project_id: myloggingproject
  type: global
timestamp: '2018-11-01T18:39:31.114507977Z'
---
insertId: vd4m1if7h7u1a
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:19.718100792Z'
resource:
  labels:
    project_id: myloggingproject
  type: global
textPayload: A simple entry
timestamp: '2018-11-01T18:39:19.718100792Z'

Muestra una lista de entradas de registro con el Explorador de API

Para ejecutar los métodos de la API de Logging sin escribir ningún código, consulta Usa el Explorador de API. Para leer una lista de entradas de registro de Logging, haz lo siguiente:

  1. Ve a la página de referencia de la API para obtener el método de la API de entries.list:

    Ir a la página de la API de entries.list

  2. Configura y ejecuta el comando de la API:

    1. Reemplaza PROJECT_ID en el siguiente texto:

      "resourceNames": [
      "projects/PROJECT_ID"
      ],
      "filter": "resource.type=global",
      "orderBy": "timestamp desc"
      
    2. Copia el texto actualizado del paso anterior y pégalo en el campo Cuerpo de la solicitud del Explorador de API.

    3. Haz clic en Ejecutar.

    El método muestra una respuesta similar a la siguiente:

    {
      "entries": [
        {
          "textPayload": "A simple entry",
          "insertId": "vd4m1if7h7u1a",
          "resource": {
            "type": "global",
            "labels": {
              "project_id": "myloggingproject"
            }
          },
          "timestamp": "2018-11-01T18:39:19.718100792Z",
          "logName": "projects/myloggingproject/logs/my-test-log",
          "receiveTimestamp": "2018-11-01T18:39:19.718100792Z"
        },
        {
          "insertId": "jpj9zjf73t1mn",
          "jsonPayload": {
            "message": "My second entry",
            "weather": "partly cloudy"
          },
          "resource": {
            "type": "global",
            "labels": {
              "project_id": "myloggingproject"
            }
          },
          "timestamp": "2018-11-01T18:39:31.114507977Z",
          "logName": "projects/myloggingproject/logs/my-test-log",
          "receiveTimestamp": "2018-11-01T18:39:31.114507977Z"
        }
      ]
    }
    

Visualiza entradas de registro en el Explorador de registros

Para ver las entradas de registro en Google Cloud Console, puedes usar el Explorador de registros. La mayoría de los proyectos de Cloud almacenan una gran cantidad de registros; puedes seleccionar ciertas entradas de registro mediante la escritura de una consulta.

Para ver las entradas de registro que escribiste con el Explorador de registros, haz lo siguiente:

  1. Ve al Explorador de registros en Google Cloud Console.

    Ir al Explorador de registros

    Asegúrate de que tu proyecto de Cloud esté seleccionado en la barra de navegación de Google Cloud. Si es necesario, usa la lista desplegable del proyecto de Cloud para seleccionar el proyecto.

  2. En el menú Recurso, selecciona Global.

    Si no ves la opción del menú Global o si no ves las entradas de registro, espera unos minutos y actualiza la página. Es posible que Logging tarde unos minutos en recibir las entradas de registro.

  3. Para ver los detalles de una entrada de registro, haz clic en el menú .

    La primera entrada de registro tiene los datos almacenados en textPayload. La segunda entrada de registro contiene datos estructurados que se almacenan en jsonPayload. La carga útil estructurada contiene las claves message y weather.

Para obtener información sobre el formato de datos de las entradas de registro, consulta el tipo LogEntry.

Consulta entradas de registro en el explorador de registros

Puedes consultar entradas de registro mediante el editor de consultas y, con registros estructurados, por clave y valor. Por ejemplo, para mostrar todas las entradas de registro que contienen el texto simple, haz lo siguiente:

  1. Ve al Explorador de registros en Google Cloud Console.

    Ir al Explorador de registros

  2. En el menú Recurso, selecciona Global.

  3. En el editor de consultas, ingresa la string simple entre comillas. La pantalla de registros solo muestra la entrada de registro A simple entry.

  4. Después de ver el registro, quita la string de consulta que agregaste y haz clic en Ejecutar consulta. Ambas entradas de registro volverán a aparecer en la pantalla.

Para mostrar todas las entradas de registro con datos estructurados que tienen una clave de weather en la que el campo value contiene partly, haz lo siguiente:

  1. El editor de consultas contiene la línea resource.type="global". Ingrese el siguiente comando:

    jsonPayload.weather:partly
    
  2. Haga clic en Ejecutar consulta. El resultado es la entrada de registro única My second entry.

El Explorador de registros también ofrece consultas guardadas, sugeridas y recientes. Para obtener más información sobre las consultas, visita Compila consultas en el Explorador de registros.

Para consultas de muestra, visita Consultas de muestra con el Explorador de registros.

Soluciona problemas

  • Los errores tipográficos y los nombres de campos desconocidos hacen que los comandos de la CLI de gcloud se completen con mensajes de argumento no válido. Por ejemplo, si olvidas el punto en resource.type, se produce el siguiente error:

     ERROR: (gcloud.logging.read) INVALID_ARGUMENT: Field not found: 'resourcetype'.
    
  • Cuando Cloud Logging no tiene los permisos de acceso necesarios, los comandos de la CLI de gcloud se completan con mensajes de permiso denegado. Por ejemplo, si se configuró una instancia de VM de Compute Engine con la configuración de API predeterminada, el comando list se completa con un error de permiso denegado:

     ERROR: (gcloud.logging.read) PERMISSION_DENIED: Request had insufficient authentication scopes.
    

    Para corregir esta condición, modifica los permisos de la instancia de VM de Compute Engine a fin de otorgar permiso de lectura a Cloud Logging mediante los siguientes pasos:

    1. Ve a la página Detalles de instancia de VM de tu instancia de VM. Haz clic en Detener. Esta acción podría tardar uno o dos minutos en completarse.
    2. Para modificar la configuración, haz clic en Editar.
    3. Busca el encabezado Permiso de acceso a la API de Cloud y haz clic en Detalles para mostrar la configuración de cada API. Cambia la entrada de la API de Cloud Logging a Completo. Haga clic en Guardar.
    4. Para reiniciar las instancias de VM, haz clic en Comenzar. Tras unos instantes, tu VM estará lista para que la uses.
  • Cuando el Explorador de API no puede completar tu comando o requiere autorización adicional, muestra un mensaje o código de error:

    • Código de respuesta 200 y ninguna entrada: Si se muestra el mensaje nextPageToken, significa que el Explorador de API no tuvo tiempo para completar la búsqueda. Agrega un pageToken a tu solicitud, establece el valor para que sea el mismo que se ingresó con la clave nextPageToken y vuelve a intentar ejecutar el comando.
    • Código de respuesta 400: el valor de la consulta no es válido. Por ejemplo, si escribiste mal global como gloobal, el mensaje es Unsupported resource type: gloobal.
    • Código de respuesta 404: el ID del proyecto no es válido. Controla la ortografía del identificador de tu proyecto.
    • Es posible que se te solicite acceder a tu Cuenta de Google y otorgarle acceso a tu cuenta al Explorador de API.

Realiza una limpieza

Sigue estos pasos para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos que usaste en esta página.

  1. (Opcional) Para borrar las entradas de registro que creaste, ejecuta el siguiente comando gcloud:

    gcloud logging logs delete my-test-log
    

    Si no las borras, caducarán y se quitarán. Para obtener información sobre la retención, consulta Cuotas y límites.

¿Qué sigue?