Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/postmanlabs/observability-cli

The Akita CLI helps you make sense of API traffic. Passively watch API traffic with apidump. Model API behavior with apispec. Compare API behavior with apidiff.
https://github.com/postmanlabs/observability-cli

api api-specification gopacket openapi-specification openapi3

Last synced: about 1 month ago
JSON representation

The Akita CLI helps you make sense of API traffic. Passively watch API traffic with apidump. Model API behavior with apispec. Compare API behavior with apidiff.

Awesome Lists containing this project

README 

        
# Welcome! 👋



The fastest and easiest way to understand your APIs.



Built for busy developer teams who don't have time to become experts in monitoring and observability, Akita makes it possible to quickly discover all your API endpoints, see which are slowest, and learn which have errors. No SDKs or code changes necessary.



  * **Get plug-and-play API monitoring.** Explore and share per-endpoint volume, latency, and errors. Set per-endpoint alerts.

  * **See API endpoints.** Automatically get a searchable map of your API endpoints in use. Explore by latency, errors, and usage. Export as OpenAPI specs.



Drop Akita into your system to understand your application’s behavior, without having to instrument code or build your own dashboards.



We're in open beta and would love to have you try us out! [Create an account in the Akita App](https://app.akita.software/login?sign_up) to get started.



  [About this repo](#about-this-repo)

| [Running this repo](#running-this-repo)

| [Getting involved](#getting-involved)

| [Related links](#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](https://golang.org/doc/install). 

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](https://github.com/golang/mock): `go get github.com/golang/mock/mockgen`

2. `make test`



### How to use



See our docs: [Single Host/VM](https://docs.akita.software/docs/run-locally).



Note: if you're planning to use the Akita CLI with the Akita Console, we recommend using our [statically linked binaries](https://github.com/akitasoftware/akita-cli/releases) if possible.



## 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](https://github.com/akitasoftware/akita-ir), please see our

  [CONTRIBUTING](CONTRIBUTING.md) 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](https://docs.google.com/forms/d/e/1FAIpQLSfF-Mf4Li_DqysCHy042IBfvtpUDHGYrV6DOHZlJcQV8OIlAA/viewform?usp=sf_link)!



## Related links

* [Akita blog](https://www.akitasoftware.com/blog)

* [Akita docs](https://docs.akita.software/)

* [Join open beta](https://app.akita.software/login?sign_up)