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.

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

Fix misleading use-alias help doc #2692

Merged

Conversation

albertteoh
Copy link
Contributor

Signed-off-by: albertteoh albert.teoh@logz.io

Which problem is this PR solving?

Short description of the changes

  • The documentation states that es.max-span-age is not taken into account when use-alias is enabled, which causes users to think that all indices under the jaeger-...-read alias are searchable. However, es.max-span-age is used to define the starting window of ES queries like in this example.
  • We address this by explicitly documenting that es.max-span-age does influence search window start times, without being too specific to implementation.

Signed-off-by: albertteoh <albert.teoh@logz.io>
@albertteoh albertteoh requested a review from a team as a code owner December 15, 2020 13:03
@codecov
Copy link

codecov bot commented Dec 15, 2020

Codecov Report

Merging #2692 (38b7121) into master (34cf3ed) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2692      +/-   ##
==========================================
+ Coverage   95.57%   95.58%   +0.01%     
==========================================
  Files         215      215              
  Lines        9579     9579              
==========================================
+ Hits         9155     9156       +1     
+ Misses        346      345       -1     
  Partials       78       78              
Impacted Files Coverage Δ
plugin/storage/es/options.go 100.00% <100.00%> (ø)
cmd/collector/app/server/zipkin.go 76.92% <0.00%> (+3.84%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 34cf3ed...38b7121. Read the comment docs.

@yurishkuro yurishkuro merged commit cfcb937 into jaegertracing:master Dec 15, 2020
@albertteoh albertteoh deleted the remove-misleading-help-doc branch December 15, 2020 23:56
bhiravabhatla pushed a commit to bhiravabhatla/jaeger that referenced this pull request Jan 25, 2021
Signed-off-by: albertteoh <albert.teoh@logz.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Elasticsearch alias config requires max-span-age to be configured
2 participants