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:
- While setting up a new project (see project page)
- By editing an existing project.
This guide will walk you through how to use an existing project to configure project instructions.
Editing an existing project
To get started:
- Select an existing project and on the project card, click edit. (see projects page to create a project if you haven’t already).
- Type in instructions for your project in the project instructions box, select connection, and click save. See example project instruction below
This project is for investigating a service app on AWS. It uses the following services, lambda, API gateway, RDS, and elasticache. There is also a k8s based application running on the same AWS region, but I do not want to include content related to the k8s application in my project investigations. So exclude any alerts or logs or metrics or configuration that relates to kubernates's nodes clusters or pods.
Project session
To see project instructions in action:
- Navigate to project session
- 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?
- You will receive a log analysis like so:
The above prompt analyzed active log alerts relevant to the project, excluding alerts related to Kubernates.