Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Add specification about both new logs experimental features #265

Merged
merged 3 commits into from
Mar 11, 2024
Merged

Add specification about both new logs experimental features #265

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f7e120
Add specification about both new logs experimental features
irevoire Feb 14, 2024
b68c132
Update text/0119-instance-options.md
macraig Mar 11, 2024
e310a97
Merge branch 'release-v1.7.0' into experimental-logs-route
macraig Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions text/0034-telemetry-policies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| `system.distribution` | Distribution on which MeiliSearch is launched | Arch Linux | Every hour |
| `system.kernel_version` | Kernel version on which MeiliSearch is launched | 5.14.10 | Every hour |
Expand Down Expand Up @@ -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` |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is infos.experimental_logs_mode both affected by the CLI and an API call when settings up the stream route?

| infos.experimental_enable_logs_route | `true` if `--experimental-enable-logs-route`/`MEILI_EXPERIMENTAL_ENABLE_LOGS_ROUTE` is specified at launch, otherwise `false` | `false` |

##### MeiliSearch Statistics `stats`

Expand Down
12 changes: 12 additions & 0 deletions text/0119-instance-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Reduce Indexing Memory Usage
macraig marked this conversation as resolved.
Show resolved Hide resolved

**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`
Expand Down
4 changes: 3 additions & 1 deletion text/0193-experimental-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -95,4 +97,4 @@ N/A

## 5. Future Possibilities

N/A
N/A
Loading