Skip to content

v1.16: Telemetry updates #3325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: v1.16
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions learn/resources/telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,8 @@ This list is liable to change with every new version of Meilisearch. It's not be
| `infos.experimental_edit_documents_by_function` | `true` if the `editDocumentsByFunction` experimental feature is enabled | false
| `infos.experimental_enable_metrics` | `true` if `--experimental-enable-metrics` is specified at launch | false
| `infos.experimental_embedding_cache_entries` | Size of configured embedding cache | 100
| `infos.experimental_multimodal` | `true` when multimodal search feature is enabled | true |
| `infos.experimental_no_edition_2024_for_settings` | `true` if instance disabled new indexer | false
| `infos.experimental_replication_parameters` | `true` if `--experimental-replication-parameters` is specified at launch | false
| `infos.experimental_reduce_indexing_memory_usage` | `true` if `--experimental-reduce-indexing-memory-usage` is specified at launch | false
| `infos.experimental_logs_mode` | `human` or `json` depending on the value specified | human
Expand All @@ -248,6 +250,7 @@ This list is liable to change with every new version of Meilisearch. It's not be
| `vector.retrieve_vectors` | `true` if the retrieve_vectors parameter has been used in this batch. | false
| `hybrid.enabled` | `true` if hybrid search been used in the aggregated event | true
| `hybrid.semantic_ratio` | `true` if semanticRatio was used in this batch, otherwise false | false
| `hybrid.total_media` | Aggregated number of search request where `media` is not `null` | 42
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `hybrid.total_media` | Aggregated number of search request where `media` is not `null` | 42
| `hybrid.total_media` | Aggregated number of search requests where `media` is not `null` | 42

| `embedders.total` | Numbers of defined embedders | 2
| `embedders.sources` | An array representing the different provided sources | ["huggingFace", "userProvided"]
| `embedders.document_template_used` | A boolean indicating if one of the provided embedders has a custom template defined | true
Expand All @@ -264,3 +267,9 @@ This list is liable to change with every new version of Meilisearch. It's not be
| `experimental_network` | `true` when the network experimental feature is enabled | true
| `remotes.total_distinct_remote_count` | Sum of the number of distinct remotes appearing in each search request of the aggregate | 48
| `remotes.avg_distinct_remote_count` | Average number of distinct remotes appearing in a search request of the aggregate | 2.33
| `multimodal` | `true` when multimodal search is enabled via the `/experimental-features` route | true
| `export.total_received` | Number of exports received in this batch | `152`
| `export.has_api_key` | Number of exports with an API Key set | `89`
| `export.avg_index_patterns` | Average number of index patterns set per export | `3.2`
| `export.avg_patterns_with_filter` | Average number of index patterns with filters per export | `1.7`
| `export.avg_payload_size` | Average payload size per export | `512`
2 changes: 1 addition & 1 deletion snippets/samples/code_samples_add_movies_json_1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ file, _ := os.ReadFile("movies.json")
var movies interface{}
json.Unmarshal([]byte(file), &movies)

client.Index("movies").AddDocuments(&movies)
client.Index("movies").AddDocuments(&movies, nil)
```

```csharp C#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ documents := []map[string]interface{}{
"release_date": "2019-03-23",
},
}
client.Index("movies").AddDocuments(documents)
client.Index("movies").AddDocuments(documents, nil)
```

```csharp C#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ documents := []map[string]interface{}{
"genres": "comedy",
},
}
client.Index("movies").UpdateDocuments(documents)
client.Index("movies").UpdateDocuments(documents, nil)
```

```csharp C#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ client.index('games').update_filterable_attributes(['release_timestamp'])
```

```go Go
filterableAttributes := []string{"release_timestamp"}
filterableAttributes := []interface{}{"release_timestamp"}
client.Index("games").UpdateFilterableAttributes(&filterableAttributes)
```

Expand Down
2 changes: 1 addition & 1 deletion snippets/samples/code_samples_date_guide_index_1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ byteValue, _ := io.ReadAll(jsonFile)
var games []map[string]interface{}
json.Unmarshal(byteValue, &games)

client.Index("games").AddDocuments(games)
client.Index("games").AddDocuments(games, nil)
```

```csharp C#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ client.index('products').update_filterable_attributes([
```

```go Go
filterableAttributes := []string{
filterableAttributes := []interface{}{
"product_id",
"sku",
"url",
Expand Down
1 change: 1 addition & 0 deletions snippets/samples/code_samples_facet_search_3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ client.index('books').facet_search('genres', 'c')
client.Index("books").FacetSearch(&meilisearch.FacetSearchRequest{
FacetQuery: "c",
FacetName: "genres",
ExhaustiveFacetCount: true
})
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ client.index('movie_ratings').update_filterable_attributes(['genres', 'rating',
```

```go Go
filterableAttributes := []string{
filterableAttributes := []interface{}{
"genres",
"rating",
"language",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ client.index('movies').update_filterable_attributes([
```

```go Go
resp, err := client.Index("movies").UpdateFilterableAttributes(&[]string{
resp, err := client.Index("movies").UpdateFilterableAttributes(&[]interface{}{
"director",
"genres",
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ client.index('restaurants').update_filterable_attributes(['_geo'])
```

```go Go
filterableAttributes := []string{
filterableAttributes := []interface{}{
"_geo",
}
client.Index("restaurants").UpdateFilterableAttributes(&filterableAttributes)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ func main() {
var movies []map[string]interface{}
json.Unmarshal(byteValue, &movies)

_, err := client.Index("movies").AddDocuments(movies)
_, err := client.Index("movies").AddDocuments(movies, nil)
if err != nil {
panic(err)
}
Expand Down Expand Up @@ -192,7 +192,7 @@ namespace Meilisearch_demo
```text Rust
// In your .toml file:
[dependencies]
meilisearch-sdk = "0.29.0"
meilisearch-sdk = "0.29.1"
# futures: because we want to block on futures
futures = "0.3"
# serde: required if you are going to use documents
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ byteValue, _ := io.ReadAll(jsonFile)
var meteorites []map[string]interface{}
json.Unmarshal(byteValue, &meteorites)

client.Index("meteorites").AddDocuments(meteorites)
client.Index("meteorites").AddDocuments(meteorites, nil)
```

```csharp C#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ documents := []map[string]interface{}{
{ "id": 5, "title": "Moana" },
{ "id": 6, "title": "Philadelphia" },
}
client.Index("movies").AddDocuments(documents)
client.Index("movies").AddDocuments(documents, nil)
```

```csharp C#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ documents := []map[string]interface{}{
"price": 5.00,
},
}
client.Index("books").AddDocuments(documents, "reference_number")
refrenceNumber := "reference_number"
client.Index("books").AddDocuments(documents, &refrenceNumber)
```

```csharp C#
Expand Down
6 changes: 6 additions & 0 deletions snippets/samples/code_samples_typo_tolerance_guide_5.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,10 @@ $client->index('movies')->updateTypoTolerance([
'disableOnNumbers' => true
]);
```

```go Go
client.Index("movies").UpdateTypoTolerance(&meilisearch.TypoTolerance{
DisableOnNumbers: true
})
```
</CodeGroup>
22 changes: 21 additions & 1 deletion snippets/samples/code_samples_update_filterable_attributes_1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,29 @@ client.index('movies').update_filterable_attributes([
```

```go Go
filterableAttributes := []string{
filterableAttributes := []interface{}{
"genres",
"director",
AttributeRule{
AttributePatterns: []string{"tag"}
Features: AttributeFeatures{
FacetSearch: false,
Filter: FilterFeatures{
Equality: true,
Comparison: false,
}
}
},
map[string]interface{}{
"attributePatterns": []interface{}{"year"}
"features": map[string]interface{}{
"facetSearch": false,
"filter": map[string]interface{}{
"equality": true,
"comparison": true,
}
}
}
}
client.Index("movies").UpdateFilterableAttributes(&filterableAttributes)
```
Expand Down