Skip to content
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.

Sign up for GitHub

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

add more context and links to intrinsic EV documentation #1307

Merged
merged 1 commit into from
Dec 16, 2024
Merged

add more context and links to intrinsic EV documentation #1307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion configuration/accelerators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,11 @@ Note that the tag `zeekconn` can be matched against both accelerators, however t
Tags=foo*
```

(intrinsic-acceleration-target)=
## Acceleration with Intrinsic Enumerated Values

When acceleration is enabled, [intrinsic enumerated values](#attach-target) will always be accelerated with the fulltext engine. This enables queries using the [intrinsic](/search/intrinsic/intrinsic) module to be accelerated. No specific configuration is required for acceleration with intrinsic EVs other than having acceleration enabled.

## Fulltext

The fulltext accelerator is designed to index words within text logs and is considered the most flexible acceleration option. Many of the other search modules support invoking the fulltext accelerator when executing queries. However, the primary search module for engaging with the fulltext accelerator is the [grep](/search/grep/grep) module with the `-w` flag. Much like the Unix grep utility, `grep -w` specifies that the provided filter is expected to a word, rather than a subset of bytes. Running a search with `words foo bar baz` will look for the words foo, bar, and baz and engage the fulltext accelerator.
Expand Down Expand Up @@ -686,7 +691,6 @@ The results show why fulltext may often be worth the storage and ingest penalty:
| fulltextindex | 2.99s | 12.49X |
| fulltextbloom | 3.40s | 12.49X |


#### Query AX modules

The AX definition file for all four tags is below, see the [AX](/configuration/autoextractors) documentation for more information:
Expand Down
1 change: 1 addition & 0 deletions ingesters/ingesters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,7 @@ Log-Source-Override=DEAD:BEEF::FEED:FEBE
Log-Source-Override=::1
```

(attach-target)=
### Attach

All ingesters support the `Attach` global configuration stanza, which allows [intrinsic enumerated values](intrinsic_enumerated_values) to be attached to entries during ingest. Intrinsic enumerated values can later be accessed with the [intrinsic](/search/intrinsic/intrinsic) search module.
Expand Down
4 changes: 3 additions & 1 deletion search/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,12 @@ Further examples throughout the documentation should help clarify the use of enu
(intrinsic_enumerated_values)=
## Intrinsic Enumerated Values

Intrinsic Enumerated Values are Enumerated Values which are created at the time of ingest. Intrinsic enumerated values are optionally created by ingesters and often contain metadata or pre-processed extractions. Use the [intrinsic](intrinsic/intrinsic) module to work with intrinsic enumerated values.
Intrinsic Enumerated Values are Enumerated Values which are created at the time of ingest. Intrinsic enumerated values are optionally [created by ingesters](#attach-target) and often contain metadata or pre-processed extractions. Use the [intrinsic](intrinsic/intrinsic) module to work with intrinsic enumerated values.

After extracting an intrinsic enumerated value, they are treated the same as regular enumerated values.

Intrinsic EVs are [automatically accelerated](#intrinsic-acceleration-target) when using acceleration.

## Quoting and tokenizing

When specifying arguments to Gravwell modules, be mindful of special characters. Most modules treat spaces, tabs, newlines, and the following characters as separators: !#$%&'()*+,-./:;<=>?@
Expand Down
Loading