Getting started with Akita is as simple as running our Agent in Docker Desktop. Below are instructions for utilizing Akita's Docker Desktop Extension to run and manage the Akita Agent.
You will be setting up the Akita Agent by:
- Creating an Akita Project
- Generating an API key for the Akita Agent
- Installing Akita's Docker Desktop Extension
- Starting the Akita Agent via the Docker Desktop Extension
- Updating Agent Settings
- Verifying that the Akita Agent is working
Enter a project name and click "Create Project". We suggest naming the project after your app or deployment stack.
Give your project a name that's easy to remember – you'll need it later, when you start the Akita Agent using the Docker Desktop Extension.
On the same Settings page, locate and click the “API Keys” tab. Click the “Set up the Akita client” button. Copy your API key secret into your favorite password manager or somewhere else you can easily access it. Also note your API key, as you will need it later.
First, verify that you are running the latest version of Docker Desktop by navigating to Preferences > Software Updates in the Docker Desktop app.
Next, install the Akita Docker Extension by running:
docker extension install akitasoftware/akita-docker-extension:latest
Verify that the Extension has been installed successfully by checking that it appears in your Docker Desktop sidebar under Extensions
Verify that Docker Extensions system containers are viewable
"Show Docker Extension Containers" must be enabled for this extension to work. To enable this setting in Docker Desktop, navigate to Preferences > Extensions and check the "Show Docker Extension Containers" checkbox.
To start the Akita Agent, navigate to the Akita Extension and provide the API credentials and project created in Akita's dashboard.
Optionally, if you'd like to filter the traffic the Akita Agent will collect, you may specify a target port or container.
After configuring, click Start Akita Agent to start collecting traffic.
Once pressed, a new screen will appear that allows you to track the status of the running Akita Agent. To verify that the agent has successfully started, check that the status of the agent is Running. You may also view the Agent's container logs and status by clicking View Container.
After the Agent has started, you may like to change your targeted project or traffic filters. To do this, click on the gear icon, update your desired settings, then press Apply & Restart.
In the Akita web console, check out the incoming data on the Model page. You should see a map of your API being generated as the Akita Agent gathers data.
Then check out the Metrics and Errors page to get real-time information on the health of your app or service.
Updated 2 months ago