fsmetric

Documentation

Overview

Package fsmetric defines filesystem metrics.

Index

• Variables
• func FinishReadWait(m *metric.Uint64Metric, start time.Time)
• func StartReadWait() time.Time

Variables

var (
	Opens = metric.MustCreateNewUint64Metric("/fs/opens",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Number of file opens.",
		})
	Reads = metric.MustCreateNewUint64Metric("/fs/reads", metric.Uint64Metadata{
		Cumulative:  true,
		Description: "Number of file reads.",
	})
	ReadWait = metric.MustCreateNewUint64Metric("/fs/read_wait", metric.Uint64Metadata{
		Cumulative:  true,
		Description: "Time waiting on file reads, in nanoseconds.",
		Unit:        metricpb.MetricMetadata_UNITS_NANOSECONDS,
	})
)

Metrics that apply to all filesystems.

var (
	GoferOpens9P = metric.MustCreateNewUint64Metric("/gofer/opens_9p",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Number of times a file was opened from a gofer and did not have a host file descriptor.",
		})
	GoferOpensHost = metric.MustCreateNewUint64Metric("/gofer/opens_host",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Number of times a file was opened from a gofer and did have a host file descriptor.",
		})
	// TODO(b/354724938): Remove this metric when we no longer implement
	// this open-by-connecting behavior.
	GoferOpensByConnecting = metric.MustCreateNewUint64Metric("/gofer/opens_by_connecting",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Number of times a socket was opened via open syscall that is silently translated to connect",
		})
	GoferReads9P = metric.MustCreateNewUint64Metric("/gofer/reads_9p",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Number of 9P file reads from a gofer.",
		})
	GoferReadWait9P = metric.MustCreateNewUint64Metric("/gofer/read_wait_9p", metric.Uint64Metadata{
		Cumulative:  true,
		Description: "Time waiting on 9P file reads from a gofer, in nanoseconds.",
		Unit:        metricpb.MetricMetadata_UNITS_NANOSECONDS,
	})
	GoferReadsHost = metric.MustCreateNewUint64Metric("/gofer/reads_host",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Number of host file reads from a gofer.",
		})
	GoferReadWaitHost = metric.MustCreateNewUint64Metric("/gofer/read_wait_host",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Time waiting on host file reads from a gofer, in nanoseconds.",
			Unit:        metricpb.MetricMetadata_UNITS_NANOSECONDS,
		})
)

Metrics that only apply to fs/gofer and fsimpl/gofer.

var (
	TmpfsOpensRO = metric.MustCreateNewUint64Metric("/in_memory_file/opens_ro",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Number of times an in-memory file was opened in read-only mode.",
		})
	TmpfsOpensW = metric.MustCreateNewUint64Metric("/in_memory_file/opens_w",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Number of times an in-memory file was opened in write mode.",
		})
	TmpfsReads = metric.MustCreateNewUint64Metric("/in_memory_file/reads",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Number of in-memory file reads.",
		})
	TmpfsReadWait = metric.MustCreateNewUint64Metric("/in_memory_file/read_wait",
		metric.Uint64Metadata{
			Cumulative:  true,
			Description: "Time waiting on in-memory file reads, in nanoseconds.",
			Unit:        metricpb.MetricMetadata_UNITS_NANOSECONDS,
		})
)

Metrics that only apply to fs/tmpfs and fsimpl/tmpfs.

var RecordWaitTime = false

RecordWaitTime enables the ReadWait, GoferReadWait9P, GoferReadWaitHost, and TmpfsReadWait metrics. Enabling this comes at a CPU cost due to performing three clock reads per read call.

Note that this is only performed in the direct read path, and may not be consistently applied for other forms of reads, such as splice.

Functions

func FinishReadWait

func FinishReadWait(m *metric.Uint64Metric, start time.Time)

FinishReadWait indicates the end of a file read whose time is accounted by m. start must be the value returned by the corresponding call to StartReadWait.

FinishReadWait is marked nosplit for performance since it's often called from defer statements, which prevents it from being inlined (https://github.com/golang/go/issues/38471).

func StartReadWait

func StartReadWait() time.Time

StartReadWait indicates the beginning of a file read.