khenaidoo | ab1f7bd | 2019-11-14 14:00:27 -0500 | [diff] [blame] | 1 | // Copyright 2018 The Prometheus Authors |
| 2 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 3 | // you may not use this file except in compliance with the License. |
| 4 | // You may obtain a copy of the License at |
| 5 | // |
| 6 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 7 | // |
| 8 | // Unless required by applicable law or agreed to in writing, software |
| 9 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 10 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 11 | // See the License for the specific language governing permissions and |
| 12 | // limitations under the License. |
| 13 | |
| 14 | package procfs |
| 15 | |
| 16 | import ( |
| 17 | "github.com/prometheus/procfs/internal/fs" |
| 18 | ) |
| 19 | |
| 20 | // FS represents the pseudo-filesystem sys, which provides an interface to |
| 21 | // kernel data structures. |
| 22 | type FS struct { |
| 23 | proc fs.FS |
| 24 | } |
| 25 | |
| 26 | // DefaultMountPoint is the common mount point of the proc filesystem. |
| 27 | const DefaultMountPoint = fs.DefaultProcMountPoint |
| 28 | |
| 29 | // NewDefaultFS returns a new proc FS mounted under the default proc mountPoint. |
| 30 | // It will error if the mount point directory can't be read or is a file. |
| 31 | func NewDefaultFS() (FS, error) { |
| 32 | return NewFS(DefaultMountPoint) |
| 33 | } |
| 34 | |
| 35 | // NewFS returns a new proc FS mounted under the given proc mountPoint. It will error |
| 36 | // if the mount point directory can't be read or is a file. |
| 37 | func NewFS(mountPoint string) (FS, error) { |
| 38 | fs, err := fs.NewFS(mountPoint) |
| 39 | if err != nil { |
| 40 | return FS{}, err |
| 41 | } |
| 42 | return FS{fs}, nil |
| 43 | } |