Crea métricas a partir de registros

En esta página, se describe cómo generar métricas nuevas a partir de registros existentes implementando un recurso personalizado LoggingRule en Google Distributed Cloud (GDC) aislado.

Las reglas de registro te permiten precalcular expresiones que se usan con frecuencia o que son costosas desde el punto de vista computacional, lo que mejora el rendimiento de los paneles y las alertas. Definidas dentro de los recursos personalizados de LoggingRule, estas reglas generan nuevas métricas de series temporales a partir de los registros existentes, lo que mejora la observabilidad de los datos.

Al almacenar resultados precalculados, las reglas de registro eliminan los cálculos redundantes cada vez que se necesita una expresión. Este método acelera significativamente los tiempos de consulta, en especial para los paneles y las alertas complejos que requieren evaluaciones repetidas de la misma expresión. Básicamente, los recursos LoggingRule te permiten derivar métricas nuevas a partir de los datos de registro existentes especificando los cálculos necesarios dentro de sus reglas de registro.

Antes de comenzar

Para obtener los permisos que necesitas para administrar recursos personalizados de LoggingRule, pídele al administrador de IAM de la organización o al administrador de IAM del proyecto que te otorgue uno de los roles de LoggingRule asociados.

Según el nivel de acceso y los permisos que necesites, es posible que obtengas roles de creador, editor o visualizador para este recurso en una organización o un proyecto. Para obtener más información, consulta Prepara los permisos de IAM.

Cómo crear reglas de grabación

Para crear una regla de registro, define un nombre para el registro grabado y una expresión válida que produzca un valor numérico. Esta expresión, cuando se evalúa, genera la nueva métrica. Implementa el recurso personalizado LoggingRule en el espacio de nombres de tu proyecto en el servidor de la API de Management para activar la regla de grabación.

Para obtener más información sobre las reglas de grabación, consulta https://grafana.com/docs/loki/latest/rules/.

Sigue estos pasos para crear reglas de grabación en el espacio de nombres de tu proyecto:

  1. Determina el proyecto de GDC desde el que deseas crear reglas de grabación.

  2. Crea un archivo YAML que defina el recurso personalizado LoggingRule.

    La especificación completa de LoggingRule muestra un ejemplo de reglas de grabación basadas en registros. Para obtener más información, consulta la documentación de referencia de la API.

  3. Reemplaza los siguientes valores en el archivo YAML según tus necesidades:

    Nombre del campo Descripción
    namespace Es el espacio de nombres del proyecto.
    name Es el nombre de la configuración de la regla.
    source Es la fuente de registro de la regla de grabación. Las opciones válidas son operational y audit.
    interval Es la duración del intervalo de evaluación de la regla en segundos.
    limit Opcional. Es la cantidad máxima de alertas. Establécelo en 0 para recibir alertas ilimitadas.
    recordRules Son las definiciones para calcular métricas nuevas.
    recordRules.record Es el nombre del registro de la métrica nueva. El valor debe ser un nombre de métrica válido que defina la serie temporal en la que se almacenan los resultados.
    recordRules.expr Es una expresión LogQL para la regla de registro, que debe evaluarse como un valor numérico.
    recordRules.labels Opcional. Son los pares clave-valor de las etiquetas que se agregarán a la métrica nueva o que la reemplazarán.

  4. Guarda el archivo YAML.

  5. Aplica la configuración de LoggingRule al servidor de la API de Management dentro del mismo espacio de nombres que tus reglas de grabación:

    kubectl --kubeconfig KUBECONFIG_PATH apply -f LOGGING_RULE_NAME.yaml

    Reemplaza lo siguiente:

    • KUBECONFIG_PATH: Es la ruta al archivo kubeconfig del servidor de la API de administración.
    • LOGGING_RULE_NAME: Es el nombre del archivo de definición de LoggingRule.

Especificación de LoggingRule completa

Un recurso personalizado LoggingRule contiene reglas de grabación que describen las condiciones para crear métricas nuevas basadas en registros existentes para la observabilidad.

En el siguiente archivo YAML, se muestra una plantilla para el recurso personalizado LoggingRule. Para obtener más información, consulta la documentación de referencia de la API.

# Configures either an alert or a target record for precomputation.
apiVersion: logging.gdc.goog/v1
kind: LoggingRule
metadata:
  # Choose a namespace that matches the project namespace.
  # The alert or record is produced in the same namespace.
  namespace: PROJECT_NAMESPACE
  name: LOGGING_RULE_NAME
spec:
  # Choose the log source to base alerts on (operational or audit logs).
  # Optional.
  # Valid options: 'operational' and 'audit'
  # Default value: 'operational'
  source: operational

  # Rule evaluation interval.
  interval: 60s

  # Configure the limit for the number of alerts.
  # A value of '0' means no limit.
  # Optional.
  # Default value: '0'
  limit: 0

  # Configure recording rules to generate new metrics based on existing logs.
  # Recording rules precompute expressions that are frequently needed or computationally expensive.
  # Results are saved as a new set of time series.
  recordRules:
    # Define the time series where you want to write the recording rule.
    # The value must be a valid metric name.
  - record: MyMetricsName

    # Define the LogQL expression to evaluate for this rule.
    expr: rate({service_name="bob-service"} [1m])

    # Define labels to add or overwrite.
    # Map of key-value pairs.
    # Optional.
    labels:
      verb: read

Reemplaza lo siguiente:

  • PROJECT_NAMESPACE: Es el espacio de nombres de tu proyecto.
  • LOGGING_RULE_NAME: Es el nombre del archivo de definición de LoggingRule.