Skip to content

Feature: Dynamic resource notices #2087

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

Merged
merged 21 commits into from
Mar 31, 2023
Merged

Conversation

B-T-D
Copy link
Contributor

@B-T-D B-T-D commented Jan 27, 2023

Summary of Changes

  • Adds support for dynamic, programmatic notices on tables and other resources
  • Organizations using Amundsen can configure a custom notice client to generate notices for tables based on arbitrary business logic. For example, at notices about delays in updates to a table's data.

Tests

Added unit tests for the notice endpoint.

Documentation

Docstrings on public classes.

CheckList

Make sure you have checked all steps below to ensure a timely review.

  • PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
  • PR includes a summary of changes.
  • PR adds unit tests, updates existing unit tests, OR documents why no test additions or modifications are needed.
  • In case of new functionality, my PR adds documentation that describes how to use it.
    • All the public functions and the classes in the PR contain docstrings that explain what it does

@boring-cyborg boring-cyborg bot added the area:frontend From the Frontend folder label Jan 27, 2023
@stale
Copy link

stale bot commented Mar 12, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale label Mar 12, 2023
@stale stale bot removed the stale label Mar 24, 2023
@B-T-D B-T-D force-pushed the btd-alert-model branch from 2f90e05 to 2f2518a Compare March 27, 2023 16:33
@B-T-D B-T-D changed the title Btd alert model Feature: Dynamic resource notices Mar 27, 2023
@B-T-D B-T-D force-pushed the btd-alert-model branch from 63d823c to 6eb5a82 Compare March 29, 2023 00:44
@boring-cyborg boring-cyborg bot added area:databuilder From databuilder folder area:docs labels Mar 29, 2023
@B-T-D B-T-D force-pushed the btd-alert-model branch 3 times, most recently from a48d421 to 63d823c Compare March 29, 2023 01:29
Copy link
Contributor

Choose a reason for hiding this comment

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

is this file meant to replace this? https://github.com/amundsen-io/amundsen/blob/main/frontend/amundsen_application/static/js/components/Alert/index.tsx

I remember reviewing a few small changes recently that seem to have been made in the index.tsx file but not here. not sure if this one just hasn't been updated, and if so should the index file be deleted as part of this PR?

Golodhros and others added 4 commits March 30, 2023 11:17
@B-T-D B-T-D force-pushed the btd-alert-model branch from 63d823c to 6694744 Compare March 30, 2023 15:18
@B-T-D B-T-D marked this pull request as ready for review March 30, 2023 16:22
Signed-off-by: Ben Dye <[email protected]>

Update frontend/amundsen_application/static/js/components/Alert/Alert.tsx
@B-T-D B-T-D force-pushed the btd-alert-model branch from d0cdc26 to 7b6c289 Compare March 31, 2023 14:42
Copy link
Member

@Golodhros Golodhros left a comment

Choose a reason for hiding this comment

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

LGTM on the FE side

@allisonsuarez allisonsuarez merged commit a0ecaeb into amundsen-io:main Mar 31, 2023
@ozandogrultan
Copy link
Contributor

Great work and addition! Do we any documentation on how to configure and use this feature? @B-T-D

@B-T-D
Copy link
Contributor Author

B-T-D commented Apr 5, 2023

I can try to add more documentation at some point. There's a bit of documentation in the form of docstrings in the code currently.

Basically, you will need to have some separate service that is generating these notices. You then configure a concrete notice client that subclasses BaseNoticeClient. That notice client's job is to talk to whatever non-Amundsen service you're getting the notices from, and turn them into Flask responses that are understandable by the endpoint in api/notice/v0.py.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:databuilder From databuilder folder area:dev-tools area:docs area:frontend From the Frontend folder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants