Update Free and Full Text Search documentation #27434
Conversation
Hi! I'm Piotr and I'm part of the #frontend-parser-guild. I found a few mistakes in the free and full-text search documentation. I consulted this with @sfluor from EvP storage and tested provided examples on org 2.
| | `hello` | Free text | Searches only the log message for the term `hello`. | | ||
| | Search syntax | Search type | Description | | ||
| | ------------- | ----------- | --------------------------------------------------------- | | ||
| | `*:hello` | Full-text | Searches all log attributes for the exact string `hello`. | |
There was a problem hiding this comment.
nit: maybe use the same wording for both (exact string / word)
Preview links (active after the
|
| | Search syntax | Search type | Description | | ||
| | ------------- | ----------- | ------------------------------------------------------------------------------------------- | | ||
| | `*:hello` | Full-text | Searches all log attributes for the exact string `hello`. | | ||
| | `*:hello*` | Full-text | Searches all log attributes for strings starting with `hello`. For example, `hello_world`. | |
There was a problem hiding this comment.
I found a ticket (https://datadoghq.atlassian.net/browse/DOCS-9144) that removed starting from this description after customer reported it's matching all logs with hello word inside it. I tested it on org 2 and it's not the case. I think customer got confused in some way, but they report was not valid.
| ### Multiple terms without exact match example | ||
|
|
||
| The full-text search syntax `*:hello world` is equivalent to `*:hello *:world`. It searches all log attributes for the terms `hello` and `world`. | ||
|
|
||
| ### Multiple terms with a white space example | ||
|
|
||
| The full-text search syntax `*:"hello world" "i am here"` is equivalent to `*:"hello world" *:"i am here"`. It searches all log attributes for the terms `hello world` and `i am here`. |
There was a problem hiding this comment.
These paragraphs were not true. It's better to remove them :)
For example *:hello world is not equal to *:hello *:world. In this example, we will do Full Text Search on hello and Free Text Search on world. Same goes with the second paragraph.
Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
|
/merge |
Devflow running:
|
dd-devflow
bot
added
mergequeue-status: queued
mergequeue-status: in_progress
and removed
mergequeue-status: queued
labels
dd-devflow
bot
added
mergequeue-status: done
and removed
mergequeue-status: in_progress
labels
dd-mergequeue
bot
deleted the
piotr-oles/update-text-search-documentation
branch
Hi! I'm Piotr and I'm part of the #frontend-parser-guild.
What does this PR do? What is the motivation?
I found a few mistakes in the free and full-text search documentation. I consulted this with @sfluor from EvP storage and tested provided examples on org 2.
Merge instructions
The feature is GA'd nothing blocking here.
Merge readiness:
Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the
<yourname>/descriptionnaming convention) and then add the following PR comment: