fs.go 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  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. package procfs
  14. import (
  15. "github.com/prometheus/procfs/internal/fs"
  16. )
  17. // FS represents the pseudo-filesystem sys, which provides an interface to
  18. // kernel data structures.
  19. type FS struct {
  20. proc fs.FS
  21. }
  22. // DefaultMountPoint is the common mount point of the proc filesystem.
  23. const DefaultMountPoint = fs.DefaultProcMountPoint
  24. // NewDefaultFS returns a new proc FS mounted under the default proc mountPoint.
  25. // It will error if the mount point directory can't be read or is a file.
  26. func NewDefaultFS() (FS, error) {
  27. return NewFS(DefaultMountPoint)
  28. }
  29. // NewFS returns a new proc FS mounted under the given proc mountPoint. It will error
  30. // if the mount point directory can't be read or is a file.
  31. func NewFS(mountPoint string) (FS, error) {
  32. fs, err := fs.NewFS(mountPoint)
  33. if err != nil {
  34. return FS{}, err
  35. }
  36. return FS{fs}, nil
  37. }