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

feat(observability):add ready&health check api for k8s #938

Merged
merged 23 commits into from
Sep 11, 2023

Conversation

georgehao
Copy link
Member

@georgehao georgehao commented Sep 8, 2023

Purpose or design rationale of this PR

Describe your change. Make sure to answer these three questions: What does this PR do? Why does it do it? How does it do it?

https://scrollco.slack.com/archives/C04MC0S70A3/p1692170426168649

add ready&health check api in observability module

PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
  • ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
  • docs: Documentation-only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Deployment tag versioning

Has tag in common/version.go been updated or have you added bump-version label to this PR?

  • No, this PR doesn't involve a new deployment, git tag, docker image tag
  • Yes

Breaking change label

Does this PR have the breaking-change label?

  • No, this PR is not a breaking change
  • Yes

@georgehao georgehao added the bump-version Bump the version tag for deployment label Sep 8, 2023
@codecov
Copy link

codecov bot commented Sep 8, 2023

Codecov Report

Merging #938 (10977c8) into develop (9a55174) will decrease coverage by 0.02%.
Report is 3 commits behind head on develop.
The diff coverage is 19.29%.

@@             Coverage Diff             @@
##           develop     #938      +/-   ##
===========================================
- Coverage    50.47%   50.46%   -0.02%     
===========================================
  Files           95       96       +1     
  Lines         9953     9992      +39     
===========================================
+ Hits          5024     5042      +18     
- Misses        4523     4537      +14     
- Partials       406      413       +7     
Flag Coverage Δ
bridge-history-api 12.08% <0.00%> (-0.06%) ⬇️
common 54.56% <10.25%> (-0.01%) ⬇️
coordinator 18.94% <87.50%> (ø)
database 42.85% <ø> (ø)
rollup 66.77% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
bridge-history-api/utils/database.go 0.00% <0.00%> (ø)
common/types/response.go 0.00% <0.00%> (ø)
coordinator/cmd/app/app.go 12.50% <0.00%> (ø)
common/database/db.go 52.54% <33.33%> (+28.01%) ⬆️
coordinator/test/mock_prover.go 100.00% <100.00%> (ø)

0xmountaintop
0xmountaintop previously approved these changes Sep 8, 2023
colinlyguo
colinlyguo previously approved these changes Sep 8, 2023
bridge-history-api/internal/types/history_types.go Outdated Show resolved Hide resolved
common/types/response.go Outdated Show resolved Hide resolved
common/observability/ginmetrics/bloom.go Outdated Show resolved Hide resolved
coordinator/internal/controller/api/get_task.go Outdated Show resolved Hide resolved
Co-authored-by: Péter Garamvölgyi <peter@scroll.io>
colinlyguo
colinlyguo previously approved these changes Sep 11, 2023
@colinlyguo
Copy link
Member

colinlyguo commented Sep 11, 2023

CI has failed.

colinlyguo
colinlyguo previously approved these changes Sep 11, 2023
@mask-pp
Copy link
Contributor

mask-pp commented Sep 11, 2023

bloomFilter Is there a risk of being overwritten?

@mask-pp
Copy link
Contributor

mask-pp commented Sep 11, 2023

GetMonitor how about directly return a new Monitor instance? Although We know GetMonitor will just called once in one service.

@georgehao
Copy link
Member Author

bloomFilter Is there a risk of being overwritten?

Seems don't have this problem.

@georgehao georgehao merged commit 0730e91 into develop Sep 11, 2023
26 checks passed
@georgehao georgehao deleted the feat/add-api-ready branch September 11, 2023 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bump-version Bump the version tag for deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants