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

[Integration][Datadog] Datadog Teams and Users #1256

Open
wants to merge 21 commits into
base: main
Choose a base branch
from

Conversation

shariff-6
Copy link
Contributor

Description

What -
Added support for Datadog Teams and Users in the integration, including fetching, processing, and enriching data related to teams and users.

Why -
Enable users to associate monitors, SLOs, and other Datadog resources with specific teams and users

How -

  • Updated resources/blueprints.json to define schemas for Datadog Teams and Users.
  • Modified client.py to include methods for fetching teams and users, as well as members of specific teams.
  • Added main.py logic to enrich team data with associated members.
  • Updated resources/port-app-config.yaml to map Datadog Team and User properties to corresponding Port entities.

Type of change

Please leave one option from the following and delete the rest:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • New Integration (non-breaking change which adds a new integration)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Non-breaking change (fix of existing functionality that will not change current behavior)
  • Documentation (added/updated documentation)

All tests should be run against the port production environment(using a testing org).

Core testing checklist

  • Integration able to create all default resources from scratch
  • Resync finishes successfully
  • Resync able to create entities
  • Resync able to update entities
  • Resync able to detect and delete entities
  • Scheduled resync able to abort existing resync and start a new one
  • Tested with at least 2 integrations from scratch
  • Tested with Kafka and Polling event listeners
  • Tested deletion of entities that don't pass the selector

Integration testing checklist

  • Integration able to create all default resources from scratch
  • Resync able to create entities
  • Resync able to update entities
  • Resync able to detect and delete entities
  • Resync finishes successfully
  • If new resource kind is added or updated in the integration, add example raw data, mapping and expected result to the examples folder in the integration directory.
  • If resource kind is updated, run the integration with the example data and check if the expected result is achieved
  • If new resource kind is added or updated, validate that live-events for that resource are working as expected
  • Docs PR link here

Preflight checklist

  • Handled rate limiting
  • Handled pagination
  • Implemented the code in async
  • Support Multi account

Screenshots

Include screenshots from your environment showing how the resources of the integration will look.

API Documentation

Provide links to the API documentation used for this integration.

- Added `on_resync_teams()` to fetch and enrich teams with member information.
- Added `on_resync_users()` to fetch users in batches.
- Implemented `enrich_teams_with_members()` to parallelize team member retrieval.
- Added `TeamSelector` with `include_members` option to control member inclusion.
- Added `TeamResourceConfig` to include team-specific configuration in the resource setup.
- Added `datadogTeam` and `datadogUser` blueprints to represent Datadog teams and users.
- Introduced resource configurations for teams and users in `port-app-config.yaml`.
- Added team and user support to `spec.yaml` to enable integration features.
- Add team relation to datadog service blueprint
- Fix team and service relationships using handle matching
- Renamed `get_paginated_team_members` to `get_team_members`.
- Simplified logic for fetching and processing team members.
- Removed unused fields from `blueprints.json` and `port-app-config.yaml`.
- Added descriptions
@shariff-6 shariff-6 requested a review from a team as a code owner December 19, 2024 16:26
Copy link
Contributor

@PeyGis PeyGis left a comment

Choose a reason for hiding this comment

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

looks great. left some minor comments

integrations/datadog/.port/resources/blueprints.json Outdated Show resolved Hide resolved
integrations/datadog/.port/resources/port-app-config.yaml Outdated Show resolved Hide resolved
integrations/datadog/CHANGELOG.md Outdated Show resolved Hide resolved
integrations/datadog/client.py Outdated Show resolved Hide resolved
integrations/datadog/main.py Outdated Show resolved Hide resolved
integrations/datadog/main.py Show resolved Hide resolved
integrations/datadog/client.py Outdated Show resolved Hide resolved
integrations/datadog/client.py Outdated Show resolved Hide resolved
integrations/datadog/client.py Show resolved Hide resolved
Copy link
Contributor

@phalbert phalbert 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 comments @shariff-6

integrations/datadog/.port/spec.yaml Outdated Show resolved Hide resolved
integrations/datadog/overrides.py Show resolved Hide resolved
@shariff-6 shariff-6 requested a review from phalbert December 23, 2024 15:39
Copy link
Contributor

@phalbert phalbert left a comment

Choose a reason for hiding this comment

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

LGTM

Comment on lines +46 to +48
if selector.include_members:
teams = await dd_client.enrich_teams_with_members(teams)
yield teams
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the enrich_teams_with_members should be just get_team_members and the logic of the merge will be in the main file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, makes sense. 👍 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants