Crea métricas de contador

En esta página, se explica cómo crear métricas de contador basadas en registros mediante Cloud Console, la API de Logging y la herramienta de línea de comandos de gcloud.

Para obtener una descripción general de las métricas basadas en registros, incluida la información de solución de problemas, ve a Descripción general de las métricas basadas en registros.

Crea una métrica de contador

Consola de Logging

Sigue estos pasos para crear una métrica de contador basada en registros en Cloud Console:

  1. Haz clic en Stackdriver Logging > Métricas basadas en registros en la lista de navegación de la izquierda en Cloud Console o en el siguiente botón:

    Ir a Métricas basadas en registros

  2. Usa el menú desplegable en la parte superior de la página para seleccionar un proyecto.

  3. Haz clic en Create Metric (Crear métrica) en la parte superior de la página. Verás el Editor de métricas del lado derecho de la página y el panel del visor que muestra tus registros del lado izquierdo:

    Crea una métrica de contador

  4. En el panel del visor, crea una consulta que muestre solo las entradas de registro que deseas contar en tu métrica.

    La consulta básica está disponible en los menús desplegables sobre las entradas de registro. También puedes acceder a la interfaz de consulta avanzada. Para ello, haz clic en el menú desplegable en el lado derecho de la barra de búsqueda y selecciona Convertir a filtro avanzado.

    A fin de obtener más información, consulta el Visor de registros.

  5. En el panel de Editor de métricas, configura los siguientes campos:

    • Nombre: elige un nombre que sea único entre las métricas basadas en registros de tu proyecto. Se aplican algunas restricciones de denominación; para obtener más detalles consulta Solución de problemas.
    • Descripción: describe la métrica.
    • Etiquetas: haz clic en Agregar elemento en cada etiqueta para agregar etiquetas (opcional). A fin de obtener detalles sobre la definición de etiquetas, consulta Etiquetas de métricas basadas en registros.
    • Unidades: en métricas de contador, deja este campo en blanco o inserta el número 1.
    • Type (Tipo): Contador.
  6. Haz clic en Create Metric a fin de crear la métrica.

API de Logging

Para crear una métrica de contador, usa el método projects.metrics.create de la API de Logging. Puedes probar el método en el Explorador de API. Prepara los argumentos del método de la siguiente manera:

  1. Establece el campo superior en el proyecto en el que se creará la métrica:

    projects/[PROJECT_ID]
    
  2. Establece el cuerpo de la solicitud como un objeto LogMetric. A continuación, se muestra un ejemplo del objeto:

    {
      name:        "my-metric"
      description: "This is my metric."
      filter:      "resource.type=gce_instance AND logName:\"logs/syslog\"",
      metricDescriptor: {
          labels: [
            {
              key: "my-label",
              valueType: STRING,
              description: "This is my label.",
            }
          ]
      },
      labelExtractors: {
        "my-label":
          "REGEXP_EXTRACT(jsonPayload.someField, \"before ([0-9]+) after\")",
        ...
      },
    }
    

Notas:

  • Elige un nombre de métrica que sea único entre las métricas basadas en registros en tu proyecto. Se aplican algunas restricciones de denominación; para obtener más detalles consulta Solución de problemas.

  • Para las métricas de contador, los campos LogMetric valueExtractor y bucketOptions no cumplen ningún propósito y se omiten.

  • Si la métrica no tiene etiquetas, puedes omitir los campos metricDescriptor y labelExtractors. Si tu métrica tiene etiquetas, consulta Etiquetas de métricas basadas en registros a fin de obtener una introducción a las etiquetas y los detalles sobre cómo crearlas en la API.

A fin de obtener más detalles, consulta el tipo LogMetric.

SDK de Cloud

La herramienta de línea de comandos de gcloud admite métricas de contador basadas en registros sin etiquetas. A continuación, se muestra el comando para crear métricas basadas en registros:

gcloud logging metrics create [METRIC_NAME] [METRIC_DESCRIPTION] [FILTER]

Por ejemplo, el siguiente comando crea una métrica de contador basada en registros llamada error_count.

gcloud logging metrics create error_count \
    --description "Errors in syslog." \
    --log-filter "resource.type=gce_instance AND logName:logs/syslog AND severity>=ERROR"

Elige un nombre de métrica que sea único entre las métricas basadas en registros en tu proyecto. Se aplican algunas restricciones de denominación; para obtener más detalles consulta la sección Solución de problemas.

Latencia de métrica nueva

Tu nueva métrica aparece en la lista de métricas del Visor de registros y en los menús relevantes de Monitoring de inmediato. Los datos deberían estar disponibles en menos de un minuto.

Inspecciona métricas de contador

A fin de crear una lista de las métricas basadas en registros de tu proyecto de GCP o inspeccionar una métrica particular en tu proyecto, haz lo siguiente:

Consola de Logging

Haz clic en el siguiente botón para ir a la página Métricas basadas en registros, que muestra una lista de todas las métricas basadas en registros en el proyecto actual:

Ir a Métricas basadas en registros

A fin de ver los datos en una métrica basada en registros, selecciona Ver en Explorador de métricas en el menú ampliado del lado derecho de la lista de métricas.

API de Logging

Enumera las métricas

Para enumerar las métricas basadas en registros definidas por el usuario en un proyecto, usa el método de la API projects.metrics.list. Completa los parámetros del método de la siguiente manera:

  • parent: es el nombre del recurso del proyecto: projects/[PROJECT_ID].
  • pageSize: es la cantidad máxima de resultados.
  • pageToken: se obtiene la próxima página de resultados. Consulta projects.metrics.list.

Recupera definiciones de métricas

A fin de recuperar una sola métrica basada en registros definida por el usuario, usa el método de la API projects.metrics.get. Completa los parámetros del método de la siguiente manera:

  • metricName: el nombre del recurso de la métrica:

    projects/[PROJECT_ID]/metrics/[METRIC_ID]
    

Lee datos de métricas

Para leer los datos de series temporales en una métrica basada en registros, usa projects.timeseries.list en la API de Stackdriver Monitoring. Para obtener más información, consulta Lee series temporales. A continuación, se presenta la información que necesitas para las métricas basadas en registros:

  • El tipo de métrica es logging.googleapis.com/user/[METRIC_ID].

SDK de Cloud

A fin de realizar una lista de las métricas basadas en registros definidas por el usuario en tu proyecto, usa el siguiente comando:

gcloud logging metrics list

A fin de mostrar una métrica basada en registros definida por el usuario en tu proyecto, usa el siguiente comando:

gcloud logging metrics describe [METRIC_NAME]

Para obtener más detalles, usa el siguiente comando:

gcloud logging metrics --help

No puedes leer los datos de series temporales de una métrica con el SDK de Cloud.

Actualiza métricas de contador

Puedes actualizar una métrica basada en registros para cambiar la descripción, las consultas y los nombres de los campos a los que se hace referencia en la métrica. Puedes agregar etiquetas nuevas a la métrica y cambiar las expresiones regulares usadas a fin de extraer valores para la métrica y sus etiquetas.

No puedes cambiar los nombres o tipos de las métricas basadas en registros o sus etiquetas. Tampoco puedes borrar las etiquetas existentes en una métrica basada en registros.

A fin de editar o actualizar una métrica basada en registros, haz lo siguiente:

Consola de Logging

  1. Dirígete a la página Métricas basadas en registros:

    Ir a Métricas basadas en registros

  2. Haz clic en Editar métrica en el menú a la derecha de la métrica basada en registros que deseas editar.

  3. Cambia solo los elementos permitidos en la métrica.

  4. Haz clic en Listo.

API de Logging

A fin de editar o actualizar una métrica basada en registros, usa el método projects.metrics.update en la API. Configura los campos de la siguiente manera:

  • metricName: es el nombre completo del recurso de la métrica:

    projects/[PROJECT_ID]/metrics/[METRIC_ID]
    

    Por ejemplo:

    projects/my-gcp-project/metrics/my-error-metric
    
  • En el cuerpo de la solicitud, incluye un objeto LogMetric que sea igual a la métrica existente excepto por los cambios y adiciones que desees hacer.

SDK de Cloud

Solo puedes cambiar la descripción y la consulta de una métrica existente con el SDK de Cloud.

Usa el siguiente comando para actualizar una métrica basada en registros. Puedes especificar cualquiera de las dos marcas, o ambas:

gcloud logging metrics update [METRIC_NAME] --description=[DESCRIPTION] --log-filter=[FILTER]

Para obtener más detalles, usa el siguiente comando:

gcloud logging metrics update --help

Borra métricas de contadores

A fin de borrar una métrica basada en registros, haz lo siguiente:

Consola de Logging

  1. Dirígete a la página Métricas basadas en registros:

    Ir a Métricas basadas en registros

  2. Selecciona las métricas que deseas borrar y haz clic en Borrar en la parte superior de la página.

    De manera alternativa, haz clic en Borrar métrica en el menú a la derecha de la métrica basada en registros que deseas borrar.

API de Logging

Usa el método projects.metrics.delete en la API.

SDK de Cloud

Usa el siguiente comando para borrar una métrica basada en registros definida por el usuario en el proyecto actual:

gcloud logging metrics delete [METRIC_NAME]

Para obtener más detalles, usa el siguiente comando:

gcloud logging metrics delete --help