Skip to content

Commit f4e9df4

Browse files
MichaelCuevasfacebook-github-bot
authored andcommitted
stats: add new counters to existing docs
Summary: # Context I added new stats in D58492412, so now I have to document them. I've updated the wiki, but I still need to update the markdown docs stored in the repo. # This diff Updates the stats docs to match reality. Reviewed By: fanzeyi Differential Revision: D59932131 fbshipit-source-id: fe17c2ee986e182d00d35121827346e5c210ba1a
1 parent 503737d commit f4e9df4

File tree

2 files changed

+25
-19
lines changed

2 files changed

+25
-19
lines changed

eden/fs/docs/stats/ObjectStoreStats.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,37 @@
22

33
1. `Duration get{xxx}{"store.get_{xxx}_us"}` :
44

5-
The whole duration of get{xxx} xxx (blob, blobmetadata, tree) in ObjectStore.
6-
Consider that ObjectStore can get Object from memory (MemoryCache), LocalStore
7-
(OndiskCache), or BackingStore
5+
The whole duration of get{xxx} xxx (blob, blobmetadata, tree, treemetadata) in
6+
ObjectStore. Consider that ObjectStore can get Object from memory (MemoryCache),
7+
LocalStore (OndiskCache), or BackingStore
88

99
2. `Counter get{xxx}FromMemory{"object_store.get_{xxx}.memory"}` :
1010

11-
Count the number of xxx (blob, blobmetadata, tree) that are successfully
12-
obtained from MemoryCache. It doesn’t check the local store either.
11+
Count the number of xxx (blob, blobmetadata, tree, treemetadata) that are
12+
successfully obtained from MemoryCache. It doesn’t check the local store either.
1313

1414
3. `Counter get{xxx}FromLocalStore{"object_store.get_{xxx}.local_store"}` :
1515

1616
Count the number of xxx (blob, blobmetadata, tree) that are successfully
17-
obtained from LocalStore (OnDiskCache). It doesn’t hit the BackingStore.
17+
obtained from LocalStore (OnDiskCache). It doesn’t hit the BackingStore. Note:
18+
TreeMetadata is not stored in the local store, so the tree_metadata counter
19+
doesn't exist.
1820

1921
4. `Counter get{xxx}FromBackingStore{"object_store.get_{xxx}.backing_store"}` :
2022

21-
Count the number of xxx (blob, blobmetadata, tree) that are obtained from
22-
BackingStore.
23+
Count the number of xxx (blob, blobmetadata, tree, treemetadata) that are
24+
obtained from BackingStore.
2325

2426
5. `Counter get{xxx}Failed{"object_store.get_{xxx}_failed"}` :
2527

26-
Count the number of xxx (blob, blobmetadata, tree) cannot be fetched.
28+
Count the number of xxx (blob, blobmetadata, tree, treemetadata) cannot be
29+
fetched.
2730

2831
6. `Counter getBlobMetadataFromBlob{"object_store.get_blob_metadata.blob"}` :
2932

3033
Count the number of BlobMetadata that cannot be obtained from BackingStore, but
31-
we obtained Blob and from Blob we found the BlobMetadata.
34+
we obtained Blob and from Blob we found the BlobMetadata. Note: TreeMetadata
35+
cannot be computed locally, so the tree version of this counter does not exist.
3236

3337
7. `Duration getRootTree{"store.get_root_tree_us"}` :
3438

eden/fs/docs/stats/SaplingBackingStoreStats.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
1. `Duration get{xxx}{"store.sapling.get_{xxx}_us"}` :
44

5-
Duration of the whole get xxx (blob, blobmetadata, tree)
5+
Duration of the whole get xxx (blob, blobmetadata, tree, treemetadata)
66
SaplingBackingStore::get{xxx} in Microsecond. This includes looking in local
77
first then if not found prepare the request, enqueue the request and then mark
88
it as finished when it is fulfilled.
99

1010
2. `Duration fetch{xxx}{"store.sapling.fetch_{xxx}_us"}` :
1111

12-
Duration of fetching xxx (blob, blobmetadata, tree) requests from the network in
13-
Microsecond.
12+
Duration of fetching xxx (blob, blobmetadata, tree, treemetadata) requests from
13+
the network in Microsecond.
1414

1515
3. `Duration getRootTree{"store.sapling.get_root_tree_us"}` :
1616

@@ -23,21 +23,23 @@ Duration of getting a manifest for Root from the Backing Store in Microsecond.
2323

2424
5. `Counter fetch{xxx}Local{"store.sapling.fetch_{xxx}_local"}` :
2525

26-
Number of xxx (blob, blobmetadata, tree) fetching locally from hgcache
26+
Number of xxx (blob, blobmetadata, tree, treemetadata) fetching locally from
27+
hgcache
2728

2829
6. `Counter fetch{xxx}Remote{"store.sapling.fetch_{xxx}_remote"}` :
2930

30-
Number of xxx (blob, blobmetadata, tree) fetching remotely from the network
31-
(EdenAPI)
31+
Number of xxx (blob, blobmetadata, tree, treemetadata) fetching remotely from
32+
the network (EdenAPI)
3233

3334
7. `Counter fetch{xxx}Success{"store.sapling.fetch_{xxx}_success"}` :
3435

35-
Number of xxx (blob, blobmetadata, tree) that fetch successfully in the first
36-
try. (It could be local or remote)
36+
Number of xxx (blob, blobmetadata, tree, treemetadata) that fetch successfully
37+
in the first try. (It could be local or remote)
3738

3839
8. `Counter fetch{xxx}Failure{"store.sapling.fetch_{xxx}_failure"}` :
3940

40-
Number of xxx (blob, blobmetadata, tree) that failed in the first fetch try.
41+
Number of xxx (blob, blobmetadata, tree, treemetadata) that failed in the first
42+
fetch try.
4143

4244
9. `Counter fetch{xxx}RetrySuccess{"store.sapling.fetch_{xxx}_retry_success"}` :
4345

0 commit comments

Comments
 (0)