doc.go 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. // Copyright 2014 Prometheus Team
  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 provides functions to retrieve system, kernel and process
  14. // metrics from the pseudo-filesystem proc.
  15. //
  16. // Example:
  17. //
  18. // package main
  19. //
  20. // import (
  21. // "fmt"
  22. // "log"
  23. //
  24. // "github.com/prometheus/procfs"
  25. // )
  26. //
  27. // func main() {
  28. // p, err := procfs.Self()
  29. // if err != nil {
  30. // log.Fatalf("could not get process: %s", err)
  31. // }
  32. //
  33. // stat, err := p.NewStat()
  34. // if err != nil {
  35. // log.Fatalf("could not get process stat: %s", err)
  36. // }
  37. //
  38. // fmt.Printf("command: %s\n", stat.Comm)
  39. // fmt.Printf("cpu time: %fs\n", stat.CPUTime())
  40. // fmt.Printf("vsize: %dB\n", stat.VirtualMemory())
  41. // fmt.Printf("rss: %dB\n", stat.ResidentMemory())
  42. // }
  43. //
  44. package procfs