Skip to content

Commit

Permalink
docs: improve metrics descriptions
Browse files Browse the repository at this point in the history
Co-authored-by: Gus Eggert <gus@gus.dev>
  • Loading branch information
lidel and guseggert committed Mar 18, 2022
1 parent 5064c53 commit ae5de99
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions core/corehttp/gateway_handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -155,30 +155,30 @@ func newGatewayHandler(c GatewayConfig, api coreiface.CoreAPI) *gatewayHandler {
// UnixFS: time it takes to return a file
unixfsFileGetMetric: newGatewayHistogramMetric(
"gw_unixfs_file_get_duration_seconds",
"The time it takes till the entire file is served on GET from the gateway.",
"The time to serve an entire UnixFS file from the gateway.",
),
// UnixFS: time it takes to generate static HTML with directory listing
unixfsGenDirGetMetric: newGatewayHistogramMetric(
"gw_unixfs_gen_dir_listing_get_duration_seconds",
"The time it takes till generated HTML with directory listing is served on GET from the gateway.",
"The time to serve a generated UnixFS HTML directory listing from the gateway.",
),
// CAR: time it takes to return requested CAR stream
carStreamGetMetric: newGatewayHistogramMetric(
"gw_car_stream_get_duration_seconds",
"The time it takes to get entire CAR stream on GET from the gateway.",
"The time to GET an entire CAR stream from the gateway.",
),
// Block: time it takes to return requested Block
rawBlockGetMetric: newGatewayHistogramMetric(
"gw_raw_block_get_duration_seconds",
"The time it takes to get entire raw Block on GET from the gateway.",
"The time to GET an entire raw Block from the gateway.",
),

// Legacy Metrics
// ----------------------------
unixfsGetMetric: newGatewaySummaryMetric( // TODO: remove?
// (deprecated, use firstContentBlockGetMetric instead)
"unixfs_get_latency_seconds",
"The time till the first unixfs node is received on GET from the gateway.",
"The time to receive the first UnixFS node on a GET from the gateway.",
),
}
return i
Expand Down

0 comments on commit ae5de99

Please sign in to comment.