Proctor
A toolkit enabling deep introspection of various aspects of software, from
source code to runtime. Proctor contains the libraries used in Arctir's platform
services. Atop these libraries is a CLI that acts as a client enabling users to
easily try-out and leverage the power of these introspection tools.
Proctor may be particularly helpful to a developer, SRE, or devops humans
wishing to quickly introspect aspects of their software and stacks. For a
quickstart and few examples, see our examples docs.
Our intent with proctor is to share libraries with the open source community,
help folks build other introspection-oriented tooling atop, and get feedback on
our ideas and approaches.
Install
As a CLI
At this time, there is no official package manager support for proctor and you
need to compile from source (using go install
). To install proctor with the go
tool, run:
go install github.com/arctir/proctor/proctor@latest
This will place the proctor binary, for your target architecture, in $GOBIN
.
If desired, move proctor to your $PATH
.
As a library
Within the pkg
directory are multiple libraries. To use these libraries in
your own Go project(s), you can import them via go mod. For example, here's how
you could import plib, our process library responsible for introspection of
various operating-system's execution abstraction:
go get github.com/arctir/proctor/pkg/plib
Similarly, the Go doc describing this library are available at
pkg.go.dev.
Once installed, run proctor help
or visit our documentation for details on
usage.
Development
Run make help
to see development tasks.
Feel free to open issues and/or pull requests.