feat: Configurable list of json fields to mine patterns #14528
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
salvacorts
changed the title
benclive
reviewed
Oct 18, 2024
pkg/validation/limits.go
Outdated
| @@ -418,6 +420,9 @@ func (l *Limits) RegisterFlags(f *flag.FlagSet) { | |||
| f.IntVar(&l.BlockIngestionStatusCode, "limits.block-ingestion-status-code", defaultBlockedIngestionStatusCode, "HTTP status code to return when ingestion is blocked. If 200, the ingestion will be blocked without returning an error to the client. By Default, a custom status code (260) is returned to the client along with an error message.") | |||
|
|
|||
| f.IntVar(&l.IngestionPartitionsTenantShardSize, "limits.ingestion-partition-tenant-shard-size", 0, "The number of partitions a tenant's data should be sharded to when using kafka ingestion. Tenants are sharded across partitions using shuffle-sharding. 0 disables shuffle sharding and tenant is sharded across all partitions.") | |||
|
|
|||
| _ = l.PatternIngesterTokenizableJSONFields.Set("log,message,msg,msg_,_msg,content") | |||
There was a problem hiding this comment.
Does this mean we need to redefine all of these in the limits if we want to add a new one alongside the existing ones?
Is the default list part of the doc/description so it is easy to reference in that case?
There was a problem hiding this comment.
Added a default, append and delete lists. So we can better customize the default list per tenant.
pkg/pattern/drain/drain_test.go
Outdated
| @@ -91,7 +91,7 @@ func TestDrain_TrainExtractsPatterns(t *testing.T) { | |||
| }, | |||
| }, | |||
| { | |||
| drain: New(DefaultConfig(), "", nil), | |||
| drain: New("", DefaultConfig(), &fakeLimits{}, "", nil), | |||
There was a problem hiding this comment.
nit: define a tenantID constant for this, so its obvious what is being passed here
benclive
approved these changes
Oct 21, 2024
salvacorts
deleted the
salvacorts/configurable_tenant_json_pattern_fields
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR makes the hardcoded list of json fields to mine patterns for configurable. This would allow us to:
This list is now configurable via the following overrides:
pattern_ingester_tokenizable_json_fields_default: It takes a comma-separated list of fields. By default we set it to the currently hardcoded list:log,message,msg,msg_,_msg,content.pattern_ingester_tokenizable_json_fields_append: Also comma-separated. Appends content to default list.pattern_ingester_tokenizable_json_fields_delete: Comma-separated. Deletes keys from (default U append).The docs are hidden.
Special notes for your reviewer:
pattern.streamvia theinstanceIDof thepattern.instancewhich in turns comes from thepattern.IngesteratGetOrCreateInstancewhere theinstanceIDcomes from the tenantID in the ctx.Checklist
CONTRIBUTING.mdguide (required)featPRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.mddeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory. Example PR