Project Instructions

Overview

Project instructions is a feature on projects that allows you to state precisely, the details of your project, and what resources you expect to monitor or ignore. This helps Hawkeye understand the context of your project and to deliver better and more relevant analysis.

You can access project instructions in two ways:

1. While setting up a new project (see project page)
2. By editing an existing project.

This guide will walk you through how to use an existing project to configure project instructions.

Adding project instructions to a new project

While creating a new project, you’re requred to add an Instruction, this gives Hawkeye more details about your project and what to monitor. The project instruction comes after:

1. The project details: Where you give your project a name, detailed description and color.
2. Connection: Where you connect a service you wish to utilize to your project.

The demo below shows a practical example of how to add project instruction to your new project.

Editing an existing project

To get started:

1. Select an existing project and on the project card, click Edit. (see projects page to create a project if you haven’t already).

2. Edit your Project details: This includes the Name, Description and Color of your Project.

3. Select a connection for your project.

4. Edit your Project Instructions.

The demo below shows a practical example of how to add project instruction to your new project.

Note

Project instruction specifies:

• What the project is for - [Example: investigating a service app on AWS]
• The resource it uses - [Example: lambda, APIgateway, RDS, elasticache, Kubernates, AWS]
• What analysis you expect to access or ignore - [Example:alerts, logs, metrics, configuration excluding kubernates’s node clusters or pods.]
  
  This will help in analyzing only relevant content during the project session.

Project session

To see project instructions in action:

1. Click the Project card to navigate to project session
2. In the box provided, enter a prompt for a content you want to analyze.
   Example

Are there any active log alerts relevant to this project?

3. You will receive a log analysis for your project.

The above prompt analyzed active log alerts relevant to the project, excluding alerts related to Kubernates.

Note

Project instructions helps hawkeye monitor only relevant content, while ignoring content that are not related to what you want to investigate.