Add specification about both new logs experimental features (#265)

* Add specification about both new logs experimental features * Update text/0119-instance-options.md Co-authored-by: Guillaume Mourier <[email protected]> --------- Co-authored-by: Maria Craig <[email protected]> Co-authored-by: Guillaume Mourier <[email protected]>
meilisearch · Mar 11, 2024 · 88bda96 · 88bda96
1 parent b11f5c9
commit 88bda96
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/text/0034-telemetry-policies.md b/text/0034-telemetry-policies.md
@@ -110,6 +110,8 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat
 | `infos.with_configuration_file`         | `true` if the instance is launched with a configuration file, otherwise `false` | false | Every Hour |
 | `infos.task_queue_webhook`              | `true` if the instance is launched with a task queue webhook, otherwise `false` | false | Every Hour |
 | `infos.experimental_enable_metrics`     | `true` if  `--experimental-enable-metrics`/`MEILI_EXPERIMENTAL_ENABLE_METRICS` is specified at launch, otherwise `false` | `false` | Every Hour |
+| `infos.experimental_logs_mode`          | `human` or `json` depending on the value specified. | `human` | Every Hour |
+| `infos.experimental_enable_logs_route`  | `true` if  `--experimental-enable-logs-route`/`MEILI_EXPERIMENTAL_ENABLE_LOGS_ROUTE` is specified at launch, otherwise `false` | `false` | Every Hour |
 | `infos.experimental_reduce_indexing_memory_usage`     | `true` if  `--experimental-reduce-indexing-memory-usage`/`MEILI_EXPERIMENTAL_REDUCE_INDEXING_MEMORY_USAGE` is specified at launch, otherwise `false` | `false` | Every Hour |
 | `infos.gpu_enabled` | `true` if Meilisearch was compiled with CUDA support, otherwise `false` | `false` | Every Hour |
 | `system.distribution`                   | Distribution on which MeiliSearch is launched           | Arch Linux        | Every hour |
@@ -260,6 +262,8 @@ This property allows us to gather essential information to better understand on
 | infos.with_configuration_file | `true` if the instance is launched with a configuration file, otherwise `false` | `false` |
 | infos.task_queue_webhook      | `true` if the instance is launched with a task queue webhook, otherwise `false` | `false` |
 | infos.experimental_enable_metrics | `true` if  `--experimental-enable-metrics`/`MEILI_EXPERIMENTAL_ENABLE_METRICS` is specified at launch, otherwise `false` | `false` |
+| infos.experimental_logs_mode          | `human` or `json` depending on the value specified. | `human` |
+| infos.experimental_enable_logs_route  | `true` if  `--experimental-enable-logs-route`/`MEILI_EXPERIMENTAL_ENABLE_LOGS_ROUTE` is specified at launch, otherwise `false` | `false` |
 | `infos.experimental_reduce_indexing_memory_usage`     | `true` if  `--experimental-reduce-indexing-memory-usage`/`MEILI_EXPERIMENTAL_REDUCE_INDEXING_MEMORY_USAGE` is specified at launch, otherwise `false` | `false` |
 | `infos.gpu_enabled` | `true` if Meilisearch was compiled with CUDA support, otherwise `false` | `false` |
 

diff --git a/text/0119-instance-options.md b/text/0119-instance-options.md
@@ -500,6 +500,18 @@ Activate the `/metrics` endpoint to collect Meilisearch metrics for monitoring p
 
 Enables the `MDB_WRITEMAP` option of LMDB, making the internal key-value store use much less RAM than usual.
 
+#### 3.3.28. Experimental Logs Mode
+
+**Environment variable**: `MEILI_EXPERIMENTAL_LOGS_MODE`
+**CLI option**: `--experimental-logs-mode`
+**Default**: `human`
+
+Lets you customize the mode in which meilisearch should output its logs.
+Only two values are possible:
+- `human` => The default one; it's easy to read for a human
+- `json` => It's better if you're going to send your logs to a log storage software
+
+
 #### 3.3.29. Task webhook url
 
 **Environment variable**: `MEILI_TASK_WEBHOOK_URL`

diff --git a/text/0193-experimental-features.md b/text/0193-experimental-features.md
@@ -22,6 +22,8 @@ To enable instance experimental features, pass their associated command line fla
 |------------|-----------------|-----------|-------------------------|-----------------------------------|------------------|
 |Prometheus Metrics|`--experimental-enable-metrics`|The `/metrics` endpoint exposes metrics to be scraped by a Prometheus collector at regular intervals and stored for analysis.|We have yet to determine which metrics we want to expose and how|TBC|<https://github.com/meilisearch/product/discussions/625>|
 |Reduce Indexing Memory Usage|`--experimental-reduce-indexing-memory-usage`|Trades-off indexing speed with a lower RAM footprint.|We have yet to determine if a lot impacts performance and whether the RAM usage reduction is significant enough.|TBC|<https://github.com/meilisearch/product/discussions/652>|
+|Enable logs route|`--experimental-enable-logs-route`|The `/logs/*` endpoints exposes ways to retrieves and customizes logs.|TBC|<https://github.com/orgs/meilisearch/discussions/721>|
+|Change logs mode|`--experimental-logs-mode json`|The CLI flags takes a parameter, either `json` or `human` that will change the way we output the logs to the console. `human` is used by default.|TBC|<https://github.com/orgs/meilisearch/discussions/723>|
 
 
 ## 3.2. Runtime experimental features
@@ -72,4 +74,4 @@ N/A
 
 ## 5. Future Possibilities
 
-N/A
+N/A