Escribe y consulta entradas de registro con gcloud CLI

Escribe entradas de registro con gcloud CLI

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 próximos pasos, usarás gcloud CLI para escribir una entrada de registro con datos no estructurados y una entrada de registro con datos estructurados. La CLI de gcloud proporciona una interfaz de línea de comandos para la API de Cloud Logging.

1. Escribe una entrada de registro con datos no estructurados en el registro my-test-log y ejecuta el comando gcloud logging write:

   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.

Muestra una lista de entradas de registro con gcloud CLI

Puedes recuperar las entradas de registro de Logging y mostrarlas con gcloud CLI. Por ejemplo, para recuperar y mostrar las entradas de registro con un tipo de recurso 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'

Para obtener información sobre cómo leer registros, consulta la documentación de referencia de gcloud logging read.

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

Para ejecutar métodos de la API de Logging sin escribir ningún código, consulta Cómo usar el Explorador de API. Para leer una lista de entradas de registro desde 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 APIs.

   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 la consola de Google Cloud, puedes usar el Explorador de registros. La mayoría de los proyectos de Google Cloud almacenan una gran cantidad de registros. Para seleccionar ciertas entradas de registro, escribe una consulta.

Para ver las entradas de registro que escribiste con el Explorador de registros, sigue estos pasos:

1. En la consola de Google Cloud, ve a la página Explorador de registros.

   Ir al Explorador de registros

   Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Logging.

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

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 su chevron_right 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. En la consola de Google Cloud, ve a la página Explorador de registros.

   Ir al Explorador de registros

   Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Logging.

2. En el menú Recurso, selecciona Global.

3. En el editor de consultas, ingresa la cadena 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 cadena 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". Ingresa el siguiente comando:

   jsonPayload.weather:partly
   

2. Haz 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, consulta Compila consultas en el Explorador de registros.

Para ver ejemplos de consultas, consulta 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 gcloud CLI den el mensaje argumento no válido cuando se completan. 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 recibe los permisos de acceso necesarios, los comandos de gcloud CLI se completan con mensajes de permiso denegado. Por ejemplo, si una instancia de VM de Compute Engine está configurada con la configuración predeterminada de la API, 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 para otorgarle a Cloud Logging el permiso de lectura, de la siguiente manera:

  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. Haz 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, indica que el Explorador de APIs 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 escribes mal global como gloobal, el mensaje será 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 proyecto de Google Cloud y otorgarle acceso a tu cuenta al Explorador de APIs.