postmanlabs / observability-cli Goto Github PK

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.

Home Page: https://docs.akita.software/docs

License: Apache License 2.0

Go 99.95% Makefile 0.05%

api openapi3 api-specification openapi-specification gopacket

observability-cli's Introduction

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 to get started.

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:

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

How to test

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

How to use

See our docs: Single Host/VM.

Note: if you're planning to use the Akita CLI with the Akita Console, we recommend using our statically linked binaries 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, 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!

observability-cli's People

Contributors

Stargazers

Watchers

observability-cli's Issues

"apidump --out" creates empty folder / no har file?

I'm trying to use akita apidump with --out to a local folder. The out folder gets created but is empty. I've tried both on MacOS and Linux, both built from source and with the official binary (mentioned in the docs) and got the same result. Am I doing anything wrong?

Results received:
Empty out folder, no .har file.

Expected:
.har file gets created in the out dir.

Example:

Before: out dir doesn't exist:

$ ls -a
.  ..

running as user root:

$ akita apidump -c 'curl -I -L https://api.github.com/users/torvalds/events/public' -u root --out ./dumpdir
[INFO] Running learn mode on interfaces lo, ens18, cni-podman0
[WARNING] --filter flag is not set, this means that:
[WARNING]   - all network traffic is treated as your API traffic
[WARNING]   - outbound witness collection is disabled
[INFO] Running subcommand...


======= _AKITA_SUBCOMMAND_ =======
======= _AKITA_SUBCOMMAND_ =======
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0  299k    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
HTTP/2 200
server: GitHub.com
<...>

======= _AKITA_SUBCOMMAND_ =======
======= _AKITA_SUBCOMMAND_ =======
[INFO] Subcommand finished successfully, stopping trace collection...
[INFO] Success! 🎉

After: out dir got created but is empty:

$ ls -a
.  ..  dumpdir
ls -a dumpdir/
.  ..

FYI: Instalation through Homebrew is failing with ARM64

Hi folks!
I've tried to install Akita CLI though Homebrew no a Macbook with M1 processor, and I got this error:

brew tap akitasoftware/akita && brew install akita-cli
==> Installing akita-cli from akitasoftware/akita
==> Downloading https://releases.akita.software/cli/0.17.7/akita_0.17.7_darwin_arm64.zip
Already downloaded: /Users/gkbonetti/Library/Caches/Homebrew/downloads/c63d51f2bf2c8c82a40fd47b05666ac5c1cfd24c64b9cf642f3d4d8b30a237ea--akita_0.17.7_darwin_arm64.zip
Error: SHA256 mismatch
Expected: 256652350362e692a5e874abedf9a2c933303176e4e4f04668f2c0b62b3976e8
  Actual: 7df38396aa89250408186d80b2e01f3d7aef1063d678b93e2ffd44f8a25a84b9
    File: /Users/gkbonetti/Library/Caches/Homebrew/downloads/c63d51f2bf2c8c82a40fd47b05666ac5c1cfd24c64b9cf642f3d4d8b30a237ea--akita_0.17.7_darwin_arm64.zip
To retry an incomplete download, remove the file above.

I've tried deleting the downloaded file and trying again a few times but the result was always the same.

Since I couldn't install it through Homebrew, I've installed it from source (following the Readme) and it seems to be working.

x509: certificate signed by unknown authority

Looks like this is coming from inside the container, could be our corporate proxy security firewall, Idk.

docker run --rm --network host \
  -e AKITA_API_KEY_ID=apk_5...F \
  -e AKITA_API_KEY_SECRET=1...3 \
  akitasoftware/cli:latest apidump \
  --project RTTA


Unable to find image 'akitasoftware/cli:latest' locally
latest: Pulling from akitasoftware/cli
72cfd02ff4d0: Pull complete
4ac5a229ebba: Pull complete
829d9da225a6: Pull complete
Digest: sha256:7e20d3b81b28a35669e2eb25cef0b9275fc8e746dbabe30ecee967e9574ad6d2
Status: Downloaded newer image for akitasoftware/cli:latest
[INFO] Akita Agent 0.23.0
[ERROR]  request failed [error Get "https://api.akita.software/v1/user": x509: certificate signed by unknown authority method GET url https://api.akita.software/v1/user]
[INFO] Telemetry using temporary ID; /v1/user API call failed: Get "https://api.akita.software/v1/user": x509: certificate signed by unknown authority
[INFO] This error may indicate a problem communicating with the Akita servers,
[INFO] but the agent will still attempt to send telemetry Akita support.
[ERROR]  request failed [error Get "https://api.akita.software/v1/services": x509: certificate signed by unknown authority method GET url https://api.akita.software/v1/services]
[ERROR] failed to get list of services associated with the account: Get "https://api.akita.software/v1/services": x509: certificate signed by unknown authority

nawab-ikramullah-khan

nawabdera