Add puffin profiler info

meilisearch · Oct 31, 2023 · 7339b51 · 7339b51
1 parent 9a9e44e
commit 7339b51
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 7 deletions.
diff --git a/config/sidebar-learn.json b/config/sidebar-learn.json
@@ -397,6 +397,11 @@
         "label": "Metrics",
         "slug": "metrics"
       },
+      {
+        "source": "learn/experimental/puffin_reports.mdx",
+        "label": "Puffin reports",
+        "slug": "puffin_reports"
+      },
       {
         "source": "learn/experimental/reduce-indexing-memory-usage.mdx",
         "label": "Reduce indexing memory usage",

diff --git a/learn/experimental/overview.mdx b/learn/experimental/overview.mdx
@@ -48,3 +48,4 @@ Activating or deactivating experimental features this way does not require you t
 | [Ranking score details](/learn/experimental/ranking_rule_score_details)          | Exposes advanced result ranking score data                 | During runtime with the API route                 |
 | [Reduce indexing memory usage](/learn/experimental/reduce-indexing-memory-usage) | Optimizes indexing performance                             | At launch with a CLI flag or environment variable |
 | [Vector search](/learn/experimental/vector_search)                               | Allows Meilisearch to function as a vector embedding store | During runtime with the API route                 |
+| [Puffin reports](/learn/experimental/puffin_reports)                             | Export profiler data to diagnose performance issues        | During runtime with the API route                 |
diff --git a/learn/experimental/puffin_reports.mdx b/learn/experimental/puffin_reports.mdx
@@ -0,0 +1,18 @@
+---
+title: Puffin reports — Meilisearch documentation
+description: 
+---
+
+# Puffin reports
+
+Puffin is an instrumentation profiler for Rust applications. Use this feature when trying to diagnose performance issues during indexing. Avoid enabling this experimental feature when not debugging, as it might affect performance of other Meilisearch operations.
+
+[Visit the GitHub discussion to learn how to use this feature](https://github.com/meilisearch/product/discussions/693).
+
+Are you using this feature? Meilisearch wants to hear from you! Tell us about your experience in the [GitHub discussion](https://github.com/meilisearch/product/discussions/693). All feedback is useful and helps make Meilisearch better and easier to use.
+
+<Capsule intent="warning">
+Exporting Puffin reports is an experimental feature. Experimental features are unstable: their API might significantly change and become incompatible between releases. Meilisearch does not recommend using experimental features in a production environment.
+
+Meilisearch makes experimental features available expecting they will become stable in a future release. However, it is not possible to guarantee when and if this will happen.
+</Capsule>
diff --git a/reference/api/experimental_features.mdx b/reference/api/experimental_features.mdx
@@ -18,14 +18,16 @@ The experimental API route is not compatible with all experimental features. Con
 ```json
 {
   "scoreDetails": false,
-  "vectorSearch": false
+  "vectorSearch": false,
+  "exportPuffinReports": false
 }
 ```
 
-| Name               | Type    | Description                                                               |
-| :----------------- | :------ | :--------------------------------------------- |
-| **`scoreDetails`** | Boolean | `true` if feature is active, `false` otherwise |
-| **`vectorSearch`** | Boolean | `true` if feature is active, `false` otherwise |
+| Name                      | Type    | Description                                                               |
+| :------------------------ | :------ | :--------------------------------------------- |
+| **`scoreDetails`**        | Boolean | `true` if feature is active, `false` otherwise |
+| **`vectorSearch`**        | Boolean | `true` if feature is active, `false` otherwise |
+| **`exportPuffinReports`** | Boolean | `true` if feature is active, `false` otherwise |
 
 
 ## Get all experimental features
@@ -43,7 +45,8 @@ Get a list of all experimental features that can be activated via the `/experime
 ```json
 {
   "scoreDetails": false,
-  "vectorSearch": false
+  "vectorSearch": false,
+  "exportPuffinReports": false
 }
 ```
 
@@ -68,6 +71,7 @@ Setting a field to `null` leaves its value unchanged.
 ```json
 {
   "scoreDetails": true,
-  "vectorSearch": false
+  "vectorSearch": false,
+  "exportPuffinReports": false
 }
 ```