PIXILAB Wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
blocks:server:advanced_server_configuration:metrics [2026-01-12 13:08] – Added thalamus metrics adminblocks:server:advanced_server_configuration:metrics [2026-03-03 06:50] (current) – [Metrics] admin
Line 5: Line 5:
 Most of the details provided by these metrics are internal, and of little or no value to anyone but PIXILAB. So in general you should not configure metrics unless instructed and then provide the resulting log to PIXILAB for further analysis. Most of the details provided by these metrics are internal, and of little or no value to anyone but PIXILAB. So in general you should not configure metrics unless instructed and then provide the resulting log to PIXILAB for further analysis.
  
-To enable metrics, add the following to Blocks' configuration file:+To enable metrics, add the following to Blocks' [[blocks:server_configuration_file|configuration file]]:
  
 <code> <code>
 metrics:  metrics: 
- frequency: 1 minute +  frequency: 1 minute 
- reporters: +  reporters: 
-   - type: log +    - type: log 
-     logger: metrics +      logger: metrics 
-     includes: +      includes: 
-       - "io.dropwizard.jetty.MutableServletContextHandler.get-requests" +        - "io.dropwizard.jetty.MutableServletContextHandler.get-requests" 
-       - "io.dropwizard.jetty.MutableServletContextHandler.post-requests" +        - org.eclipse.jetty.util.thread.QueuedThreadPool.dw.jobs 
-       - org.eclipse.jetty.util.thread.QueuedThreadPool.dw.jobs +        - jvm.memory.total.used 
-       - jvm.memory.total.used +        - jvm.memory.heap.max 
-       - pixi.cortex.backlog.now +        - jvm.memory.heap.usage 
-       - pixi.cortex.backlog.peak +        - pixi.cortex.backlog.now 
-       - pixi.cortex.synapse +        - pixi.cortex.backlog.peak 
-       - pixi.cortex.receptors +        - pixi.cortex.synapse 
-       - pixi.cortex.thalamus.properties +        - pixi.cortex.receptors 
-       - pixi.cortex.thalamus.streams +        - pixi.cortex.thalamus.properties 
-       - pixi.cortex.sharedSingleExecutorQueue +        - pixi.cortex.thalamus.streams 
-       - pixi.cortex.sharedMultiExecutorQueue +        - pixi.cortex.sharedSingleExecutorQueue 
-       - pixi.cortex.MobileSpot.connected.Mob1+        - pixi.cortex.sharedMultiExecutorQueue 
 +        - pixi.cortex.MobileSpot.connected.Mob1 #See below for Visitor spot logging
 </code> </code>
  
-Furthermore, you must enable the metrics logger under logging in the config file:+:!: **NOTE**: The example above logs connections to a Visitor spot named "Mob1". If you have multiple Visitor spots, or if your Visitor spot (if any), is named differently, replace "Mob1" above with the full dot-separated path to your Visitor spot, or list multiple Visitor spots as needed. 
 +  
 +Furthermore, you must also enable the //metrics// logger under //loggers// in the config file. If you already have a //logging// section in your configuration file, merely add the //metrics// line under //loggers// as shown below, and make sure to indent the //metrics// line as shown, using spaces only – not tabs.
  
 <code> <code>
 logging: logging:
- level: WARN +  level: WARN 
- loggers: +  loggers: 
-   metrics: INFO   # To actually log metrics data+    metrics: INFO   # To actually log metrics data
 </code> </code>
  
Line 47: Line 50:
   * **pixi.cortex.sharedSingleExecutorQueue** Tasks waiting for the sharedSingleExecutor   * **pixi.cortex.sharedSingleExecutorQueue** Tasks waiting for the sharedSingleExecutor
   * **pixi.cortex.sharedMultiExecutorQueue** Tasks waiting for the sharedMultiExecutor   * **pixi.cortex.sharedMultiExecutorQueue** Tasks waiting for the sharedMultiExecutor
-  * **pixi.cortex.MobileSpot.connected.Mob1** Number of connected Visitor spots, sith the last segment(s) (here "Mob1")= being the dot-separated Spot path.+  * **pixi.cortex.MobileSpot.connected.Mob1** Number of connected Visitor spots, with the last segment(s) (here "Mob1") being the dot-separated Spot path.
  
 In addition to those, you can also use any metric provided by Blocks' infrastructure, such as those listed below. Refer to the respective infrastructure component for details. In addition to those, you can also use any metric provided by Blocks' infrastructure, such as those listed below. Refer to the respective infrastructure component for details.
  
 +<code>
 ch.qos.logback.core.Appender.all ch.qos.logback.core.Appender.all
 ch.qos.logback.core.Appender.debug ch.qos.logback.core.Appender.debug
Line 195: Line 199:
 TimeBoundHealthCheck-pool.running TimeBoundHealthCheck-pool.running
 TimeBoundHealthCheck-pool.terminated TimeBoundHealthCheck-pool.terminated
 +</code>
 +