Datadog
Connecting Hawkeye to your Datadog account allows us to collect application and infrastructure telemetry, which includes metrics, traces, and logs. These telemetry data enable real-time monitoring and alerting through the Hawkeye dashboard.
To ensure an easy connection with Hawkeye, you will authenticate using a Datadog API Key, APP ID, and Endpoint.
Step 1: Setup Datadog Integration
To retrieve these credentials, you’ll need to set up and configure a Datadog integration. For this tutorial, we’ll select GitHub as the integration type. The following steps will help you set this up:
-
Navigate to Datadog Integration: Sign in to your Datadog account and navigate to Integrations.
-
Select Integration: Search for GitHub and and click on Install.
-
Create GitHub APP: On the GitHub integration page, click on the button labeled Create Your First GitHub APP.
-
Configure GitHub APP: Provide the following details:
-
Configure App: Select your GitHub account type. For this tutorial, select the Personal account option.
-
Select features: Select any features you’d want to grant this GitHub App. You can select the features as seen in the image below:
-
Select permissions: You can grant these features read, write, or both access types. It’s advisable to select Read-Only access to your GitHub account.
After this, click on Create App in GitHub.
-
-
Configure GitHub App: You’ll be redirected to Github to create the application, so provide a name for the Datadog App.
-
Install GitHub App: Once the application is created, click on Install GitHub App on your Datadog dashboard.
-
Authorize GitHub App: You’ll be redirected back to GitHub to authorize the application. Click on Install & Authorize.
-
Create API Key: Navigate to the GitHub Applications overview, and select the Webhooks tab. Scroll down and click on Create New.
-
Provide details of API key: Input a name for the API key, and click Create API Key.
-
Copy API Key: The API key will be displayed immediately after it is created. Copy the API key.
-
Retrieve APP ID and Endpoint: On your GitHub account, navigate to Settings > Developer settings > GitHub Apps and select the Datadog App.
Copy the APP ID and Endpoint.
Step 2: Add Datadog Connection to Hawkeye
Now that you have your API Key, APP ID, and Endpoint, proceed to the Hawkeye dashboard to complete the connection setup.
-
Navigate to the Connections Tab: In the Hawkeye dashboard, go to the Connections section and click on New Connection.
-
Select Datadog: From the list of available integrations, select Datadog.
Then, click Next at the top right corner.
-
Enter Credentials: Provide the following credentials:
- Name: Give your connection a descriptive name.
- Description: Optionally, add a description for the integration.
- API Key: Paste the API Key you generated from your Datadog account.
- APP ID: Enter the APP ID you copied from the GitHub App.
- Endpoint: Enter the Endpoint you retrieved from the GitHub App.
Click Save to complete the setup.
-
Verify connection: Once the connection is successfully established, navigate to the connections section in Hawkeye. You should see the Datadog connection card displayed on your dashboard.