Se usó la API de Cloud Translation para traducir esta página.

Configura métricas de contadores

En este documento, se explica cómo crear una métrica basada en registro de tipo contador con Google Cloud Console, la API de Logging y Google Cloud CLI.

Las métricas de contador cuentan la cantidad de entradas de registro que coinciden con un filtro determinado. Por ejemplo, puedes crear una métrica basada en registros que cuente la cantidad de entradas de registro que contienen un mensaje de error específico.

Para obtener una descripción general de las métricas basadas en registros, consulta Descripción general de las métricas basadas en registros.

Antes de comenzar

Para usar métricas basadas en registros, debes tener un proyecto de Cloud con la facturación habilitada:
Asegúrate de que la función de Identity and Access Management incluya los permisos necesarios para crear y ver métricas basadas en registros y crear políticas de alertas. A fin de obtener detalles, consulta Permisos para métricas basadas en registros.

Crea una métrica de contador basada en registros

Cuando creas un filtro para las entradas de registro que deseas contar en tu métrica, puedes usar expresiones regulares. Ten en cuenta que la longitud de un filtro no puede superar los 20,000 caracteres.

Consola

Sigue estos pasos para crear una métrica de contador en Google Cloud Console en tu proyecto de Google Cloud:

En Google Cloud Console, selecciona Logging en el menú de navegación y, luego, haz clic en Métricas basadas en registros:
Ir a Métricas basadas en registros
Haga clic en Crear métrica. Aparecerá el panel Crear métrica de registros.
Para el Tipo de métrica, selecciona Contador.
Configura los siguientes campos en la sección Detalles:
- Log metric name (Nombre de la métrica de registro): elige un nombre que sea único entre las métricas basadas en registros en tu proyecto de Cloud. Se aplican algunas restricciones de denominación. Para obtener más detalles, consulta Solución de problemas.
- Descripción: ingresa una descripción para la métrica.
- Unidades: deja este campo en blanco o inserta el número 1.
Define tu filtro de métricas en la sección Selección de filtro.

Crea un filtro que solo recopile las entradas de registro que deseas contar en tu métrica con el lenguaje de consulta de Logging. También puedes usar expresiones regulares para crear filtros de tu métrica.

Haz clic en Obtener vista previa de los registros para abrir un panel que muestre las entradas de registro que coinciden con el filtro.
Agrega una etiqueta en la sección Etiquetas (opcional). Para obtener instrucciones sobre cómo crear etiquetas, consulta Crea una etiqueta.
Haz clic en Crear métrica a fin de crear la métrica.

gcloud

Google Cloud CLI admite métricas basadas en registros de contador sin etiquetas. El comando para crear una métrica basada en registros es el siguiente:

gcloud logging metrics create METRIC_NAME \
      --description "METRIC_DESCRIPTION" \
      --log-filter "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 de Cloud. Se aplican algunas restricciones de denominación; para obtener más detalles, consulta la sección de solución de problemas de métricas basadas en registros.

API

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:

Establece el campo Superior en el proyecto en el que se creará la métrica:
```
projects/PROJECT_ID
```

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 la sección 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 las etiquetas de métricas basadas en registros a fin de obtener una introducción a las etiquetas y detalles sobre cómo crearlas en la API.

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

Latencia de métrica nueva

Tu métrica nueva aparece de inmediato en la lista de métricas del Explorador de registros y en los menús relevantes de Monitoring. Por lo general, los datos están disponibles en menos de un minuto.

Inspecciona métricas basadas en registros

Para enumerar las métricas basadas en registros definidas por el usuario en tu proyecto de Google Cloud o inspeccionar una métrica en particular en tu proyecto de Cloud, haz lo siguiente:

Consola

En Google Cloud Console, selecciona Logging en el menú de navegación y, luego, haz clic en Métricas basadas en registros:
Ir a Métricas basadas en registros
En el panel Métricas definidas por el usuario, verás las métricas basadas en registros definidas por el usuario en el proyecto de Cloud actual:
Para ver los datos de una métrica basada en registros, haz clic en el menú en la fila de la métrica y selecciona View in Metrics Explorer (Ver en el Explorador de métricas).

gcloud

Para enumerar las métricas basadas en registros definidas por el usuario en tu proyecto de Cloud, 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 de Cloud, usa el siguiente comando:

gcloud logging metrics describe METRIC_NAME

Para obtener ayuda, usa el siguiente comando:

gcloud logging metrics --help

No puedes leer los datos de series temporales de una métrica de Google Cloud CLI.

API

Mostrar métricas

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

parent: es el nombre del recurso del proyecto de Cloud: `projects/PROJECT_ID.
pageSize: la cantidad máxima de resultados.
pageToken: obtiene la próxima página de resultados. Para obtener más información sobre el uso de tokens de página, 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 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 serie temporal de una métrica basada en registros, usa projects.timeseries.list en la API de Cloud Monitoring. Para obtener detalles sobre los datos de series temporales, consulta Lee series temporales.

Para leer una sola métrica basada en registros definida por el usuario, completa los parámetros del método con este identificador y tipo de métrica:

logging.googleapis.com/user/METRIC_ID

Actualizar métricas basadas en registros

Puedes editar una métrica basada en registros definida por el usuario para cambiar su descripción, filtro 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 definidas por el usuario ni sus etiquetas, y tampoco puedes borrar las etiquetas existentes en una métrica basada en registros.

Para editar una métrica basada en registros, haz lo siguiente:

Consola

En Google Cloud Console, selecciona Logging en el menú de navegación y, luego, haz clic en Métricas basadas en registros:
Ir a Métricas basadas en registros
Haz clic en Editar métrica en el menú para la métrica basada en registros que deseas modificar.
Cambia los elementos permitidos en la métrica.
Haz clic en Actualizar métrica.

gcloud

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

Para actualizar una métrica basada en registros, usa el siguiente comando. 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

API

Para editar 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 es igual a la métrica existente excepto por los cambios y adiciones que deseas hacer.

Borrar métricas basadas en registros

Para borrar una métrica basada en registros definida por el usuario, haz lo siguiente:

Consola

En Google Cloud Console, selecciona Logging en el menú de navegación y, luego, haz clic en Métricas basadas en registros:
Ir a Métricas basadas en registros
Selecciona la métrica que deseas borrar y haz clic en Borrar.

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

gcloud

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

gcloud logging metrics delete METRIC_NAME

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

gcloud logging metrics delete --help

API

A fin de borrar una métrica basada en registros definida por el usuario, usa el método projects.metrics.delete en la API.

Además, en la página Métricas basadas en registros de la consola de Google Cloud, el panel Métricas definidas por el usuario de la interfaz de métricas basadas en registros proporciona más funciones para ayudarte a administrar las métricas definidas por el usuario en tu proyecto de Cloud. Consulta Panel de métricas definidas por el usuario para obtener más información.