mirror of
https://github.com/go-gitea/gitea
synced 2024-11-17 23:54:25 +00:00
12a1f914f4
* update github.com/alecthomas/chroma v0.8.0 -> v0.8.1 * github.com/blevesearch/bleve v1.0.10 -> v1.0.12 * editorconfig-core-go v2.1.1 -> v2.3.7 * github.com/gliderlabs/ssh v0.2.2 -> v0.3.1 * migrate editorconfig.ParseBytes to Parse * github.com/shurcooL/vfsgen to 0d455de96546 * github.com/go-git/go-git/v5 v5.1.0 -> v5.2.0 * github.com/google/uuid v1.1.1 -> v1.1.2 * github.com/huandu/xstrings v1.3.0 -> v1.3.2 * github.com/klauspost/compress v1.10.11 -> v1.11.1 * github.com/markbates/goth v1.61.2 -> v1.65.0 * github.com/mattn/go-sqlite3 v1.14.0 -> v1.14.4 * github.com/mholt/archiver v3.3.0 -> v3.3.2 * github.com/microcosm-cc/bluemonday 4f7140c49acb -> v1.0.4 * github.com/minio/minio-go v7.0.4 -> v7.0.5 * github.com/olivere/elastic v7.0.9 -> v7.0.20 * github.com/urfave/cli v1.20.0 -> v1.22.4 * github.com/prometheus/client_golang v1.1.0 -> v1.8.0 * github.com/xanzy/go-gitlab v0.37.0 -> v0.38.1 * mvdan.cc/xurls v2.1.0 -> v2.2.0 Co-authored-by: Lauris BH <lauris@nix.lv>
62 lines
2.7 KiB
Markdown
Vendored
62 lines
2.7 KiB
Markdown
Vendored
# procfs
|
|
|
|
This package provides functions to retrieve system, kernel, and process
|
|
metrics from the pseudo-filesystems /proc and /sys.
|
|
|
|
*WARNING*: This package is a work in progress. Its API may still break in
|
|
backwards-incompatible ways without warnings. Use it at your own risk.
|
|
|
|
[](https://godoc.org/github.com/prometheus/procfs)
|
|
[](https://travis-ci.org/prometheus/procfs)
|
|
[](https://goreportcard.com/report/github.com/prometheus/procfs)
|
|
|
|
## Usage
|
|
|
|
The procfs library is organized by packages based on whether the gathered data is coming from
|
|
/proc, /sys, or both. Each package contains an `FS` type which represents the path to either /proc,
|
|
/sys, or both. For example, cpu statistics are gathered from
|
|
`/proc/stat` and are available via the root procfs package. First, the proc filesystem mount
|
|
point is initialized, and then the stat information is read.
|
|
|
|
```go
|
|
fs, err := procfs.NewFS("/proc")
|
|
stats, err := fs.Stat()
|
|
```
|
|
|
|
Some sub-packages such as `blockdevice`, require access to both the proc and sys filesystems.
|
|
|
|
```go
|
|
fs, err := blockdevice.NewFS("/proc", "/sys")
|
|
stats, err := fs.ProcDiskstats()
|
|
```
|
|
|
|
## Package Organization
|
|
|
|
The packages in this project are organized according to (1) whether the data comes from the `/proc` or
|
|
`/sys` filesystem and (2) the type of information being retrieved. For example, most process information
|
|
can be gathered from the functions in the root `procfs` package. Information about block devices such as disk drives
|
|
is available in the `blockdevices` sub-package.
|
|
|
|
## Building and Testing
|
|
|
|
The procfs library is intended to be built as part of another application, so there are no distributable binaries.
|
|
However, most of the API includes unit tests which can be run with `make test`.
|
|
|
|
### Updating Test Fixtures
|
|
|
|
The procfs library includes a set of test fixtures which include many example files from
|
|
the `/proc` and `/sys` filesystems. These fixtures are included as a [ttar](https://github.com/ideaship/ttar) file
|
|
which is extracted automatically during testing. To add/update the test fixtures, first
|
|
ensure the `fixtures` directory is up to date by removing the existing directory and then
|
|
extracting the ttar file using `make fixtures/.unpacked` or just `make test`.
|
|
|
|
```bash
|
|
rm -rf fixtures
|
|
make test
|
|
```
|
|
|
|
Next, make the required changes to the extracted files in the `fixtures` directory. When
|
|
the changes are complete, run `make update_fixtures` to create a new `fixtures.ttar` file
|
|
based on the updated `fixtures` directory. And finally, verify the changes using
|
|
`git diff fixtures.ttar`.
|