archived-doc-es/reference/fpm/status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: fa98755da49828e6a37049bdaf7bd16aa8adf879 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<sect1 xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="fpm.status">
 <title>Página de estado</title>

 <simpara>
  Esta página proporciona información sobre la configuración y el contenido de la página de estado de FPM. Ver también
  <function>fpm_get_status</function>.
 </simpara>

 <sect2 xml:id="fpm.status.configuration">
  <title>Configuración</title>

  <simpara>
   La página de estado de FPM puede activarse definiendo el parámetro
   <link linkend="pm.status-path">pm.status_path</link>
   en la configuración del grupo de FPM.
  </simpara>

  <caution>
   <simpara>
    Por razones de seguridad, la página de estado de FPM debería limitarse a las peticiones internas o a las direcciones IP de clientes conocidas, ya que la página revela las URLs de las peticiones y la información sobre los recursos disponibles.
   </simpara>
  </caution>

  <simpara>
   Según la configuración del servidor web, puede ser necesario configurar el servidor web para
   permitir las peticiones directamente a esta ruta, omitiendo los scripts PHP. Un ejemplo de configuración
   para Apache con FPM escuchando en UDS y <literal>pm.status_path</literal> establecido en
   <literal>/fpm-status</literal>:
  </simpara>

  <informalexample>
   <programlisting role="apache-conf">
    <![CDATA[
<LocationMatch "/fpm-status">
 Require local
 ProxyPass "unix:/var/run/php-fpm.sock|fcgi://localhost/"
</LocationMatch>
]]>
   </programlisting>
  </informalexample>

  <simpara>
   Tras el recarga o reinicio de FPM y del servidor web, la página de estado estará accesible desde
   el navegador (siempre que la petición provenga de una dirección IP autorizada si se ha configurado la restricción de IP).
  </simpara>
 </sect2>

 <sect2 xml:id="fpm.status.parameters">
  <title>Parámetros de la petición</title>

  <simpara>
   El formato de la página de estado puede modificarse especificando uno de los siguientes parámetros de petición:
  </simpara>

  <simplelist>
   <member><literal>html</literal></member>
   <member><literal>json</literal></member>
   <member><literal>openmetrics</literal></member>
   <member><literal>xml</literal></member>
  </simplelist>

  <simpara>
   Información adicional también puede devolverse utilizando el parámetro de petición <literal>full</literal>.
  </simpara>

  <simpara>
   Ejemplo de URL de página de estado:
  </simpara>

  <simplelist>
   <member>
    <literal>https://localhost/fpm-status</literal>
    - Salida breve en el formato de texto por defecto
   </member>
   <member>
    <literal>https://localhost/fpm-status?full</literal>
    - Resultados completos en el formato de texto por defecto
   </member>
   <member>
    <literal>https://localhost/fpm-status?json</literal>
    - Resultado conciso en formato JSON
   </member>
   <member>
    <literal>https://localhost/fpm-status?html&amp;full</literal>
    - Resultados completos en formato HTML
   </member>
  </simplelist>
 </sect2>

 <sect2 xml:id="fpm.status.contents">
  <title>Información mostrada</title>

  <simpara>
   Los valores de fecha y hora utilizan el formato de marca de tiempo Unix en las salidas JSON y XML,
   de lo contrario utilizan el formato resultante del siguiente ejemplo
   <literal>"03/Jun/2021:07:21:46 +0100"</literal>.
  </simpara>

  <table>
   <title>Información básica - Siempre mostrada en la página de estado</title>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>Parámetro</entry>
      <entry>Descripción</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>pool</entry>
      <entry>El nombre del grupo de procesos FPM.</entry>
     </row>
     <row>
      <entry>proccess manager</entry>
      <entry>El tipo de gestor de procesos - estático, dinámico o bajo demanda.</entry>
     </row>
     <row>
      <entry>start time</entry>
      <entry>Fecha y hora del último inicio del grupo de procesos.</entry>
     </row>
     <row>
      <entry>start since</entry>
      <entry>Tiempo en segundos transcurrido desde el último inicio del grupo de procesos.</entry>
     </row>
     <row>
      <entry>accepted conn</entry>
      <entry>Número total de conexiones aceptadas.</entry>
     </row>
     <row>
      <entry>listen queue</entry>
      <entry>Número de peticiones (backlog) en espera de un proceso libre.</entry>
     </row>
     <row>
      <entry>max listen queue</entry>
      <entry>El número máximo de peticiones vistas en la cola en un momento dado.</entry>
     </row>
     <row>
      <entry>listen queue len</entry>
      <entry>Tamaño máximo permitido de la cola.</entry>
     </row>
     <row>
      <entry>idle processes</entry>
      <entry>Número de procesos actualmente inactivos (en espera de peticiones).</entry>
     </row>
     <row>
      <entry>active processes</entry>
      <entry>Número de procesos que actualmente están procesando peticiones.</entry>
     </row>
     <row>
      <entry>total processes</entry>
      <entry>Número total de procesos en curso.</entry>
     </row>
     <row>
      <entry>max active processes</entry>
      <entry>Número máximo de procesos activos simultáneamente.</entry>
     </row>
     <row>
      <entry>max children reached</entry>
      <entry>
       ¿Se ha alcanzado ya el número máximo de procesos? Si es así, el valor mostrado es
       mayor o igual a <literal>1</literal>, de lo contrario el valor mostrado es <literal>0</literal>.
      </entry>
     </row>
     <row>
      <entry>slow requests</entry>
      <entry>
       El número total de peticiones que han alcanzado el tiempo de espera configurado de
       <literal>request_slowlog_timeout</literal>.
      </entry>
     </row>
     <row>
      <entry>memory peak</entry>
      <entry>
       El pico de uso de memoria desde el inicio de FPM.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </table>

  <table>
   <title>Información por proceso - mostrada únicamente en modo de salida completa (<literal>full</literal>)</title>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>Parámetro</entry>
      <entry>Descripción</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>pid</entry>
      <entry>El PID del sistema del proceso.</entry>
     </row>
     <row>
      <entry>state</entry>
      <entry>El estado del proceso - Idle, Running, ...</entry>
     </row>
     <row>
      <entry>start time</entry>
      <entry>La fecha/hora en que el proceso comenzó.</entry>
     </row>
     <row>
      <entry>start since</entry>
      <entry>El número de segundos transcurridos desde el inicio del proceso.</entry>
     </row>
     <row>
      <entry>requests</entry>
      <entry>El número total de peticiones servidas.</entry>
     </row>
     <row>
      <entry>request duration</entry>
      <entry>El tiempo total en microsegundos pasados procesando peticiones.</entry>
     </row>
     <row>
      <entry>request method</entry>
      <entry>El método HTTP de la última petición servida.</entry>
     </row>
     <row>
      <entry>request uri</entry>
      <entry>
       La URI de la última petición servida (tras el procesamiento por el servidor web, puede seguir siendo
       <literal>/index.php</literal> si se utiliza un patrón de redirección del controlador frontal).
      </entry>
     </row>
     <row>
      <entry>content length</entry>
      <entry>La longitud del cuerpo de la petición, en bytes, de la última petición.</entry>
     </row>
     <row>
      <entry>user</entry>
      <entry>El usuario HTTP (<literal>PHP_AUTH_USER</literal>) de la última petición.</entry>
     </row>
     <row>
      <entry>script</entry>
      <entry>
       La ruta completa del script ejecutado por la última petición. Será
       <literal>'-'</literal> si no es aplicable (por ejemplo, las peticiones de la página de estado).
      </entry>
     </row>
     <row>
      <entry>last request cpu</entry>
      <entry>
       El %cpu de la última petición. Será 0 si el proceso no está en reposo ya que el
       cálculo se realiza cuando el procesamiento de la petición ha finalizado.
       El valor puede superar el 100%, ya que el indicador mostrará el porcentaje total del tiempo de CPU utilizado en la última petición -
       tiene en cuenta los procesos en todos los núcleos, mientras que el 100% es para un solo núcleo.
      </entry>
     </row>
     <row>
      <entry>last request memory</entry>
      <entry>
       La cantidad máxima de memoria consumida por la última petición. Este valor será 0 si el proceso
       no está en reposo, ya que el cálculo se realiza cuando el procesamiento de la petición ha finalizado.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </table>

  <note>
   <simpara>
    Todos los valores son específicos del grupo y se reinician cuando se reinicia FPM.
   </simpara>
  </note>

  <note>
   <simpara>
    El formato de salida OpenMetrics utiliza diferentes tipos de parámetros para adaptarse mejor al formato OpenMetrics.
    Los parámetros y las descripciones de sus valores están incluidos en la salida del formato OpenMetrics.
   </simpara>
  </note>
 </sect2>

 <sect2 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>Se añadió el formato openmetrics.</entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </sect2>
</sect1>
<!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
 sgml-omittag:t
 sgml-shorttag:t
 sgml-minimize-attributes:nil
 sgml-always-quote-attributes:t
 sgml-indent-step:1
 sgml-indent-data:t
 indent-tabs-mode:nil
 sgml-parent-document:nil
 sgml-default-dtd-file:"~/.phpdoc/manual.ced"
 sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
 -->