diff options
author | Antoine GIRARD <sapk@users.noreply.github.com> | 2019-08-28 08:55:22 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-08-28 08:55:22 +0200 |
commit | 256b1781760beb08ae4bdde3c2750ea21c9c8fc6 (patch) | |
tree | 3ceb7ed14cdab8a1b8fbf169bebce1478af79522 /vendor/github.com/prometheus/procfs/README.md | |
parent | e0f95d1545eaf9cc4ebae9df1ff03d3e66d5b251 (diff) | |
download | gitea-256b1781760beb08ae4bdde3c2750ea21c9c8fc6.tar.gz gitea-256b1781760beb08ae4bdde3c2750ea21c9c8fc6.zip |
Update swagger to 0.20.1 (#8010)
* update swagger to 0.20.1
* fiw swagger version for validate
Diffstat (limited to 'vendor/github.com/prometheus/procfs/README.md')
-rw-r--r-- | vendor/github.com/prometheus/procfs/README.md | 44 |
1 files changed, 43 insertions, 1 deletions
diff --git a/vendor/github.com/prometheus/procfs/README.md b/vendor/github.com/prometheus/procfs/README.md index 2095494719..6f8850feb6 100644 --- a/vendor/github.com/prometheus/procfs/README.md +++ b/vendor/github.com/prometheus/procfs/README.md @@ -1,7 +1,7 @@ # procfs This procfs package provides functions to retrieve system, kernel and process -metrics from the pseudo-filesystem proc. +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. @@ -9,3 +9,45 @@ backwards-incompatible ways without warnings. Use it at your own risk. [![GoDoc](https://godoc.org/github.com/prometheus/procfs?status.png)](https://godoc.org/github.com/prometheus/procfs) [![Build Status](https://travis-ci.org/prometheus/procfs.svg?branch=master)](https://travis-ci.org/prometheus/procfs) [![Go Report Card](https://goreportcard.com/badge/github.com/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, current 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() +``` + +## Building and Testing + +The procfs library is normally built as part of another application. However, when making +changes to the library, the `make test` command can be used to run the API test suite. + +### 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`. |