https://github.com/arctir/proctor

A CLI and libraries acting as a toolkit for introspecting software from source to runtime.
https://github.com/arctir/proctor

Last synced: about 14 hours ago
JSON representation

A CLI and libraries acting as a toolkit for introspecting software from source to runtime.

• Host: GitHub
• URL: https://github.com/arctir/proctor
• Owner: arctir
• License: apache-2.0
• Created: 2022-06-28T15:05:15.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-25T15:24:47.000Z (over 1 year ago)
• Last Synced: 2024-06-20T00:35:12.920Z (5 months ago)
• Language: Go
• Homepage:
• Size: 115 KB
• Stars: 17
• Watchers: 1
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](docs/examples.md).

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:

```sh

go get github.com/arctir/proctor/pkg/plib

```

Similarly, the Go doc describing this library are available at

[pkg.go.dev](https://pkg.go.dev/github.com/arctir/proctor/pkg/plib).

Once installed, run `proctor help` or visit [our documentation](docs/examples) for details on

usage.

## Development

Run `make help` to see development tasks.

Feel free to open issues and/or pull requests.