File

Note: Sysdig follows the Prometheus-compabtible naming convention for both metrics and labels as opposed to the previous statsd-compatible, legacy Sysdig naming convention. However, this page still shows metrics in the legacy Sysdig naming convention. Until this page is updated, see Metrics and Label Mapping for the mapping between Sysdig legacy and Prometheus naming conventions.

file.bytes.in

The number of bytes read from the file. By default, this metric displays the total value for the defined scope. For example, if the scope is set to a group of machines, the metric value will be the total value for the whole group.

MetadataDescription
Metric TypeCounter
Value TypeByte
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationRate
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationSum
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.bytes.out

The number of bytes written to the file. By default, this metric displays the total value for the defined scope. For example, if the scope is set to a group of machines, the metric value will be the total value for the whole group.

MetadataDescription
Metric TypeCounter
Value TypeByte
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationRate
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationSum
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.bytes.total

The total number of bytes written to, and read from, the file. By default, this metric displays the total value for the defined scope. For example, if the scope is set to a group of machines, the metric value will be the total value for the whole group.

MetadataDescription
Metric TypeCounter
Value TypeByte
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationRate
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationSum
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.error.open.count

The number of errors that occurred when opening files. By default, this metric displays the total value for the defined scope. For example, if the scope is set to a group of machines, the metric value will be the total value for the whole group.

MetadataDescription
Metric TypeCounter
Value TypeInteger
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationRate
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationSum
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.error.total.count

The number of errors encountered by file system calls, such as open(), close(), and create(). By default, this metric displays the total value for the defined scope. For example, if the scope is defined as a group of machines, the metric value will be the total value for the whole group.

MetadataDescription
Metric TypeCounter
Value TypeInteger
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationRate
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationSum
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.iops.in

The number of file read operations per second. This metric is calculated by measuring the actual number of read requests made by a process. By default, this metric displays the total value for the defined scope. For example, if the scope is set to a group of machines, the metric value will be the total value for the whole group.

The value of file.iops.in can differ from the value other tools show, as they are usually based on interpolating this value from the number of bytes read and written to the file system.

MetadataDescription
Metric TypeCounter
Value TypeInteger
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationRate
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationSum
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.iops.out

The number of file write operations per second. This metric is calculated by measuring the actual number of write requests made by a process. By default, this metric displays the total value for the defined scope. For example, if the scope is set to a group of machines, the metric value will be the total value for the whole group.

The value of file.iops.out can differ from the value other tools show, as they are usually based on interpolating this value from the number of bytes read and written to the file system.

MetadataDescription
Metric TypeCounter
Value TypeInteger
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationRate
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationSum
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.iops.total

The number of file read and write operations per second. This metric is calculated by measuring the actual number of read/write requests made by a process. By default, this metric displays the total value for the defined scope. For example, if the scope is set to a group of machines, the metric value will be the total value for the whole group.

The value of file.iops.total can differ from the value other tools show, as they are usually based on interpolating this value from the number of bytes read and written to the file system.

MetadataDescription
Metric TypeCounter
Value TypeInteger
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationRate
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationSum
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.name

The name of the file.

MetadataDescription
Metric TypeGauge
Value TypeString
Segment ByHost
Default Time AggregationN/A
Available Time Aggregation FormatsN/A
Default Group AggregationN/A
Available Group Aggregation FormatsN/A

file.open.count

When segmenting by file name, the metric represents the rate of open events for a particular file With other segmentations, it represents the number of all files currently open in a particular context (host, container, process, etc.).

MetadataDescription
Metric TypeCounter
Value TypeInteger
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationRate
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationSum
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.time.in

The time spent reading the file. By default, this metric displays the total value for the defined scope. For example, if the scope is set to a group of machines, the metric value will be the total value for the whole group.

MetadataDescription
Metric TypeCounter
Value TyperelativeTime
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationAverage
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationAverage
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.time.out

The time spent writing in the file. By default, this metric displays the total value for the defined scope. For example, if the scope is set to a group of machines, the metric value will be the total value for the whole group.

MetadataDescription
Metric TypeCounter
Value TyperelativeTime
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationAverage
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationAverage
Available Group Aggregation FormatsAvg, Sum, Min, Max

file.time.total

The time spent during file I/O. By default, this metric displays the total value for the defined scope. For example, if the scope is set to a group of machines, the metric value will be the total value for the whole group.

MetadataDescription
Metric TypeCounter
Value TyperelativeTime
Segment ByHost, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider
Default Time AggregationAverage
Available Time Aggregation FormatsAvg, Rate, Sum, Min, Max
Default Group AggregationAverage
Available Group Aggregation FormatsAvg, Sum, Min, Max