ps

README

go-ps

go-ps is process library for find, list, and get information from process. go-ps read information about process from /proc file.

Documentation

see pkg.go.dev

Installation

$ go get github.com/nothinux/go-ps

Getting Started

Get All Running Process Name

package main

import (
    "log"
    "fmt"
    "github.com/nothinux/go-ps"
)

func main() {
    process, err := ps.GetProcess()
    if err != nil {
        log.Fatal(err)
    }

    for _, p := range process {
        fmt.Println(p.Comm)
    }
}

Find Pid from Process Name

package main

import (
    "log"
    "github.com/nothinux/go-ps"
    "fmt"
)

func main() {
    pid, err := ps.FindPid("nginx")
    if err != nil {
        log.Fatal(err)
    }

    fmt.Println(pid)
}

Find Process then get information from that process

package main


import (
    "log"
    "github.com/nothinux/go-ps"
    "fmt"
)

func main() {
    p, err := ps.FindProcessName("nginx")
    if err != nil {
        log.Fatal(err)
    }

    fmt.Println("process id:", p.Pid)
    fmt.Println("process name:", p.Comm)
    fmt.Println("process cmd:", p.CmdLine)
    fmt.Println("process state:", p.State)

}

more

LICENSE

MIT

Documentation

Index

• Variables
• func FindPGid(name string) (int, error)
• func FindPid(name string) (int, error)
• func FindPpid(name string) (int, error)
• func GetPidState(pid int) (string, error)
• func GetPids() ([]int, error)
• func PidIsExists(pid int) (bool, error)
• func ProcessIsExists(name string) (bool, error)
• func StateToString(state string) string
• type Process
  • func FindProcess(pid int) (Process, error)
  • func FindProcessName(name string) (Process, error)
  • func FindProcessNameContains(name string) ([]Process, error)
  • func GetProcess() ([]Process, error)

Variables

var (
	ErrNoProcess = errors.New("no process with provided name found")
)

Functions

func FindPGid

func FindPGid(name string) (int, error)

FindPGid returns process group id from given process name

func FindPid

func FindPid(name string) (int, error)

FindPid returns process id from given process name

func FindPpid

func FindPpid(name string) (int, error)

FindPpid returns parent process id from given process name

func GetPidState

func GetPidState(pid int) (string, error)

GetPidState returns state for given process id

func GetPids

func GetPids() ([]int, error)

GetPids returns a slice of process ID

func PidIsExists

func PidIsExists(pid int) (bool, error)

ProcessIsExists return true if given pid is exists

func ProcessIsExists

func ProcessIsExists(name string) (bool, error)

ProcessIsExists return true if given process name is exists

func StateToString

func StateToString(state string) string

StateToString returns state representation for given state

Types

type Process

type Process struct {
	// The process id
	Pid int
	// The executable filename of running process
	Comm string
	// Full command line of running process
	CmdLine string
	// state of this process
	State string
	// The parent process id from this process
	Ppid int
	//  The process group id from this process
	Pgrp int
	// The User id and group id who running process
	UID, GID int
}

Process contains information about running process

func FindProcess

func FindProcess(pid int) (Process, error)

FindProcess returns Process struct from given process id

func FindProcessName

func FindProcessName(name string) (Process, error)

FindProcessName returns Process based on finding, it will be match if given process name same with executable filename

func FindProcessNameContains

func FindProcessNameContains(name string) ([]Process, error)

FindProcessNameContains returns slice of Process based on finding, it will returns process containing name. Using this is not very accurate, if you want to search process based on executable file name, use FindProcessName instead

func GetProcess

func GetProcess() ([]Process, error)

GetProcess returns all process information pid, comm, ppid, pgrp