Escribe y consulta entradas de registro con gcloud CLI
Google Cloud CLI te permite escribir y consultar entradas de registro en Cloud Logging desde la línea de comandos para que puedas probar la transferencia de registros y, además, inspeccionar los datos de registro sin escribir código de la aplicación. En esta guía de inicio rápido, escribirás y enumerarás entradas de registro estructuradas y no estructuradas con la gcloud CLI, enumerarás entradas de registro con la API de Cloud Logging y verás y consultarás registros con el Explorador de registros.
Antes de comenzar
Para completar esta guía de inicio rápido, debes tener un proyecto de Cloud de Confiance con la facturación habilitada. Si no tienes un proyecto de Cloud de Confiance o si no tienes habilitada la facturación para tu proyecto de Cloud de Confiance , haz lo siguiente:-
Instala Google Cloud CLI.
-
Configura gcloud CLI para usar tu identidad federada.
Para obtener más información, consulta Accede a gcloud CLI con tu identidad federada.
-
Para inicializar gcloud CLI, ejecuta el siguiente comando:
gcloud init -
Crea o selecciona un proyecto de Cloud de Confiance .
Roles necesarios para seleccionar o crear un proyecto
- Selecciona un proyecto: Para seleccionar un proyecto, no se requiere un rol de IAM específico. Puedes seleccionar cualquier proyecto en el que se te haya otorgado un rol.
-
Crea un proyecto: Para crear un proyecto, necesitas el rol de creador de proyectos
(
roles/resourcemanager.projectCreator), que contiene el permisoresourcemanager.projects.create. Obtén más información para otorgar roles.
-
Crea un proyecto de Cloud de Confiance :
gcloud projects create PROJECT_ID
Reemplaza
PROJECT_IDpor un nombre para el proyecto de Cloud de Confiance que estás creando. -
Selecciona el proyecto de Cloud de Confiance que creaste:
gcloud config set project PROJECT_ID
Reemplaza
PROJECT_IDpor el nombre de tu proyecto de Cloud de Confiance .
-
Si usas un proyecto existente en esta guía, verifica que tengas los permisos necesarios para completarla. Si creaste un proyecto nuevo, ya tienes los permisos necesarios.
-
Verifica que la facturación esté habilitada para tu proyecto de Cloud de Confiance .
Roles obligatorios
Para obtener los permisos que
necesitas para crear, enumerar y borrar entradas de registro,
pídele a tu administrador que te otorgue el rol de IAM de
Administrador de Logging (roles/logging.admin) en tu proyecto.
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.
Los roles de escritor de registros (roles/logging.logWriter) y visualizador de registros
(roles/logging.viewer) contienen los permisos para crear y enumerar
entradas de registro. Para borrar entradas de registro, otorga el rol de Administrador de Logging
(roles/logging.admin), que contiene los permisos para crear, enumerar
y borrar entradas de registro. Ten en cuenta que el rol de administrador de Logging
(roles/logging.admin) también otorga permisos para realizar todas las acciones
en Logging.
Escribe entradas de registro con gcloud CLI
Logging admite entradas de registro con datos estructurados y no estructurados. Los datos estructurados consisten en 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 gcloud CLI para escribir una entrada de registro con datos no estructurados y una entrada de registro con datos estructurados. La gcloud CLI proporciona una interfaz de línea de comandos para la API de Cloud Logging.
Para escribir una entrada de registro con datos no estructurados en el registro
my-test-log, ejecuta el comandogcloud logging write:gcloud logging write my-test-log "A simple entry."Cuando el comando finalice, verás el mensaje:
Created log entry.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 interpreta 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 gcloud CLI
Puedes recuperar 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 la lectura de registros, consulta la
documentación de referencia de gcloud logging read.
Visualiza las entradas de registro en el Explorador de registros
Para ver las entradas de registro en la consola de Cloud de Confiance , puedes usar el Explorador de registros. La mayoría de los proyectos de Cloud de Confiance almacenan una gran cantidad de registros. Puedes seleccionar ciertas entradas de registro escribiendo una consulta.
Para ver las entradas de registro que escribiste con el Explorador de registros, haz lo siguiente:
-
En la consola de Cloud de Confiance , ve a la página Explorador de registros del :
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 Cloud de Confiance esté seleccionado en la barra de navegación de Cloud de Confiance by S3NS. Si es necesario, usa la lista desplegable de proyectos de Cloud de Confiance para seleccionar tu proyecto de Cloud de Confiance .
En el menú Recurso, selecciona Global.
Si no ves la opción de menú Global o si no ves tus entradas de registro, espera unos minutos y actualiza la página. Es posible que Logging tarde unos minutos en recibir las entradas de registro.
Para ver los detalles de una entrada de registro, haz clic en su menúchevron_right.
La primera entrada de registro tiene los datos almacenados en
textPayload. La segunda entrada de registro contiene datos estructurados que se almacenan enjsonPayload. La carga útil estructurada contiene las clavesmessageyweather.
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 las entradas de registro con el editor de consultas y, con los registros estructurados,
por la clave y el valor. Por ejemplo, para mostrar todas las entradas de registro que contienen el
texto simple, haz lo siguiente:
-
En la consola de Cloud de Confiance , ve a la página Explorador de registros del :
Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Logging.
En el menú Recurso, selecciona Global.
En el editor de consultas, ingresa la cadena
simpleentre comillas. La pantalla de registros solo muestra la entrada de registroA simple entry.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:
El editor de consultas contiene la línea
resource.type="global". Ingresa el siguiente comando:jsonPayload.weather:partlyHaz 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 consultas de ejemplo, consulta Consultas de ejemplo con el Explorador de registros.
Soluciona problemas
Los errores tipográficos y los nombres de campo desconocidos hacen que los comandos de gcloud CLI 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 no se otorgan los permisos de acceso necesarios a Cloud Logging, 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 los parámetros de configuración predeterminados de la API, el comando
listse completa con un error de permiso denegado:ERROR: (gcloud.logging.read) PERMISSION_DENIED: Request had insufficient authentication scopes.Para solucionar este problema, modifica los permisos de la instancia de VM de Compute Engine para otorgar permiso de lectura de Cloud Logging de la siguiente manera:
- 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.
- Para modificar la configuración, haz clic en Editar.
- 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.
- Para reiniciar las instancias de VM, haz clic en Comenzar. Tras unos instantes, tu VM estará lista para que la uses.
Realiza una limpieza
Para evitar que se apliquen cargos a tu cuenta de Cloud de Confiance por los recursos que usaste en esta página, borra el proyecto de Cloud de Confiance que tiene los recursos.
(Opcional) Para borrar las entradas de registro que creaste, ejecuta el siguiente comando
gcloud:gcloud logging logs delete my-test-log
Si no borras las entradas de registro, estas vencen y se quitan. Para obtener información sobre la retención, consulta Cuotas y límites.
¿Qué sigue?
- Para obtener detalles sobre la interfaz de línea de comandos de Logging, lee las páginas de referencia del grupo de comandos
gcloud logging. - Para obtener documentación sobre la API de Logging, consulta API de Cloud Logging.
- Para obtener detalles sobre el Explorador de registros, consulta Usa el Explorador de registros.