Skip to content

Commit

Permalink
Add Fauna integration (#2425)
Browse files Browse the repository at this point in the history
* add fauna integration

* Add more details to README sections

Also add Submitted Data Type and Offering to the manifest.json

* add oauth configuration

* Accept README and manifest suggestions

Co-authored-by: Austin Lai <76412946+alai97@users.noreply.github.com>
Co-authored-by: emarsha94 <52013262+emarsha94@users.noreply.github.com>

* add dashboard and images

* namespace fauna facets

Add logs to dashboard
Use correct indentation for logs test

* add log pipeline test

* update README with dashboard link

change avg latency to p50

* add log status mapping

* add source_type_id

Co-authored-by: Owen Moreau <48562956+moreauowen@users.noreply.github.com>

* remove ui_extension oauth section

* fix log and dashboard config

* Update images size and aspect ratio

* change to pngs

* size images to 2880px

* add empty service_checks.json

* update dashboard images

This adds an image to include the overview section and updates the logs
image to include logs in both sections

* update README to remove 'metrics'

* remove unused image

* update log pipeline facets and dashboard

This will use namespaced paths for the fauna facets and also update the
dashboard to use the new facets.
Adds an image to the dashboard

* update changelog date

Co-authored-by: emarsha94 <52013262+emarsha94@users.noreply.github.com>

* Update .github/CODEOWNERS

---------

Co-authored-by: Austin Lai <76412946+alai97@users.noreply.github.com>
Co-authored-by: emarsha94 <52013262+emarsha94@users.noreply.github.com>
Co-authored-by: Owen Moreau <48562956+moreauowen@users.noreply.github.com>
Co-authored-by: bgoldberg122 <ben.goldberg@datadoghq.com>
  • Loading branch information
5 people committed Jul 25, 2024
1 parent fea5368 commit 1b6aa64
Show file tree
Hide file tree
Showing 13 changed files with 1,583 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
/exim/ @JeanFred
/f5-distributed-cloud/ @GregCoward support@f5.com @DataDog/ecosystems-review
/fairwinds_insights_ui/ @rbren insights@fairwinds.com @DataDog/ecosystems-review
/fauna/ @fauna-chase support@fauna.com @DataDog/ecosystems-review
/federatorai/ @chenyingtz @yummydsky
/fiddler/ @dannybrock sales@fiddler.ai @DataDog/ecosystems-review
/filebeat/ @wk8 jean@tripping.com
Expand Down
7 changes: 7 additions & 0 deletions fauna/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CHANGELOG - Fauna

## 1.0.0 / 2024-07-29

***Added***:

* Initial Release
72 changes: 72 additions & 0 deletions fauna/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Agent Check: Fauna

## Overview

Fauna is a fully managed, distributed document-relational database. With this integration, you can stream your Fauna database query logs into Datadog. This enables you to view your queries in real time, and you can see the following information about your queries:
1. Fauna Cost Measures
1. Read Ops
2. Write Ops
3. Compute Ops
2. Query Time
3. Query Size Measures
1. Request and response size
4. Query shape
1. The full request body with Personal Identifiable Data removed.
5. Query response code

For the full list of fields available in the logs, see the [Fauna Query Log Record Format][1].

## Setup

### Installation

1. Click the 'Connect Accounts' button on the [Fauna integration tile][3] to start the OAuth flow and connect your Fauna and Datadog accounts.
2. Once directed to Fauna, login with the account you'd like to connect. You can skip this step if you're already logged into your Fauna account.
3. You are redirected to the Fauna Create Integration page, where you can select the region group(s) or databases that you would like to stream logs into Datadog for. Then, click **Create**.
4. When directed to Datadog, click **Authorize** to authorize Fauna to create an API key for your account that will be used to send the database query logs.

Once this flow is complete, you are redirected to the [Fauna Integrations Page][2], which shows your active integration.

Within the next ten minutes, the [Fauna Overview Dashboard][7] will begin showing logs for any queries issued for the configured region group(s) or databases.
The above issued queries should also start appearing in the [Datadog Log Explorer][4] under the 'fauna' service.

### Configuration

You can configure the following settings for the Fauna integration:

1. Which region groups database query logs are sent to.
1. If a region group is enabled for the integration, query logs are sent for every database in the enabled region group.
2. Which databases query logs are sent from.
3. The integration state (Active or Paused). When Paused, logs are not sent.

Visit the [Fauna Integrations Page][2] to update any configuration settings or to remove your integration.

It can take up to ten minutes to see your updates take effect in the [Fauna Overview Dashboard][7] and [Datadog Log Explorer][4].

### Validation

Once configured correctly, within ten minutes you should see logs in the [Fauna Overview Dashboard][7] as well in the [Datadog Log Explorer][4] under the 'fauna' service.

### Uninstallation
- Visit the [Fauna Integrations Page][2] and remove the Datadog integration.
- Once this integration has been uninstalled, any previous authorizations are revoked.
- Additionally, ensure that all API keys associated with this integration have been disabled by searching for the integration name on the [API Keys page][5].

## Data Collected

### Logs

Fauna includes logs for every query within the databases configured in the integration.
If the integration is configured with a region group, then query logs for all databases within the region group are included.

## Troubleshooting

Need help? Contact [Fauna support][6].

[1]: https://docs.fauna.com/fauna/current/tools/query_log/reference/log_reference
[2]: https://dashboard.fauna.com/resources/integrations
[3]: https://app.datadoghq.com/integrations/fauna
[4]: https://docs.datadoghq.com/logs/explorer/
[5]: https://app.datadoghq.com/organization-settings/api-keys
[6]: mailto:support@fauna.com
[7]: https://app.datadoghq.com/dashboard/lists?q=Fauna%20Overview
Loading

0 comments on commit 1b6aa64

Please sign in to comment.