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][PagerDuty] - Default Resources Enhancements #1182

Merged
merged 29 commits into from
Nov 28, 2024

Conversation

PeyGis
Copy link
Contributor

@PeyGis PeyGis commented Nov 25, 2024

Description

What - Added enhancements to the integration default resources as well as the integration itself.

Why - Rethinking the way we map data from PagerDuty and the need to improve on the overall user experiences

How - By undertaking the following:

  • Improved on the integration default resources for PagerDuty incidents kind
  • Added blueprint and mapping for PagerDuty users
  • Added logs to track the HTTP requests made to PagerDuty API
  • Added a generic resync event handler to allow the integration to bring any valid resource from PagerDuty

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.

@PeyGis PeyGis requested a review from a team as a code owner November 25, 2024 16:51
- Improved on the integration default resources for PagerDuty incidents kind
- Added blueprint and mapping for PagerDuty users
- Added logs to track the HTTP requests made to PagerDuty API
- Added a generic resync event handler to allow the integration to bring any valid resource from PagerDuty
Copy link
Contributor

Choose a reason for hiding this comment

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

which ones are expected to work? can we make sure we have a proper log on when we aren't able to sync data for the passed "generic" kind?

Comment on lines +179 to +183
@ocean.on_resync()
async def on_global_resync(kind: str) -> ASYNC_GENERATOR_RESYNC_TYPE:

if kind in OBJECTS_WITH_SPECIAL_HANDLING:
logger.info(f"Kind {kind} has a special handling. Skipping...")
Copy link
Contributor

Choose a reason for hiding this comment

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

can you document expected resources that can be passed here? like users etc..

Copy link
Contributor

@Tankilevitch Tankilevitch left a comment

Choose a reason for hiding this comment

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

LGTM

@PeyGis PeyGis merged commit ecc9067 into main Nov 28, 2024
20 checks passed
@PeyGis PeyGis deleted the PORT-11473-pagerduty-integration-enhancements branch November 28, 2024 11:57
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.

2 participants