Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Robust Intelligence AI Firewall integration tile #2122

Merged
merged 25 commits into from
Nov 13, 2023

Conversation

MayankR
Copy link
Contributor

@MayankR MayankR commented Oct 2, 2023

What does this PR do?

Add Robust Intelligence AI Firewall integration tile

Motivation

This integration monitors the AI Firewall results through the Datadog Agent and allows users to visualize the firewall's performance using a dashboard.

Review checklist

  • PR has a meaningful title or PR has the no-changelog label attached
  • Feature or bugfix has tests
  • Git history is clean
  • If PR impacts documentation, docs team has been notified or an issue has been opened on the documentation repo

Additional Notes

Anything else we should know when reviewing?

…#1)

* initial commit for check

* check with correct metrics

* add dashboard

* update dashboard and readme

* update dashboard title

* fix readme links and add logos

* fix support email link

* update homepage and support email
* update section on metrics collected

* update firewall link and dashboard
* readme fixes

* update risk name

* fix metrics section content

* add image assets
@MayankR MayankR requested review from a team as code owners October 2, 2023 23:26
@alai97 alai97 added the editorial review Waiting on a more in-depth review from a docs team editor label Oct 2, 2023
* lint fixes

* add sales email
@github-actions
Copy link

github-actions bot commented Oct 3, 2023

Test Results

2 files  2 suites   1s ⏱️
1 tests 1 ✔️ 0 💤 0
2 runs  2 ✔️ 0 💤 0

Results for commit 1bfd558.

♻️ This comment has been updated with latest results.

Copy link
Collaborator

@emarsha94 emarsha94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for submitting your integration! Please let me know if you have any questions on my comments and suggestions.

## Overview

[Robust Intelligence’s AI Firewall][1] wraps a protective layer around your AI models. It helps:
1. **Block malicious inputs in real time.** Attacks on AI systems are increasing in frequency and sophistication. The nature of large language models (LLMs) make them a disproportionally high target, but all model types are at risk. AI Firewall inspects every input and automatically blocks malicious payloads before they can do damage to your model. Risks includes prompt injection, prompt extraction, and PII exfiltration.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We like to avoid marketing material. I think this can be shortened to explain what the product is and the value but we recommend the overview include:

  1. What does your product do (in 1-2 sentences)?
  2. What will customers get from this integration, and why is it valuable to them?
  3. What types of data will your integration send in or pull out, and what's the value of that data?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, updated the overview!

1. Run the following command to install the Agent integration:

```shell
datadog-agent integration install -t datadog-robust-intelligence-ai-firewall==<INTEGRATION_VERSION>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please include the integration version in the command the customer will run

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added it

robust_intelligence_ai_firewall/manifest.json Outdated Show resolved Hide resolved
robust_intelligence_ai_firewall/manifest.json Outdated Show resolved Hide resolved
robust_intelligence_ai_firewall/manifest.json Outdated Show resolved Hide resolved
robust_intelligence_ai_firewall/manifest.json Outdated Show resolved Hide resolved
* update overview and description

* add integrtaion version

* add classifier tags

* add dashboard description
Copy link
Contributor

@drichards-87 drichards-87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple of very minor suggestions from the Docs Team and approved the PR.

robust_intelligence_ai_firewall/README.md Outdated Show resolved Hide resolved
robust_intelligence_ai_firewall/README.md Outdated Show resolved Hide resolved
* add details to configure section

* Add suggestion

Co-authored-by: Arley Lewis <[email protected]>

---------

Co-authored-by: Arley Lewis <[email protected]>
@MayankR MayankR requested a review from emarsha94 October 9, 2023 23:26
Copy link
Collaborator

@emarsha94 emarsha94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for submitting the PR! Requested some changes/left comments. please let us know if you have any questions!

* update readme and remove unnecessary file

* upgrade dashboard
@MayankR MayankR requested a review from emarsha94 October 18, 2023 16:46
* add dashboard banner

* update banner url
Copy link
Contributor

@anawishnoff anawishnoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few more comments from the product side. Thanks!

robust_intelligence_ai_firewall/README.md Show resolved Hide resolved
robust_intelligence_ai_firewall/README.md Outdated Show resolved Hide resolved
robust_intelligence_ai_firewall/manifest.json Outdated Show resolved Hide resolved
robust_intelligence_ai_firewall/manifest.json Outdated Show resolved Hide resolved
robust_intelligence_ai_firewall/manifest.json Outdated Show resolved Hide resolved
@MayankR MayankR requested a review from anawishnoff October 26, 2023 05:30
@emarsha94
Copy link
Collaborator

Thank you for making the changes! Once all approvals are done, would you like to test this in your sandbox account prior to publishing live?

* add scope variable

* fix description
@MayankR
Copy link
Contributor Author

MayankR commented Nov 6, 2023

Hi @emarsha94 , I recall from our Friday meeting that you mentioned the possibility of including extra comments before we proceed with merging this PR. I wanted to follow up on it and check if there are any comments you'd like to add.

@emarsha94
Copy link
Collaborator

@MayankR I am looking into the validation errors on my end to provide next best steps to resolve them. I will update you here once I learn more!

@emarsha94
Copy link
Collaborator

Hi @MayankR I learned that you will need to delete that config_models folder from your integration to resolve the validation errors. This is an optional feature that adds more visibility into errors but this requires customers to be on Agent V7.48+. Please let me know if you have any questions!

@MayankR
Copy link
Contributor Author

MayankR commented Nov 8, 2023

@emarsha94 I still see the errors after removing that folder. It seems that folder is auto generated when I run ddev -x validate models -s robust_intelligence_ai_firewal locally

@MayankR
Copy link
Contributor Author

MayankR commented Nov 8, 2023

@emarsha94 I was able to fix a few more errors, any recommendations about the last few ones?

@emarsha94
Copy link
Collaborator

Hey @MayankR - Have you run the tests locally and if so, have they been successful? If not, can you please run the tests locally and let me know? Thanks!

@MayankR
Copy link
Contributor Author

MayankR commented Nov 10, 2023

@emarsha94 they were not running successfully on localhost. I've added the fixes you suggested and they are running successfully now!

@james-eichelbaum james-eichelbaum merged commit 6a4223f into DataDog:master Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants