Deuxfleurs/garage
43
56
Fork 74
Code Issues 100 Pull requests 13 Releases 30 Wiki Activity

WIP: add metrics to the metadata engine #853

Draft
quentin wants to merge 8 commits from feat-metrics-metadata-engine into main
pull from: feat-metrics-metadata-engine
merge into: Deuxfleurs:main
Conversation 0 Commits 8 Files changed 9 +269 -9
quentin commented 2024-08-14 20:22:19 +00:00
Owner
Copy link

To debug #851

To test: in garage.toml, change db_engine to lmdb-with-metrics.

Roadmap:

  • Add counters and histogram gauges on metadata engine ops
  • Do not hardcode Lmdb, instead be generic to be compatible with all metadata engine
  • Maybe add an option to export metrics as JSON (it will make benchmarks results easier to collect)

Example (only counters, after uploading my blog in a bucket on a raw one node cluster):

db_op_counter{cat="control",op="open_tree",tx="no"} 62
db_op_counter{cat="control",op="transaction",tx="yes"} 4337
db_op_counter{cat="data",op="get",tx="no"} 912
db_op_counter{cat="data",op="get",tx="yes"} 6373
db_op_counter{cat="data",op="insert",tx="no"} 234
db_op_counter{cat="data",op="insert",tx="yes"} 6190
db_op_counter{cat="data",op="iter",tx="no"} 3222
db_op_counter{cat="data",op="len",tx="no"} 4139
db_op_counter{cat="data",op="range",tx="no"} 2053
db_op_counter{cat="data",op="remove",tx="yes"} 1501

(The full output including the histograms is attached to this issue)

To debug #851 To test: in `garage.toml`, change `db_engine` to `lmdb-with-metrics`. --- Roadmap: - [X] Add counters and histogram gauges on metadata engine ops - [ ] Do not hardcode Lmdb, instead be generic to be compatible with all metadata engine - [ ] Maybe add an option to export metrics as JSON (it will make benchmarks results easier to collect) --- Example (only counters, after uploading my blog in a bucket on a raw one node cluster): ``` db_op_counter{cat="control",op="open_tree",tx="no"} 62 db_op_counter{cat="control",op="transaction",tx="yes"} 4337 db_op_counter{cat="data",op="get",tx="no"} 912 db_op_counter{cat="data",op="get",tx="yes"} 6373 db_op_counter{cat="data",op="insert",tx="no"} 234 db_op_counter{cat="data",op="insert",tx="yes"} 6190 db_op_counter{cat="data",op="iter",tx="no"} 3222 db_op_counter{cat="data",op="len",tx="no"} 4139 db_op_counter{cat="data",op="range",tx="no"} 2053 db_op_counter{cat="data",op="remove",tx="yes"} 1501 ``` (The full output including the histograms is attached to this issue)
metrics.log
114 KiB
quentin added 1 commit 2024-08-14 20:22:19 +00:00
add proxy to instrument LmdbDB with otel
Some checks failed
ci/woodpecker/push/debug Pipeline failed
Details
ci/woodpecker/pr/debug Pipeline failed
Details
efc87a8b8e
quentin added 1 commit 2024-08-14 21:13:58 +00:00
proxy finalized, use it by setting 'lmdb-with-metrics'
Some checks failed
ci/woodpecker/push/debug Pipeline failed
Details
ci/woodpecker/pr/debug Pipeline failed
Details
56de00945f
quentin added 1 commit 2024-08-15 07:10:52 +00:00
fix cargo.nix
All checks were successful
ci/woodpecker/push/debug Pipeline was successful
Details
ci/woodpecker/pr/debug Pipeline was successful
Details
9d01a9870c
quentin added 1 commit 2024-08-15 12:32:24 +00:00
switch from sec to us
All checks were successful
ci/woodpecker/push/debug Pipeline was successful
Details
ci/woodpecker/pr/debug Pipeline was successful
Details
1685d83c04
quentin added 1 commit 2024-08-15 13:31:09 +00:00
switch from micros to millis
All checks were successful
ci/woodpecker/push/debug Pipeline was successful
Details
ci/woodpecker/pr/debug Pipeline was successful
Details
2d439c388c
quentin added 1 commit 2024-08-15 13:43:34 +00:00
switch to ms, simplify collected metrics
All checks were successful
ci/woodpecker/push/debug Pipeline was successful
Details
ci/woodpecker/pr/debug Pipeline was successful
Details
14163b5853
quentin added 2 commits 2024-08-17 11:17:31 +00:00
force flag "no read ahead" on LMDB
All checks were successful
ci/woodpecker/push/debug Pipeline was successful
Details
ci/woodpecker/pr/debug Pipeline was successful
Details
1ebaf7aa17
All checks were successful
ci/woodpecker/push/debug Pipeline was successful
Details
ci/woodpecker/pr/debug Pipeline was successful
Required
Details
This pull request has changes conflicting with the target branch.
  • Cargo.nix
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin feat-metrics-metadata-engine:feat-metrics-metadata-engine
git checkout feat-metrics-metadata-engine
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
action
check-aws
The behaviour should be checked against AWS S3

  
action
discussion-needed
We need to discuss if the feature is desirable and/or better specify the envisioned behavior or technical implementation

  
action
for-external-contributors
Core team does not plan working on this in the near future however an external contribution will be reviewed & merged

  
action
for-newcomers
An issue that should be newcomer friendly.

  
action
more-info-needed
More information is needed to investigate this issue

  
action
need-funding
This issue represents lots of work, we need to find money to pay our core team work

  
action
triage-required
It's not very clear what we want to do with this issue yet, more thoughts is required

  
kind
correctness
Issues of theoretical correctness that may impact edge-case scenarios

  
kind
ideas
For abstract ideas/proposal to make Garage better, to better communicate our not yet achieved aims

  
kind
improvement
Feature requests that do not fall in other categories

  
kind
performance
Deceptive performance observed OR idea to improve performances

  
kind
testing
Functional tests, integration tests, Jepsen, etc.

  
kind
usability
Propositions to make Garage easier to operate, by improving error reporting, CLI, etc.

  
kind
wrong-behavior
Unintended behavior

  
prio
critical
Could impact integrity or availability of production clusters

  
prio
low
For issues that we don't want to spend time on until made absolutely necessary

  
scope
admin-api
Issues concerning the administration API

  
scope
background-healing
Background healing covers repair tasks, anti-entropy, merkle trees, etc. ; everything related to replicating data appropriately.

  
scope
build
Issues with Nix, Drone, Rust Compiler, etc.

  
scope
documentation

  
scope
k8s
Kubernetes related, including Helm Charts

  
scope
layout
Linked to the cluster layout and storage management

  
scope
metadata
Metadata Engine (LMDB, sqlite, etc.)

  
scope
ops
Operations related to operations/maintenance issue, tooling related (like CLI missing info ; impossible, too dangerous, too complicated migration, etc.)

  
scope
rpc
Linked to RPC

  
scope
s3-api
Related to the S3 API (especially compatibility issues).

  
scope
security
Cryptography-related, auth-related, authorization-related issues

  
scope
telemetry
OpenTelemetry (traces, metrics, etc.)

No labels
action
check-aws
action
discussion-needed
action
for-external-contributors
action
for-newcomers
action
more-info-needed
action
need-funding
action
triage-required
kind
correctness
kind
ideas
kind
improvement
kind
performance
kind
testing
kind
usability
kind
wrong-behavior
prio
critical
prio
low
scope
admin-api
scope
background-healing
scope
build
scope
documentation
scope
k8s
scope
layout
scope
metadata
scope
ops
scope
rpc
scope
s3-api
scope
security
scope
telemetry
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Deuxfleurs/garage#853
No description provided.
Delete branch "feat-metrics-metadata-engine"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?