Where Observability
meets Structure

The only observability tool to build API behaviour models, Akita enables API-centric system monitoring and allows users to automatically detect breaking changes.

More about how Akita works

Part 1: Installing Akita

The Akita Client observes traffic and sends 'Witnesses' to the Akita Cloud. A Witness describes the request, response, and type (string, integer, boolean, etc). Witnesses never contain any property or parameter values, ensuring that Akita never sees your sensitive data.

We've made the Akita Client available on Linux and macOS, and as a Docker container.

📘

Private beta access

Akita is currently in private beta. If you are not part of the private beta, you will need to request an invite before continuing. Get an invite.

Linux Installation

To install the Akita Client for Linux, you can run the command below on most major distributions.

bash -c "$(curl -L https://releases.akita.software/scripts/install_akita.sh)"

Installing via APT

On Ubuntu and other Debian-based systems, you could instead add Akita Software's apt repository by hand, by adding the following line to the source list:

deb [arch=amd64] https://apt.releases.akita.software/ stable main'

Next, add the Akita public key to the set of keys trusted by APT:

curl -f https://releases.akita.software/keys/akita-apt.public | sudo apt-key add -

Then after "apt-get update" you can use "apt-get install akita-cli" to install the latest version.

After the client is installed, "apt-get update" or rerunning "apt-get install akita-cli" will update the CLI; you need not re-run the installation script.

macOS Installation

To install the Akita Client for macOS, you can use the brew package manager. Simply run the following command to add Akita to your taps and install the Akita Client.

brew tap akitasoftware/akita && brew install akita-cli

🚧

Network Monitoring Limitations on macOS

macOS does not support setcap. This means to monitor network traffic you will have to run the Akita Client with sudo

Docker Installation

To get the Akita Client as a docker container simply run the following command:

docker pull akitasoftware/cli:latest

The docker container is also hosted on Amazon ECR. If you need to pull the image frequently or across many images (e.g. in distributed integration tests, across many Kubernetes nodes, etc.), try pulling from ECR rather than Docker Hub, as the former supports a higher pull rate.

docker pull public.ecr.aws/akitasoftware/akita-cli:latest

Note that if you pull from ECR, you should use the ECR image name when invoking the CLI rather than the Docker Hub image name.

Login into your Akita Account

In order to access the Akita Cloud, you will need to provide your API Key ID and Secret to the CLI. You can do this by using the "login" command or environment variables.

Login Command

Running the login command will prompt you for your API Key ID and API Key Secret. Your API Key ID and API Key Secret will be stored securely in your $HOME directory for future use.

> akita login
API Key ID: apk_0000000000000000000000
API Key Secret: ******************************
Login successful!
API keys stored in ${HOME}/.akita/credentials.yaml

Environment Variables

In instances where running the login command is not possible (e.g., a CI/CD pipeline), you can provide your API Key ID and API Key Secret as environment variables.

AKITA_API_KEY_ID="<YOUR API KEY ID>"
AKITA_API_KEY_SECRET="<YOUR API KEY SECRET>"

Updated 2 months ago



Part 1: Installing Akita


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.