Instrument Storage Layer #9958
Merged
Instrument Storage Layer #9958
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
jrockway
approved these changes
Apr 18, 2024
| @@ -14,8 +16,10 @@ type Renewer struct { | |||
| } | |||
|
|
|||
| func NewRenewer(ctx context.Context, tr track.Tracker, name string, ttl time.Duration) *Renewer { | |||
| ctx = pctx.Child(ctx, "trackerRenewer", pctx.WithCounter("renewals", 0)) | |||
There was a problem hiding this comment.
You only need a WithCounter in the context if you want to do aggregation. If you're OK logging at every call to Inc, then you don't need to bother with this. (With no options, the value will be written to the logs at most every 10 seconds.)
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #9958 +/- ##
=======================================
Coverage 58.21% 58.22%
=======================================
Files 614 614
Lines 75461 75527 +66
=======================================
+ Hits 43931 43976 +45
- Misses 30978 30998 +20
- Partials 552 553 +1 ☔ View full report in Codecov by Sentry. |
jrockway
pushed a commit
that referenced
this pull request
Apr 29, 2024
This is a first pass at instrumenting the storage layer. There's a few
high level changes you'll generally see throughout this PR:
1. Child contexts have been passed throughout. Particular areas of focus
are distributed systems like the task service and low level constructs
like file set, index, and chunk readers & writers.
2. Metrics have been added. The metrics vary based on what is relevant,
but generally we're reporting bytes read/written as well as indicators
like cache misses vs cache hits, indices skipped vs indices read, and so
forth.
I'm sure I've missed areas that we want to instrument, but that's fine.
We can add those in a follow up PR.
Metrics are visible when running at a 'debug' level.
Here are some snippets of metrics:
```json
{
"severity": "debug",
"time": "2024-04-18T19:30:24.935036734Z",
"logger": "grpc.pfs_v2.API/ModifyFile.fileSetWriter.indexWriter(deletive-index-writer)",
"caller": "index/writer.go:85",
"message": "meter: bytes",
"service": "pfs_v2.API",
"method": "ModifyFile",
"command": [
"pachctl put file images@master -f liberty.jpg"
],
"peer": "127.0.0.1:48528",
"type": "int",
"delta": 35,
"meter": "bytes"
}
{
"severity": "debug",
"time": "2024-04-18T19:30:24.935196695Z",
"logger": "grpc.pfs_v2.API/ModifyFile.fileSetWriter.batcher(chunk-batcher).taskChain.upload",
"caller": "chunk/uploader.go:186",
"message": "meter: tx_bytes",
"service": "pfs_v2.API",
"method": "ModifyFile",
"command": [
"pachctl put file images@master -f liberty.jpg"
],
"peer": "127.0.0.1:48528",
"type": "int",
"delta": 133858,
"meter": "tx_bytes"
}
{
"severity": "debug",
"time": "2024-04-18T19:30:24.954077375Z",
"logger": "grpc.pfs_v2.API/ModifyFile.fileSetWriter.indexWriter(additive-batched-index-writer)",
"caller": "index/writer.go:85",
"message": "meter: bytes",
"service": "pfs_v2.API",
"method": "ModifyFile",
"command": [
"pachctl put file images@master -f liberty.jpg"
],
"peer": "127.0.0.1:48528",
"type": "int",
"delta": 155,
"meter": "bytes"
}
```
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.
This is a first pass at instrumenting the storage layer. There's a few high level changes you'll generally see throughout this PR:
I'm sure I've missed areas that we want to instrument, but that's fine. We can add those in a follow up PR.
Metrics are visible when running at a 'debug' level.
Here are some snippets of metrics:
{ "severity": "debug", "time": "2024-04-18T19:30:24.935036734Z", "logger": "grpc.pfs_v2.API/ModifyFile.fileSetWriter.indexWriter(deletive-index-writer)", "caller": "index/writer.go:85", "message": "meter: bytes", "service": "pfs_v2.API", "method": "ModifyFile", "command": [ "pachctl put file images@master -f liberty.jpg" ], "peer": "127.0.0.1:48528", "type": "int", "delta": 35, "meter": "bytes" } { "severity": "debug", "time": "2024-04-18T19:30:24.935196695Z", "logger": "grpc.pfs_v2.API/ModifyFile.fileSetWriter.batcher(chunk-batcher).taskChain.upload", "caller": "chunk/uploader.go:186", "message": "meter: tx_bytes", "service": "pfs_v2.API", "method": "ModifyFile", "command": [ "pachctl put file images@master -f liberty.jpg" ], "peer": "127.0.0.1:48528", "type": "int", "delta": 133858, "meter": "tx_bytes" } { "severity": "debug", "time": "2024-04-18T19:30:24.954077375Z", "logger": "grpc.pfs_v2.API/ModifyFile.fileSetWriter.indexWriter(additive-batched-index-writer)", "caller": "index/writer.go:85", "message": "meter: bytes", "service": "pfs_v2.API", "method": "ModifyFile", "command": [ "pachctl put file images@master -f liberty.jpg" ], "peer": "127.0.0.1:48528", "type": "int", "delta": 155, "meter": "bytes" }