Deploying to gh-pages from @ 00345be 🚀

main/book/deployment/admin.html

@@ -234,7 +234,11 @@ <h4 id="heap-allocation-metrics"><a class="header" href="#heap-allocation-metric
 </li>
 <li>
 <p><code>quilkin_extant_allocation_count</code> (Gauge)</p>
-<p>The current number of extant allocations"</p>
+<p>The current number of extant allocations</p>
+</li>
+<li>
+<p><code>quilkin_shutdown_initiated</code></p>
+<p>Shutdown process has been started</p>
 </li>
 </ul>
 <h3 id="debugpprofprofile"><a class="header" href="#debugpprofprofile">/debug/pprof/profile</a></h3>

main/book/installation.html

@@ -162,7 +162,7 @@ <h3 id="oci-image"><a class="header" href="#oci-image"><a href="https://us-docke
 <dl>
   <dt><strong>Source / Method</strong></dt>
   <dd>
-<pre><code>us-docker.pkg.dev/quilkin/release/quilkin:0.10.0-dev-e2019ba
+<pre><code>us-docker.pkg.dev/quilkin/release/quilkin:0.10.0-dev-00345be
 </code></pre>
   </dd>
   <dt><strong>Notes</strong></dt>

main/book/print.html

@@ -230,7 +230,7 @@ <h3 id="oci-image"><a class="header" href="#oci-image"><a href="https://us-docke
 <dl>
   <dt><strong>Source / Method</strong></dt>
   <dd>
-<pre><code>us-docker.pkg.dev/quilkin/release/quilkin:0.10.0-dev-e2019ba
+<pre><code>us-docker.pkg.dev/quilkin/release/quilkin:0.10.0-dev-00345be
 </code></pre>
   </dd>
   <dt><strong>Notes</strong></dt>
@@ -2239,6 +2239,21 @@ <h3 id="api-and-schema"><a class="header" href="#api-and-schema">API And Schema<
 request to the QCMP port.</p>
 <p>The returned data is a JSON object with each key being the ICAO code for the
 datacentre, and the value being the latency in nanoseconds.</p>
+<h2 id="metrics-4"><a class="header" href="#metrics-4">Metrics</a></h2>
+<ul>
+<li>
+<p><code>quilkin_phoenix_requests</code></p>
+<p>The amount of phoenix (latency) requests</p>
+</li>
+<li>
+<p><code>quilkin_phoenix_task_closed</code></p>
+<p>Whether the phoenix latency measurement task has shutdown</p>
+</li>
+<li>
+<p><code>quilkin_phoenix_server_errors</code></p>
+<p>The amount of errors attempting to spawn the phoenix HTTP server</p>
+</li>
+</ul>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="proxy-metrics"><a class="header" href="#proxy-metrics">Proxy Metrics</a></h1>
 <p>The following are metrics that Quilkin provides while in Proxy Mode.</p>
 <h1 id="asn-maxmind-information"><a class="header" href="#asn-maxmind-information">ASN Maxmind Information</a></h1>
@@ -2296,7 +2311,7 @@ <h2 id="general-metrics"><a class="header" href="#general-metrics">General Metri
 </li>
 <li>
 <p><code>quilkin_bytes_total{event, asn, ip_prefix}</code></p>
-<p>The total number of bytes sent or recieved</p>
+<p>The total number of bytes sent or received</p>
 <ul>
 <li>The <code>event</code> label is either:
 <ul>
@@ -2326,6 +2341,14 @@ <h2 id="general-metrics"><a class="header" href="#general-metrics">General Metri
 <p><code>quilkin_errors_total{event, asn, ip_prefix}</code></p>
 <p>The total number of errors encountered while reading a packet from the upstream endpoint.</p>
 </li>
+<li>
+<p><code>quilkin_game_traffic_tasks</code></p>
+<p>The amount of game traffic tasks that have spawned</p>
+</li>
+<li>
+<p><code>quilkin_game_traffic_task_closed</code></p>
+<p>The amount of game traffic tasks that have shutdown</p>
+</li>
 </ul>
 <h2 id="session-metrics"><a class="header" href="#session-metrics">Session Metrics</a></h2>
 <p>The proxy exposes the following metrics around sessions:</p>
@@ -3352,7 +3375,7 @@ <h4 id="proxy-mode-1"><a class="header" href="#proxy-mode-1">Proxy Mode</a></h4>
 until they are fully populated.</p>
 <h4 id="xds-provider-mode-1"><a class="header" href="#xds-provider-mode-1">xDS Provider Mode</a></h4>
 <p>Will return an HTTP status of 200 when all health checks pass.</p>
-<h3 id="metrics-4"><a class="header" href="#metrics-4">/metrics</a></h3>
+<h3 id="metrics-5"><a class="header" href="#metrics-5">/metrics</a></h3>
 <p>Outputs <a href="https://prometheus.io/">Prometheus</a> formatted metrics for this instance.</p>
 <p>See the <a href="deployment/../services/proxy/metrics.html">Proxy Metrics</a> documentation for what proxy metrics are available.</p>
 <p>See the <a href="deployment/../services/xds/metrics.html">xDS Metrics</a> documentation for what xDS metrics are available.</p>
@@ -3373,7 +3396,11 @@ <h4 id="heap-allocation-metrics"><a class="header" href="#heap-allocation-metric
 </li>
 <li>
 <p><code>quilkin_extant_allocation_count</code> (Gauge)</p>
-<p>The current number of extant allocations"</p>
+<p>The current number of extant allocations</p>
+</li>
+<li>
+<p><code>quilkin_shutdown_initiated</code></p>
+<p>Shutdown process has been started</p>
 </li>
 </ul>
 <h3 id="debugpprofprofile"><a class="header" href="#debugpprofprofile">/debug/pprof/profile</a></h3>

main/book/services/proxy/metrics.html

@@ -209,7 +209,7 @@ <h2 id="general-metrics"><a class="header" href="#general-metrics">General Metri
 </li>
 <li>
 <p><code>quilkin_bytes_total{event, asn, ip_prefix}</code></p>
-<p>The total number of bytes sent or recieved</p>
+<p>The total number of bytes sent or received</p>
 <ul>
 <li>The <code>event</code> label is either:
 <ul>
@@ -239,6 +239,14 @@ <h2 id="general-metrics"><a class="header" href="#general-metrics">General Metri
 <p><code>quilkin_errors_total{event, asn, ip_prefix}</code></p>
 <p>The total number of errors encountered while reading a packet from the upstream endpoint.</p>
 </li>
+<li>
+<p><code>quilkin_game_traffic_tasks</code></p>
+<p>The amount of game traffic tasks that have spawned</p>
+</li>
+<li>
+<p><code>quilkin_game_traffic_task_closed</code></p>
+<p>The amount of game traffic tasks that have shutdown</p>
+</li>
 </ul>
 <h2 id="session-metrics"><a class="header" href="#session-metrics">Session Metrics</a></h2>
 <p>The proxy exposes the following metrics around sessions:</p>

main/book/services/proxy/qcmp.html

@@ -244,6 +244,21 @@ <h3 id="api-and-schema"><a class="header" href="#api-and-schema">API And Schema<
 request to the QCMP port.</p>
 <p>The returned data is a JSON object with each key being the ICAO code for the
 datacentre, and the value being the latency in nanoseconds.</p>
+<h2 id="metrics"><a class="header" href="#metrics">Metrics</a></h2>
+<ul>
+<li>
+<p><code>quilkin_phoenix_requests</code></p>
+<p>The amount of phoenix (latency) requests</p>
+</li>
+<li>
+<p><code>quilkin_phoenix_task_closed</code></p>
+<p>Whether the phoenix latency measurement task has shutdown</p>
+</li>
+<li>
+<p><code>quilkin_phoenix_server_errors</code></p>
+<p>The amount of errors attempting to spawn the phoenix HTTP server</p>
+</li>
+</ul>
 
                     </main>