Skip to main content

Datadog proof types and queries

Written by Hyperproof Support
Updated over 3 weeks ago

πŸ“ Note

Hyperproof connects to many third-party systems that frequently change, including the system interface. Contact your System Administrator or the third-party provider for assistance in meeting the requirements to integrate with Hyperproof and collect the proof you need.


When you create a Hypersync between Hyperproof and Datadog, you can automatically collect the following proof types:

Datadog proof types and fields

Proof type

Fields

Testable

List of Active Users

Name, Email, Roles, Created On

Yes

List of Hosts

Name, Platform, Status, CPU, IO Wait, Load 15, Apps

Yes

List of Monitors

Priority, Status, Name, Tags

Yes

List of Incidents

State, Severity, Title, Created Date, Detected Date, Resolved Date

Yes

Alert Configurations

[Monitor] Name, Warning Threshold, Critical Threshold, Warning Recovery Threshold, Critical Recovery Threshold

Yes


​

Additional documentation


πŸ“ Note

You only need to connect Hyperproof to the app once, and then you can create as many Hypersyncs as you need.
​

Additionally, you can create multiple Hypersyncs for a single control or label.


Connection configuration

Authentication type: Custom
​

Custom authentication parameters: Application Key, API Key, Site URL

To connect to Datadog and collect proof, your Datadog configuration must meet the following requirements.

Step One: Create a new Hypersync role

  1. Sign in to your Datadog account.

  2. In the bottom left-corner, hover over your name.

  3. From the Organization settings, select Roles.

  4. Highlight Datadog Read Only Role, then click the Clone icon.

  5. Add a name for the new role, i.e. Hyperproof/Hypersync Role.

  6. Configure the minimum required permissions for the Hypersync to work:

User App Keys


πŸ“ NoteThis permission is NOT automatically included in the cloned Datadog Read Only Role, and needs to be manually added. This is required so the Hypersync can query metadata from the App Key belonging to the service account.


APM Read

Client Tokens Read

RUM Apps Read

Dashboards Read

Incidents Read

Notebooks Read

SLOs Read

Monitors Read

CI Visibility Read

  1. Click Save.

Step Two: Create a service account

  1. From the left menu, navigate to Identity & Accounts > Service Accounts.

  2. Click New Service Account.

  3. Enter a name, i.e. Hyperproof/Hypersync Account, and a company email.

  4. From the Assign Roles drop-down menu, select Hyperproof/Hypersync Role.

  5. Click Create Service Account.

Step Three: Create the App Key

  1. Select your newly created service account.

  2. In the right pane, click New Key.

  3. Enter a name, i.e. Hyperproof/Hypersync App Key.

  4. Click Create Key. The App Key has the permissions of the user who created it.

  5. Copy your newly created Application Key using the Copy button.


    πŸ“ Note

    Do not skip this step!


  6. Store your key securely, and then click Finish.


    πŸ“ Note

    Ensure that your Application Key is Not Scoped. Application Key permissions are inherited directly from the originating service account.


Step Four: Create the API Key

A Datadog administrator can create new API Keys.

  1. From the left menu, navigate to Access > API Keys.

  2. Click New Key.

  3. Enter a name, i.e. Hyperproof/Hypersync API Key.

  4. Click Create Key.

  5. Copy your newly created API Key using the Copy button.


    πŸ“ Note

    Do not skip this step!


  6. Store your key securely, and then click Finish.

Did this answer your question?