Quick Start

Let’s start setting up your environment so you can begin using Hawkeye to monitor your resources and start an investigation session.

Tip

To help you begin, we’ve created a short demo walkthrough and a step-by-step guide. Check out the demo for a visual guide to setting up and running the project in no time!

Demo

Fig.1 - A walkthrough of how to setup and run a Hawkeye project

Quick Start Guide

To set up an investigation session, you’ll need to go through the following steps:

Step 1 Set up a connection to your cloud resources.

Step 2 Set up a project that uses the data from the connection.

Step 3 Wait for the project to analyze the available data.

Step 4 Start an investigation session for the project.

Step 1: Setting up a connection

To start, you’ll need to create a connection to your cloud resources, allowing Hawkeye to pull in telemetry data.

1. Access connections: From the left-hand navigation menu, click on Connections.

   

   Fig.2 - Access connections

2. Create a new connection:

   Click the New Connection card.

   

   Fig.3 - Create new connection dashboard

   Choose the type of connection (AWS, Azure, GCP, etc.), then click next to enter the connection details.

   

   Fig.4 - Choose the type of connection

   Provide the necessary connection details.

   

   Fig.5 - Connection details

   Once the details are filled in, click the Save button.

Note

For a step-by-step guide to setting up a connection, refer to the guide specific to that connection type.

Step 2: Setting up a project

With a connection established, the next step is to set up a project.

1. Navigate to Projects:

   After saving the connection, you’ll be prompted to create a project.

   

   Fig.6 - Navigate to projects

   Alternatively, you can navigate to the Projects section from the left-hand menu.

2. Create a new Project:

   Click the New Project card.

   

   Fig.7 - Create new project dashboard

   Enter the project name and description, and choose a badge color.

   

   Fig.8 - Project name and description

   Select the connection you created earlier.

   

   Fig.9 - Select connection

   Confirm the project details and click Save.

Step 3: Wait for the project to be Ready

Once the project is created, Hawkeye will analyze the telemetry data from the connection. This might take a few moments.

Fig.10 - Wait for project

The project status will update to Ready once it’s done.

Step 4: Start a session for investigation

Once your project have been successfully created, you can navigate back to your projects where you can start your investigation.

1. Open the project:

   From the Projects section, find your project and click on it.

   

   Fig.11 - Open project

2. Start a new session:

   Once inside the project, a new session will automatically begin, and you can start interacting with Hawkeye.

   

   Fig.12 - Start a new session

   Future sessions can be started by clicking the New Session button, and all prior sessions will be saved in the session list.