FPM Status Page (#1420)

* Documentation for the FPM status page and fpm_get_status()

* FPM status page: Update date/time format documentation

* FPM status page: Add information on openmetrics format (PHP 8.1+)

* Fix fpm_get_status referencing file name

* Update FPM status page documentation

* Move FPM status configuration to section

* Improve FPM Status Page formatting and move it under Observability

* Improve FPM status CS

Co-authored-by: AllenJB <[email protected]>

Author: bukka

install/fpm/configuration.xml

@@ -487,8 +487,9 @@
       </term>
       <listitem>
        <para>
-        The URI to view the FPM status page. If this value is not set, no URI
-        will be recognized as a status page. Default value: none.
+        The URI to view the <link linkend="fpm.status">FPM status page</link>. This value must
+        start with a leading slash (/). If this value is not set, no URI will be recognized as
+        a status page. Default value: none.
        </para>
       </listitem>
      </varlistentry>

reference/fpm/book.xml

@@ -14,6 +14,7 @@
  </preface>
 
  &reference.fpm.setup;
+ &reference.fpm.observability;
  &reference.fpm.reference;
 
 </book>

reference/fpm/functions/fpm-get-status.xml

@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.fpm-get-status" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>fpm_get_status</refname>
+  <refpurpose>Returns the current FPM pool status</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>array</type><methodname>fpm_get_status</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   This function returns the full current FPM pool status as an associative array. It always
+   returns the full status, including per-process status information. See the
+   <link linkend="fpm.status">FPM status page guide</link> for further
+   details.
+  </para>
+  <para>
+   Note that this function will only be defined if FPM is being used to serve the script.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Associative array containing the full FPM pool status.
+  </para>
+ </refsect1>
+</refentry>
+
+ <!-- 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
+ -->

reference/fpm/observability.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<chapter xml:id="fpm.observability">
+ <title>Observability</title>
+
+ &reference.fpm.status;
+  
+</chapter>
+
+ <!-- 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
+ -->