bouncer/doc/fr/references/layers/queue.md
William Petit c8fc143efa
All checks were successful
Cadoles/bouncer/pipeline/head This commit looks good
doc: add prometheus metrics documentation
2024-02-21 12:29:03 +01:00

1.8 KiB

Layer "Queue"

Description

Ce layer permet d'ajouter un mécanisme de file d'attente dynamique au proxy associé.

Type

queue

Options

capacity

  • Type: number
  • Valeur par défaut: 1000
  • Description: Capacité maximum de la file d'attente.

keepAlive

  • Type: string (Voir time.ParseDuration() pour plus d'informations sur le format)
  • Valeur par défaut: 1m
  • Description: Durée de vie d'une session dans la file d'attente sans activité avant expiration.

matchURLs

  • Type: []string

  • Valeur par défaut: ["*"]

  • Description: Limiter l'action de la file d'attente à cette liste de patrons d'URLs.

    Par exemple, si vous souhaitez limiter votre file à l'ensemble d'une section "/blog" d'un site, vous pouvez déclarer la valeur ["*/blog*"]. Les autres URLs du site ne seront pas affectées par cette file d'attente.

Schéma

Voir le schéma JSON.

Métriques

Les métriques Prometheus suivantes sont exposées par ce layer.

bouncer_layer_queue_capacity{layer=<layerName>,proxy=<proxyName>}

  • Type: gauge

  • Description: Capacité maximale de la queue

  • Exemple

    # HELP bouncer_layer_queue_capacity Bouncer's queue layer capacity
    # TYPE bouncer_layer_queue_capacity gauge
    bouncer_layer_queue_capacity{layer="queue",proxy="cadoles"} 2
    

bouncer_layer_queue_sessions{layer=<layerName>,proxy=<proxyName>}

  • Type: gauge

  • Description: Nombre courant de sessions ouvertes

  • Exemple

    # HELP bouncer_layer_queue_sessions Bouncer's queue layer current sessions
    # TYPE bouncer_layer_queue_sessions gauge
    bouncer_layer_queue_sessions{layer="queue",proxy="cadoles"} 3