Merge branch 'main' into merge-button

Author: metalmatze

docs/flamegraph-binary-based-colour-stack.mdx

@@ -0,0 +1,40 @@
+# Binary-based Color Stack
+
+import BrowserWindow from '@site/src/components/BrowserWindow';
+
+For quick troubleshooting, you can use the binary-based color stack mode to quickly identify the most expensive binaries in the rendered flamegraph. In binary-based color stack mode, the colour of a node in the flamegraph is based on the
+binary that the function belongs to. This way, you can quickly identify the most expensive binaries in the given profile.
+
+### How to use it
+Open the User Preferences dialog by clicking the gear icon in the top-right corner of the UI.
+
+<BrowserWindow>
+
+![User Preferences Option](../static/img/parca/user-preferences-icon.png)
+</BrowserWindow>
+<br />
+
+In the User Preferences dialog, select your preferred color profile in the `Flamegraph Color Profile` section and click `Close`.
+
+
+<BrowserWindow>
+
+![Color Profile Selection](../static/img/parca/color-profile-selection.gif)
+
+</BrowserWindow>
+<br />
+
+:::tip
+You can always switch back to the `Default` color profile to disable the binary-based color stack mode.
+:::
+
+<br />
+
+You can also click on the `Binary` names at the top to highlight the nodes corresponding to that binary in the flamegraph.
+
+<BrowserWindow>
+
+![Highlighting Nodes From a Binary](../static/img/parca/highlighting-nodes-from-binary.png)
+
+</BrowserWindow>
+<br />

docs/observability.mdx

@@ -26,6 +26,20 @@ Parca exposes Prometheus metrics on [localhost:7070/metrics](http://localhost:70
 Parca's monitoring is mostly focused on read and write requests to Parca.
 For that reason the `grpc_server_handled_total` is the most important metric for Parca and most of the other metrics and helpful for debugging overall.
 
+There are some FrostDB specific metrics that are useful to monitor as well.
+
+| Metric                      |  Description                                                |  Type     |
+| ----------------------------|------------------------------------------------------------ | --------- |
+| `frostdb_granules_compactions_total`| Number of per table compaction events that have occurred.   | counter   |
+| `frostdb_granules_created_total`    | Number of per table granules that have been created.        | counter   |
+| `frostdb_blocks_rotated_total`      | Number of per table blocks that have rotated out.           | counter   |
+| `frostdb_active_table_block_size`   | The estimated size in bytes of each tables active block size.  | gauge     |
+| `frostdb_row_insert_size`           | Per table tracking of the size in bytes of rows inserted.   | histogram |
+| `frostdb_thanos_objstore_bucket_last_successful_upload_time`| If bucket storage is enabled, the last successful upload to the bucket. | gauge |
+| `frostdb_thanos_objstore_bucket_operation_failures_total`   | Total number of bucket operations that have failed. | counter |
+| `frostdb_tx_high_watermark`         | The transaction number that is safe to read up to.          | gauge     |
+
+
 ### Service Level Objectives
 
 Here are some example Service Level Objectives for Parca.

sidebars.js

@@ -41,6 +41,17 @@ module.exports = {
         },
         "observability",
         "configuration",
+        {
+          type: "category",
+          label: "Profile Visualization",
+          items: [
+            {
+              type: "category",
+              label: "Flamegraph",
+              items: ["flamegraph-binary-based-colour-stack"],
+            },
+          ],
+        },
       ],
     },
     {