php / php/php-src

Support fastcgi parameter in FPM for status page to display request meta data

Ouverte
#8,880 3 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Feature SAPI: fpm
Langage dominant
C
Étoiles
40.4k
Forks
8.2k
Merge moyen
2 j 13 h
PR mergées (30 j)
96

Description

Description

The full FPM status page has very little request data to pinpoint actual running requests and see what's running to get some indication of pool health issues.

It starts with the request uri that actually just shows the request from php, but not the original request - i.e. with a typical front controller pattern it's just something like /front.php. There is already a bug report for that: https://bugs.php.net/bug.php?id=72319 , but I'd suggest that it could stay the same if the real request uri could be added as meta data.

In addition to data a fastcgi param could also be used for different meta data like a client up, nginx request id, etc. It's content and meaning would be in total control of the one using it. FPM itself wouldn't need to do more than showing it in the full status page.

A concrete usage would look like this in a nginx config (param name just for presentation purpose):
fastcgi_param FPM_STATUS_REQUEST_METADATA "$remote_addr $request_id $request_uri";
which would result in an output like that:

[...]
************************
pid:                  1234
state:                Running
start time:           27/Jun/2022:00:00:00 +0000
start since:          0
requests:             1
request duration:     10
request method:       GET
request URI:          /front.php
content length:       100
user:                 -
script:               /httpdocs/front.php
last request cpu:     0.00
last request memory:  0
request metadata: 127.0.0.1 A1B2D3E4F5 /hello/world
************************
[...]

Note: Of course a workaround is sending this as get parameters, but that's not pretty and can break scripts assuming a specific format of the query string or not seeing unknown get parameters.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par retracer la manière dont FPM analyse les paramètres FastCGI et assemble la sortie complète de la page d’état. Utilisez l’exemple nginx fastcgi_param demandé et l’exemple de sortie de l’état comme référence comportementale. C’est terminé lorsque les métadonnées de la requête acceptée sont affichées pour la requête en cours concernée, sans modifier les champs de requête existants.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
c, nginx, php
Domaine
backend, observability
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.