Added feature to index context header in visibility #6066
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
shijiesheng
requested review from
Shaddoll,
neil-xie,
davidporter-id-au,
Groxx,
agautam478,
jakobht,
3vilhamster,
sankari165,
dkrotx,
taylanisikdemir and
demirkayaender
as code owners
shijiesheng
changed the title
taylanisikdemir
approved these changes
May 28, 2024
common/dynamicconfig/constants.go
Outdated
| @@ -2532,6 +2538,8 @@ const ( | |||
| // Default value: 400ms (400*time.Millisecond) | |||
| // Allowed filters: N/A | |||
| TransferProcessorVisibilityArchivalTimeLimit | |||
| // | |||
There was a problem hiding this comment.
empty comment section
| // Attr is prefix of custom search attributes | ||
| Attr = "Attr" | ||
| // HeaderFormat is the format of context headers in search attributes | ||
| HeaderFormat = "Header.%s" |
There was a problem hiding this comment.
do we need to add validation somewhere to ensure that users don't create Header.Something search attributes?
There was a problem hiding this comment.
We use admin API AddSearchAttribute from admin CLI to onboard a new search attributes. If we block there, it's going to be manual to update schema on visibility storage directly, which is not ideal.
The validation thus has to be manual
timl3136
pushed a commit
to timl3136/cadence
that referenced
this pull request
Jun 6, 2024
What changed? Context headers are now searchable using visibility. API As users, they can search workflows by headers through List*Workflows / CountWorkflows with [SQL-like queries] Header.uberctx-tenancy = "uber/testing" AND CloseStatus != "completed" ORDER BY StartTime DESC Onboarding Steps Add "Header.XXX" to frontend.validSearchAttributes Enable "history.enableContextHeaderInVisibility" Why? Context headers are user propagated headers, including tracing baggages. Enable search-ability will enhance debugging and better observability. How did you test it? Unit Test
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 changed?
Context headers are now searchable using visibility.
API
As users, they can search workflows by headers through List*Workflows / CountWorkflows with [SQL-like queries]
Onboarding Steps
frontend.validSearchAttributesWhy?
Context headers are user propagated headers, including tracing baggages. Enable search-ability will enhance debugging and better observability.
How did you test it?
Unit Test
Potential risks
Release notes
Documentation Changes