archived-doc-pt-br/reference/fpm/status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0ba9e74ebc71fc8aa5fcd0f5f48654a4a6a83368 Maintainer: leonardolara Status: ready -->
<!-- CREDITS: fernandowobeto,leonardolara -->
<sect1 xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="fpm.status">
 <title>Página de status</title>

 <simpara>
  Esta página fornece informações sobre a configuração e o conteúdo da página de status do FPM. Veja também
  <function>fpm_get_status</function>.
 </simpara>

 <sect2 xml:id="fpm.status.configuration">
  <title>Configuração</title>

  <simpara>
   A página de status do FPM pode ser habilitada definindo o parâmetro de configuração
   <link linkend="pm.status-path">pm.status_path</link> na configuração do pool
   FPM.
  </simpara>

  <caution>
   <simpara>
    Por segurança, a página de status do FPM deve ser restrita apenas a solicitações internas ou IPs
    de clientes conhecidos, pois a página revela URLs de solicitação e informações sobre os recursos disponíveis.
   </simpara>
  </caution>

  <simpara>
   Dependendo da configuração do servidor web, pode ser necessário configurá-lo para
   permitir solicitações diretamente para este caminho, ignorando quaisquer scripts PHP. Um exemplo de configuração
   para Apache com FPM escutando em UDS e <literal>pm.status_path</literal> definido como
   <literal>/fpm-status</literal> seria assim:
  </simpara>

  <informalexample>
   <programlisting role="apache-conf">
    <![CDATA[
<LocationMatch "/fpm-status">
 Order Allow,Deny
 Allow from 127.0.0.1
 ProxyPass "unix:/var/run/php-fpm.sock|fcgi://localhost/fpm-status"
</LocationMatch>
]]>
   </programlisting>
  </informalexample>

  <simpara>
   Após recarregar ou reiniciar o FPM e o servidor web, a página de status estará acessível a partir
   do navegador (desde que a solicitação venha de um endereço IP permitido se a restrição de IP tiver sido
   configurada).
  </simpara>
 </sect2>

 <sect2 xml:id="fpm.status.parameters">
  <title>Parâmetros de consulta</title>

  <simpara>
   O formato da saída da página de status pode ser alterado especificando um dos seguintes parâmetros
   de consulta:
  </simpara>

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

  <simpara>
   Informações adicionais também podem ser retornadas usando o parâmetro de consulta <literal>full</literal>.
  </simpara>

  <simpara>
   Exemplos de URLs de páginas de status:
  </simpara>

  <simplelist>
   <member>
    <literal>https://localhost/fpm-status</literal>
    - Breve saída no formato de texto padrão
   </member>
   <member>
    <literal>https://localhost/fpm-status?full</literal>
    - Saída completa no formato de texto padrão
   </member>
   <member>
    <literal>https://localhost/fpm-status?json</literal>
    - Breve saída em formato JSON
   </member>
   <member>
    <literal>https://localhost/fpm-status?html&amp;full</literal>
    - Saída completa em formato HTML
   </member>
  </simplelist>
 </sect2>

 <sect2 xml:id="fpm.status.contents">
  <title>Informações exibidas</title>

  <simpara>
   Os valores de data/hora usam o formato de timestamp Unix na saída JSON e XML; caso contrário, eles usam
   o formato que resulta no seguinte exemplo de data:
   <literal>"03/Jun/2021:07:21:46 +0100"</literal>.
  </simpara>

  <table>
   <title>Informações básicas - Sempre exibidas na página de status</title>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>Parâmetro</entry>
      <entry>Descrição</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>pool</entry>
      <entry>O nome do pool de processos FPM.</entry>
     </row>
     <row>
      <entry>proccess manager</entry>
      <entry>O tipo de gerenciador de processos - estático, dinâmico ou sob demanda.</entry>
     </row>
     <row>
      <entry>start time</entry>
      <entry>A data/hora em que o pool de processos foi iniciado pela última vez.</entry>
     </row>
     <row>
      <entry>start since</entry>
      <entry>O tempo em segundos desde que o pool de processos foi iniciado pela última vez.</entry>
     </row>
     <row>
      <entry>accepted conn</entry>
      <entry>O número total de conexões aceitas.</entry>
     </row>
     <row>
      <entry>listen queue</entry>
      <entry>O número de solicitações (backlog) aguardando atualmente por um processo livre.</entry>
     </row>
     <row>
      <entry>max listen queue</entry>
      <entry>O número máximo de solicitações vistas na fila de escuta a qualquer momento.</entry>
     </row>
     <row>
      <entry>listen queue len</entry>
      <entry>O tamanho máximo permitido da fila de escuta.</entry>
     </row>
     <row>
      <entry>idle processes</entry>
      <entry>O número de processos que estão atualmente ociosos (aguardando solicitações).</entry>
     </row>
     <row>
      <entry>active processes</entry>
      <entry>O número de processos que estão processando solicitações no momento.</entry>
     </row>
     <row>
      <entry>total processes</entry>
      <entry>O número total atual de processos.</entry>
     </row>
     <row>
      <entry>max active processes</entry>
      <entry>O número máximo de processos ativos simultaneamente.</entry>
     </row>
     <row>
      <entry>max children reached</entry>
      <entry>
       O número máximo de processos já foi atingido? Nesse caso, o valor exibido é maior ou igual a
       <literal>1</literal> caso contrário, o valor é <literal>0</literal>.
      </entry>
     </row>
     <row>
      <entry>slow requests</entry>
      <entry>
       O número total de solicitações que atingiram o
       <literal>request_slowlog_timeout</literal> configurado.
      </entry>
     </row>
     <row>
      <entry>memory peak</entry>
      <entry>
       O pico de uso de memória desde a inicialização do FPM.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </table>

  <table>
   <title>Informações por processo - exibidas apenas no modo de saída <literal>full</literal></title>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>Parâmetro</entry>
      <entry>Descrição</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>pid</entry>
      <entry>O PID de sistema do processo.</entry>
     </row>
     <row>
      <entry>state</entry>
      <entry>O estado do processo - Inativo, Em execução, ...</entry>
     </row>
     <row>
      <entry>start time</entry>
      <entry>A data/hora em que o processo foi iniciado.</entry>
     </row>
     <row>
      <entry>start since</entry>
      <entry>O número de segundos desde que o processo foi iniciado.</entry>
     </row>
     <row>
      <entry>requests</entry>
      <entry>O número total de solicitações atendidas.</entry>
     </row>
     <row>
      <entry>request duration</entry>
      <entry>O tempo total em microssegundos gasto atendendo à última solicitação.</entry>
     </row>
     <row>
      <entry>request method</entry>
      <entry>O método HTTP da última solicitação atendida.</entry>
     </row>
     <row>
      <entry>request uri</entry>
      <entry>
       O URI da última solicitação atendida (após o processamento do servidor web, pode sempre ser
       <literal>/index.php</literal> se for usado um modelo de redirecionamento central).
      </entry>
     </row>
     <row>
      <entry>content length</entry>
      <entry>O comprimento do corpo da solicitação, em bytes, da última solicitação.</entry>
     </row>
     <row>
      <entry>user</entry>
      <entry>O usuário HTTP (<literal>PHP_AUTH_USER</literal>) da última solicitação.</entry>
     </row>
     <row>
      <entry>script</entry>
      <entry>
       O caminho completo do script executado pela última solicitação. Será
       <literal>'-'</literal> se não for aplicável (por exemplo, solicitações de página de status).
      </entry>
     </row>
     <row>
      <entry>last request cpu</entry>
      <entry>
       A %cpu da última solicitação. Será 0 se o processo não estiver ocioso porque o
       cálculo é feito quando o processamento da solicitação é concluído.
       O valor pode exceder 100%, porque a métrica dirá qual porcentagem do tempo total da CPU foi usada na última solicitação -
       leva em consideração os processos em todos os núcleos, enquanto 100% é para apenas um núcleo.
      </entry>
     </row>
     <row>
      <entry>last request memory</entry>
      <entry>
       A quantidade máxima de memória consumida pela última solicitação. Será 0 se o processo não
       estiver ocioso porque o cálculo é feito quando o processamento da solicitação é concluído.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </table>

  <note>
   <simpara>
    Todos os valores são específicos do pool e são redefinidos quando o FPM é reiniciado.
   </simpara>
  </note>

  <note>
   <simpara>
    A saída do formato OpenMetrics usa diferentes tipos de parâmetros para melhor se adequar ao formato OpenMetrics.
    Os parâmetros e as descrições de seus valores estão incluídos na saída do 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>O formato openmetrics foi adicionado.</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
 -->