Filtros de supervisión

En esta guía, se describe cómo configurar filtros cuando usas la API de Monitoring. Usa filtros para especificar recursos supervisados, tipos de métricas, definiciones de grupo y series temporales.

También puedes usar un filtro para configurar una política de alertas que supervise los procesos en ejecución en tus sistemas. Para obtener información sobre esos filtros, consulta Filtros de estado del proceso.

Antes de comenzar

Si no estás familiarizado con las métricas, las series temporales y los recursos supervisados, consulta Métricas, series temporales y recursos.

Si no estás familiarizado con las etiquetas, consulta Etiquetas para obtener una introducción.

Usa filtros

Puedes usar filtros en la API de Monitoring para hacer lo siguiente:

  • Selecciona los datos de series temporales específicos que se muestran a partir de una solicitud a la API de list. El filtro puede seleccionar series temporales en función del proyecto, el grupo, las propiedades de recursos supervisados y las propiedades de las métricas de los datos. Para obtener más información y ejemplos, consulta Recupera datos de series temporales.

  • Asigna recursos a una Group según las propiedades de los recursos y el proyecto al que pertenecen. Para obtener más información y ejemplos, consulta Define la membresía del grupo.

  • Selecciona recursos dentro de un grupo según las propiedades de los recursos y el proyecto al que pertenecen. Para obtener más información y ejemplos, consulta Enumera los miembros del grupo.

  • Enumera los tipos de métricas particulares. Para obtener más información y ejemplos, consulta Enumera descriptores de métricas.

  • Enumera tipos de recursos supervisados específicos. Para obtener más información y ejemplos, consulta Enumera los descriptores de recursos supervisados.

Filtra selectores

Un filtro consta de al menos un selector, que es una palabra clave del filtro. En los siguientes ejemplos simples, se ilustran los diferentes selectores:

  • project: Coincide cuando el proyecto de alcance de las métricas del proyecto especificado es visible para las métricas del proyecto especificado en el parámetro name.

    Usa el selector project cuando un proyecto de Google Cloud pueda ver las métricas de varios proyectos de Google Cloud o cuentas de AWS y solo desees métricas para un solo proyecto. Por ejemplo, si el alcance de las métricas para Project-A incluye Project-B, entonces se produce una coincidencia cuando name tiene un valor de Project-A. usa el siguiente filtro:

        project = "Project-B"
    
  • group: Coincide con los recursos que pertenecen a un Group.

    • Haz coincidir el grupo con el identificador group-id:

      group.id = "group-id"
      
  • resource: Coincide con recursos supervisados de un tipo en particular o con valores de etiqueta particulares.

    • Coincide con todos los recursos supervisados que son instancias de máquina virtual (VM) de Compute Engine:

      resource.type = "gce_instance"
      
    • Coincide con todos los recursos cuya zona comienza con europe-:

      resource.labels.zone = starts_with("europe-")
      
  • metric: Coincide con un tipo de métrica o una serie temporal particular con una etiqueta en particular que coincide con un valor específico.

    • Coincide con una métrica específica:

      metric.type = "compute.googleapis.com/instance/cpu/usage_time"
      
    • Haz coincidir las series temporales con una etiqueta llamada instance_name cuyo valor comienza con gke-hipster o gke-nginx:

      metric.labels.instance_name = monitoring.regex.full_match("^gke-(hipster|nginx).*")
      

En la siguiente tabla, se muestra qué selectores están permitidos en los filtros basados en la llamada a la API de Monitoring:

Propósito del filtro Selector de proyectos. Selector de grupos Selector de recursos Selector de métricas
Define grupos 1
Enumerar miembros de grupo
Enumera series temporales 2
Enumerar descriptores de métrica
Enumera descriptores de recursos supervisados
1 El selector de recursos tiene opciones adicionales cuando se usa para definir la membresía del grupo.
2 Cuando enumeras series temporales, debes especificar exactamente un tipo de métrica.

En las próximas secciones, se muestran ejemplos de usos típicos de los filtros de supervisión. Consulta Sintaxis del filtro para ver un análisis completo de los objetos y los operadores de filtros disponibles.

Recupera datos de series temporales

Método: projects.timeSeries.list
Filtrar objetos: project, group.id, resource.type , resource.labels.[KEY], metric.type, metric.labels.[KEY]

Una serie temporal es una lista de datos con marcas de tiempo de un tipo de métrica de un recurso supervisado específico. Para obtener más detalles, consulta El modelo de métrica. Un tipo de métrica se especifica mediante un descriptor de métrica y el recurso supervisado se especifica mediante un descriptor de recurso supervisado.

El filtro especificado en el comando list debe incluir un selector metric y ese selector debe especificar exactamente un tipo de métrica:

  • Devuelve todas las series temporales para un tipo de métrica en particular.

    metric.type = "compute.googleapis.com/instance/cpu/usage_time"
    
  • Mostrar todas las series temporales de un grupo específico El selector group solo funciona con datos de series temporales alineadas. Consulta Selector de grupos para obtener más información:

    metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
        group.id = "2468013579"
    
  • Mostrar todas las series temporales de una instancia específica de Compute Engine:

    metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
        metric.labels.instance_name = "my-instance-name"
    
  • Mostrar todas las series temporales de las instancias de Compute Engine cuyos nombres comienzan con frontend-:

    metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
        metric.labels.instance_name = starts_with("frontend-")
    
  • Mostrar todas las series temporales de las instancias de Compute Engine cuyos nombres comienzan con gke-hipster o gke-nginx:

    metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
        metric.labels.instance_name = monitoring.regex.full_match("^gke-(hipster|nginx).*")
    

Define la membresía del grupo

Método: projects.groups
Filtrar objetos: project, resource.type, resource.labels.key , metadata.system_labels.[KEY], metadata.user_labels.[KEY]

Un grupo puede contener cualquier cantidad de recursos, como lo especifica un filtro. La membresía del grupo es dinámica. Puede que coincidan más o menos recursos con el filtro cada vez que este se evalúa. El parámetro name en el objeto Group especifica el grupo y el proyecto de alcance de un alcance de métricas. Si se usa el selector project en el filtro, debe especificar un proyecto cuyas métricas sean visibles para el proyecto de alcance.

  • Todas las instancias de máquina virtual (VM) de Compute Engine en Europa:

    resource.type = "gce_instance" AND resource.labels.zone = starts_with("europe-")
    

Enumera miembros del grupo

Método: projects.groups.members.list
Filtrar objetos: project, resource.type, resource.labels.[KEY]

Usa un filtro para limitar los miembros del grupo que recuperas. El parámetro name especifica un proyecto de alcance de un alcance de métricas y un grupo definido en ese proyecto. Si se usa el selector project en el filtro, debe especificar un proyecto cuyas métricas sean visibles para el proyecto de alcance.

  • Todos los recursos de tema de Pub/Sub que pertenecen al proyecto my-project:

    project = "my-project" AND resource.type = "pubsub_topic"
    

Enumera descriptores de métricas

Método: projects.metricDescriptors.list
Filtrar objetos: project, metric.type

Usa un filtro para limitar los descriptores de métricas que recuperas:

  • Para que solo se muestren los descriptores de métricas de Compute Engine, usa el siguiente filtro:

    metric.type = starts_with("compute.googleapis.com")
    

Consulta Lista de métricas para obtener una lista completa de los tipos de métricas definidos por Monitoring. Para obtener una descripción general de cómo se nombran las métricas, consulta Las convenciones de asignación de nombres y los requisitos.

Enumera descriptores de recursos supervisados

Método: projects.monitoredResourceDescriptors.list
Filtrar objetos: resource.type

Usa un filtro para limitar los descriptores de recursos supervisados que recuperas:

  • Para recuperar solo los descriptores de recursos supervisados de Pub/Sub, usa el siguiente filtro:

    resource.type = starts_with("pubsub")
    

Consulta la Lista de recursos supervisados para ver una lista completa de los tipos de recursos supervisados definidos por Monitoring.

Referencia: sintaxis del filtro

Para obtener una descripción general de los filtros con ejemplos, consulta Usa filtros.

Un filtro de supervisión es una string que consta de hasta cuatro tipos de selectores:

<monitoring_filter> ::=  <project_selector> AND <group_selector> AND <resource_selector> AND <metric_selector>

El filtro hace coincidir un elemento si todos los selectores incluidos coinciden con este. Como se describe en las siguientes secciones, algunos selectores pueden tener varias comparaciones unidas por AND o OR.

Según el propósito del filtro, algunos selectores pueden ser obligatorios, opcionales o prohibidos. Por ejemplo, el filtro que define los recursos en un grupo no puede contener un selector de métrica, porque los grupos no contienen tipos de métricas o series temporales. Por otro lado, el filtro que se usa para enumerar las series temporales debe contener un selector de métricas. El orden de los selectores en el filtro no es importante, pero las comparaciones para diferentes selectores no deben mezclarse.

Comparaciones

Los filtros y sus selectores se compilan a partir de las comparaciones. Cada comparación tiene la forma siguiente:

[OBJECT] [OPERATOR] [VALUE]

Estos elementos se describen a continuación:

  • [OBJECT]: selecciona un valor que se probará y puede ser una de las siguientes opciones:

    project
    group.id
    metric.type
    metric.labels.[KEY]
    resource.type
    resource.labels.[KEY]
    metadata.system_labels.[KEY]
    metadata.user_labels.[KEYSTRING]
    

    [KEY] es un nombre, como zone o instance_id. [KEYSTRING] puede ser un nombre, pero si contiene caracteres especiales, debe estar entre comillas (").

  • [OPERATOR]: un operador de comparación, uno de los siguientes:

    =            # equality (case-sensitive)
    > < >= <=    # numeric ordering
    !=           # not equal
    :            # "has" substring match and test for key (case-sensitive)
    
  • [VALUE]: es un valor literal o una llamada a una función incorporada y puede ser una de las siguientes opciones:

    <string>     # "a Unicode string". Don't use apostrophes (`'`) to quote strings.
    <bool>       # true or false
    <number>     # 0, -2, 123456, 3.14156
    <function>   # operators on the right side of '=' or '!=':
                 #   starts_with(<string>)
                 #   ends_with(<string>)
                 #   has_substring(<string> [, ignore_case=false])
                 #   one_of(<string>,...,<string>) for up to 100 strings
                 #   monitoring.regex.full_match(<RE2-string>)
    

    Excepto en el caso de timeSeries.list, el filtro has_substring toma un segundo argumento opcional, que especifica si la coincidencia ignora las mayúsculas o no. El valor predeterminado es false, por lo que la coincidencia predeterminada distingue entre mayúsculas y minúsculas:

    • Distingue entre mayúsculas y minúsculas: display_name=has_substring("Demo")
    • Distingue entre mayúsculas y minúsculas: display_name=has_substring("Demo", false)
    • No distingue entre mayúsculas y minúsculas: display_name=has_substring("Demo", true)

    Solo se admite el formato has_substring(<string>) para timeSeries.list.

    El filtro monitoring.regex.full_match toma una string de expresión regular en la sintaxis de RE2.

Puedes usar los siguientes operadores para agrupar o modificar las comparaciones. OR tiene mayor prioridad que AND. Los operadores se deben escribir en mayúsculas:

(...)        # grouping comparisons
AND          # conjunction (optional but recommended)
OR           # disjunction

El operador AND se puede omitir entre los operadores, pero incluirlo proporciona más claridad y una propensión menor a errores.

La comparación x = one_of("a", "b", "c") es equivalente a

(x = "a" OR x = "b" OR x = "c")

Solo en las definiciones de grupo, puedes usar el operador de negación unaria, NOT, antes de una comparación, pero no con un operador existente (:) o antes de una expresión entre paréntesis:

NOT          # negates the following comparison

Filtra selectores

Usa selectores para limitar las selecciones de filtros a ciertos elementos. En las siguientes secciones, se usan llaves para mostrar la repetición. Por ejemplo, la notación <x> {OR <y>} significa que puedes escribir cualquiera de las siguientes opciones:

<x>
<x> OR <y>
<x> OR <y> OR <y>
<x> OR <y> OR <y> OR <y>
...

Selector de proyectos

Un selector de proyectos limita la selección de filtros a los elementos que pertenecen a un solo proyecto o a cualquiera de un conjunto de proyectos. Cada proyecto se puede especificar por su ID o su número:

<project_selector> ::= project '=' (<number> | <string>) {OR project '=' (<number> | <string>)}

Si el selector de proyectos tiene más de una comparación, encierra el selector completo entre paréntesis para mejorar la legibilidad. Por ejemplo:

(project=12345 OR project="my-project-id") AND resource.type="gce_instance"

Selector de grupos

Un selector de grupos limita la selección de filtros a los elementos que pertenecen a un solo grupo:

<group_selector> ::= group.id '=' <string>

Por ejemplo, el siguiente filtro podría usarse para recuperar una serie temporal de cada una de las instancias de VM de un grupo:

group.id = 12345 AND
    resource.type = "gce_instance" AND
    metric.type = "compute.googleapis.com/instance/disk/read_bytes_count"

El selector de grupos solo se permite en los filtros que se pasan a projects.timeSeries.list. Además, la selección de grupos requiere datos alineados. Es decir, la llamada a projects.timeSeries.list debe incluir valores para perSeriesAligner y alignmentPeriod. Esto se debe a que la membresía del grupo es en sí misma un tipo de serie temporal que se debe unir con los datos de métricas, y el suministro de parámetros de alineación te permite controlar cómo se realiza esa unión. Si deseas obtener más información sobre los parámetros de alineación, consulta Agrega datos.

Selector de recursos

Un selector de recursos limita la selección de filtros a los recursos (o elementos asociados con los recursos) que tienen un tipo de recurso o valores de etiqueta en específico:

<resource_selector> ::= <resource_type_expression>
                      | <resource_label_expression>
                      | <resource_type_expression> AND <resource_label_expression>

<resource_type_expression> ::= resource.type '=' <string>
                             | resource.type ':' <string>
                             | resource.type '=' starts_with '(' <string>')'
                             | resource.type '=' ends_with '(' <string> ')'

<resource_label_expression> ::= <r_label_comparison> {AND <r_label_comparison>}
                              | <r_label_comparison> {OR <r_label_comparison>}

<r_label_comparison> ::= resource.labels.[KEY] '=' (<string> | <bool>)
                       | resource.labels.[KEY] ':' <string>
                       | resource.labels.[KEY] '=' (starts_with | ends_with) '(' <string> ')'
                       | resource.labels.[KEY] ('=' | '>' | '<' | '>=' | '<=') <number>

Si usas más de una <r_label_comparison> en tu selector, escríbelas entre paréntesis para mejorar la legibilidad. Por ejemplo, el siguiente filtro podría usarse para definir un grupo que incluya todas las instancias de VM en EE.UU. y Europa:

resource.type = "gce_instance" AND
  (resource.labels.zone = starts_with("us-") OR resource.labels.zone = starts_with("europe-"))

Selector de recursos para las definiciones de grupos

Los selectores de recursos que se usan a fin de definir la membresía del grupo usan extensiones para la sintaxis <resource_selector>:

  1. Puedes usar los nombres metadata.system_labels.[KEY] y metadata.user_labels.[KEYSTRING] en las comparaciones al igual que en resource.labels.[KEY]. Las claves para metadata.user_labels deben estar entre comillas porque pueden contener caracteres especiales como guiones.

  2. Puedes usar el operador de desigualdad (!=) para comparar los tipos de recursos, las etiquetas de recursos y los metadatos. El operador se puede usar cuando se comparan strings, números, valores booleanos o funciones de la substring. Por ejemplo, resource.type!=starts_with("gce") es verdadero si el tipo de recurso no comienza con "gce".

  3. Puedes usar un solo operador NOT antes de una comparación de recursos. Por ejemplo, NOT resource.labels.zone="europe" es verdadero si la zona del recurso no incluye "europe". No puedes usar NOT antes de que haya un operador (:) o una expresión entre paréntesis.

  4. Puedes usar el operador existente (:) para probar la existencia de las claves. Por ejemplo, la comparación resource.labels.zone es verdadera si la clave de la etiqueta zone está presente en el recurso.

Por ejemplo, una de las claves de metadatos del recurso de la plataforma para las instancias de VM es spot_instance. En el siguiente selector de filtros, se eligen instancias que son puntuales:

    resource.type = "gce_instance" AND metadata.system_labels.spot_instance = true

Selector de métricas

Un selector de métricas especifica ciertas métricas o descriptores de métricas mediante la limitación del tipo de métrica y las etiquetas de métricas. Cuando se enumeran los datos de series temporales, el selector de métricas debe especificar un solo tipo de métrica:

<metric_selector> ::= <metric_name_expression> [AND <metric_label_expression>]

<metric_name_expression> ::= metric.type '=' <string>
                           | metric.type ':' <string>
                           | metric.type '=' starts_with '(' <string> ')'
                           | metric.type '=' ends_with '(' <string> ')'

<metric_label_expression> ::= <metric_label_comparison> {[AND] <metric_label_comparison>}
                            | <metric_label_comparison> {OR <metric_label_comparison>}

<metric_label_comparison> ::= metric.labels.[KEY] '=' <string> | <bool>
                            | metric.labels.[KEY] ':' <string>
                            | metric.labels.[KEY] '=' starts_with '(' <string> ')'
                            | metric.labels.[KEY] '=' ends_with '(' <string> ')'
                            | metric.labels.[KEY] ('=' | '>' | '<' | '>=' | '<=') <number>

Por ejemplo, el siguiente filtro podría usarse para recuperar una serie temporal en una instancia específica de la base de datos:

metric.type = "cloudsql.googleapis.com/database/state" AND
  (metric.labels.resource_type = "instance" AND
   metric.labels.resource_id = "abc-123456")

Ejemplos

En los ejemplos de filtrado, usamos el descriptor de métricas, el descriptor de recursos supervisados y la instancia de máquina virtual que se encuentran a continuación, simplificados para fines ilustrativos:

# Metric descriptor:
{ "name": "projects/my-project-id/metricDescriptors/compute.googleapis.com%2Finstance%2Fdisk%2Fread_bytes_count"
  "type": "compute.googleapis.com/instance/disk/read_bytes_count",
  "labels": [ { "key": "device_name",
                "description": "The name of the disk device." } ] }

# Monitored resource descriptor:
{  "name": "monitoredResourceDescriptors/gce_instance"
   "type": "gce_instance",
   "labels": [
     { "key": "instance_id",
       "description": "The instance ID provide by Google Compute Engine." },
     { "key": "zone",
       "description": "The Google Cloud Platform zone hosting the instance."
     } ] }

# Resource descriptor for a virtual machine instance.
{ "type": "gce_instance",
  "instance_id": "1472038649266883453",
  "zone": "us-east-1b",
  "disks": [ "log_partition" ],
  "machine_type": "n1-standard-2",
  "tags": { "environment": "bleeding-edge",
            "role": "frobulator" },
  "project_id": "my-project-id" }

Ejemplos de recuperación de métricas

Para solicitar el uso del ancho de banda de lectura del disco de todas las instancias y los dispositivos, define un filtro como se muestra a continuación. Esto muestra, para cada instancia, una serie temporal separada que informa el ancho de banda de lectura de cada dispositivo:

metric.type = "compute.googleapis.com/instance/disk/read_bytes_count"

Si quieres definir mejor la solicitud para consultar el ancho de banda de lectura solo del dispositivo del disco conocido como “log_partition”, define el filtro en cada instancia como se muestra a continuación. Este filtro muestra, para cada instancia, como máximo una serie temporal, según si existe un dispositivo con ese nombre en esa instancia:

metric.type = "compute.googleapis.com/instance/disk/read_bytes_count" AND
metric.labels.device_name = "log_partition"

Para restringir la solicitud a una sola instancia, especifica esa instancia:

resource.type = "gce_instance" AND
resource.labels.instance_id = "1472038649266883453" AND
metric.type = "compute.googleapis.com/instance/disk/read_bytes_count" AND
metric.labels.device_name = "log_partition"

Filtra con grupos

En los siguientes ejemplos, se ilustra el uso del selector de grupos en los filtros para restringir los recursos supervisados a los de un grupo específico. Consulta Definiciones de grupos para obtener información sobre los selectores que se usan para definir la membresía del grupo.

{ "name": "projects/my-test-project/groups/024681012",
  "display_name": "My Redis Cluster",
  "filter": "metadata.user_labels.role=redis" }

En una llamada al método projects.timeSeries.list, el siguiente filtro solicita el uso del ancho de banda de lectura del disco para todas las instancias de Compute Engine en un grupo en particular. El grupo debe definirse en el proyecto de alcance de un permiso de métricas especificado en el parámetro name del método:

resource.type = "gce_instance" AND
group.id = "024681012" AND
metric.type = "compute.googleapis.com/instance/disk/read_bytes_count"