[jaeger-v2] Add Validation And Comments to Badger Storage Config

mahadzaryab1 commented 2 months ago

Which problem is this PR solving?

Resolves #5926

Description of the changes

Implemented Validate method for NamespaceConfiguration struct for the badger storage
Created migration doc from v1 to v2

How was this change tested?

Added unit tests for the new method

Checklist

[x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md
[x] I have signed all commits
[x] I have added unit tests for the new functionality
[x] I have run lint and test steps successfully
- for jaeger: make lint test
- for jaeger-ui: yarn lint and yarn test

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.81%. Comparing base (1da98bb) to head (c5f9ffa). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #5927 +/- ## ======================================= Coverage 96.81% 96.81% ======================================= Files 344 344 Lines 16530 16537 +7 ======================================= + Hits 16003 16010 +7 Misses 340 340 Partials 187 187 ``` | [Flag](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | Coverage Δ | | |---|---|---| | [badger_v1](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `8.08% <53.57%> (+0.04%)` | :arrow_up: | | [badger_v2](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `1.82% <0.00%> (-0.01%)` | :arrow_down: | | [cassandra-3.x-v1](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `16.60% <0.00%> (-0.02%)` | :arrow_down: | | [cassandra-3.x-v2](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `1.75% <0.00%> (-0.01%)` | :arrow_down: | | [cassandra-4.x-v1](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `16.60% <0.00%> (-0.02%)` | :arrow_down: | | [cassandra-4.x-v2](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `1.75% <0.00%> (-0.01%)` | :arrow_down: | | [elasticsearch-6.x-v1](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `18.76% <0.00%> (-0.02%)` | :arrow_down: | | [elasticsearch-7.x-v1](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `18.83% <0.00%> (-0.02%)` | :arrow_down: | | [elasticsearch-8.x-v1](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `19.01% <0.00%> (-0.03%)` | :arrow_down: | | [elasticsearch-8.x-v2](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `1.81% <0.00%> (-0.02%)` | :arrow_down: | | [grpc_v1](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `9.48% <0.00%> (-0.01%)` | :arrow_down: | | [grpc_v2](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `7.15% <0.00%> (-0.01%)` | :arrow_down: | | [kafka-v1](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `9.73% <0.00%> (-0.01%)` | :arrow_down: | | [kafka-v2](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `1.82% <0.00%> (-0.01%)` | :arrow_down: | | [memory_v2](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `1.82% <0.00%> (+0.01%)` | :arrow_up: | | [opensearch-1.x-v1](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `18.87% <0.00%> (-0.03%)` | :arrow_down: | | [opensearch-2.x-v1](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `18.87% <0.00%> (-0.03%)` | :arrow_down: | | [opensearch-2.x-v2](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `1.82% <0.00%> (+0.01%)` | :arrow_up: | | [tailsampling-processor](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `0.46% <0.00%> (-0.01%)` | :arrow_down: | | [unittests](https://app.codecov.io/gh/jaegertracing/jaeger/pull/5927/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing) | `95.29% <100.00%> (+<0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jaegertracing#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

yurishkuro commented 2 months ago

please resolve conflicts

mahadzaryab1 commented 2 months ago

please resolve conflicts

done!

yurishkuro commented 2 months ago

One more thing we can do is combine Options and NamespaceConfig into a single struct Config.

mahadzaryab1 commented 2 months ago

@yurishkuro do we just want to get rid of Options and rename NamespaceConfig to Config?

yurishkuro commented 2 months ago

Yes, the separate Options struct now serves no purpose.

mahadzaryab1 commented 2 months ago

Yes, the separate Options struct now serves no purpose.

Opened PR at https://github.com/jaegertracing/jaeger/pull/5937

jaegertracing / jaeger