akita-cli

README

Welcome! 👋

Drop in Akita for instant API observability.

Powered by eBPF and state-of-the-art API traffic modeling algorithms, Akita enables any developer to understand and track API endpoints and their usage in real time:

• Understand what API endpoints you have. Get a continuously up-to-date, searchable map of your API endpoints, fields, data types, and more. Export as OpenAPI specs.

• Understand API usage. Get an automatically updated, per-endpoint view of volume, latency, and errors—without having to make code changes or build your own dashboards.

• Automatically understand API behavior changes. Quickly get a summary of changes to performance and errors, added and removed endpoints, and more.

Simply drop Akita into your system to understand your system behavior, without having to use a proxy or instrument code service by service.

We're in beta and would love to have you try us out! Join here.

About this repo | Running this repo | Getting involved | Related links

About this repo

This is the open-source repository for the community version of our CLI, and is intended for use with the Akita console. This community version of the CLI does not include functionality for inferring types and data formats. This functionality is available only in the akita binary that we distribute.

Running this repo

How to build

Running the following commands will generate the akita-cli binary:

1. Install Go 1.18 or above.
2. Install libpcap
   • For Homebrew on mac: brew install libpcap
   • For Ubuntu/Debian: apt-get install libpcap-dev
3. make

How to test

1. Install gomock: go get github.com/golang/mock/mockgen
2. make test

How to use

See our docs: Single Host/VM.

Getting involved

• Please file bugs as issues to this repository.
• We welcome contributions! If you want to make changes or build your own extensions to the CLI on top of the Akita IR, please see our CONTRIBUTING doc.
• We're always happy to answer any questions about the CLI, or about how you can contribute. Email us at opensource [at] akitasoftware [dot] com or request to join our Slack!

Related links

• Akita blog
• Akita docs
• Sign up for our private beta