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

Slack notification message format #10871

Open
data-han opened this issue Jan 17, 2025 · 4 comments
Open

Slack notification message format #10871

data-han opened this issue Jan 17, 2025 · 4 comments
Assignees
Labels
feature-request feature request

Comments

@data-han
Copy link

Is your feature request related to a problem? Please describe.
With the update from 0.18.2x, the format of the slack notification changed and it's not as clean as before. Also, there is this extra 'Validation Results' message which bothers me a lot. Is anyone else facing the same issue?

Issue 1: Exists in both version, i think in 0.17.x there wasn't this message. "Validation results .. <file......>" the long text in between --> can this be removed? anyone else facing this?

Issue 2: In the older version like 0.18.13 before the reformat, the message is cleaner where Expectation suite name: and Data asset name are indented and bolded nicely which is very easy to see. However, after the upgrade, the message is just plain text and it's hard to see what is what.

0.18.13 (old)
Image

1.3.1 (new)
Image

Describe the solution you'd like
A clean message on Slack.

Describe alternatives you've considered

Additional context

@data-han
Copy link
Author

@NathanFarmer hi there! I noticed you have issued a PR to fix this duplicate link text last year but not sure why I am still seeing this error. Have you got a clue? Im already using the latest 1.3.2.

#9986

@data-han
Copy link
Author

Also, I feel like it's a good idea to have the number of failed expectations / total. This gives us a gauge at one glance instead of having to click into it...

@adeola-ak adeola-ak moved this from To Do to In progress in GX Core Issues Board Jan 22, 2025
@adeola-ak adeola-ak added the feature-request feature request label Jan 22, 2025
@adeola-ak adeola-ak moved this from In progress to To Do in GX Core Issues Board Jan 22, 2025
@NathanFarmer NathanFarmer self-assigned this Jan 24, 2025
@adeola-ak adeola-ak moved this from To Do to In progress in GX Core Issues Board Jan 29, 2025
@DavidJS01
Copy link

My team is using GX Core and we found the default Slack alerting to be extremely poor in quality. It was honestly a little frustrating not having actionable insight out of the box.

FWIW, the only information that was included in the Slack alerting for us out of the box was whether the checkpoint succeeded, the data asset name, and the expectation suite name.

My solution was to create a custom renderer that inherited the SlackRenderer class. It overloaded the underlying _build_description_block and _build_header functions.

That SlackRenderer class I made was passed into the args of the SlackNotificationAction.

Basically, just parsed the results and built a clean alert line by line in markdown flavored strings.

While I am grateful that we have the ability to pass in custom renderers for this (which is great!), it was really frustrating needing to do this and dive into source code for actionable Slack alerting.

I think improving this would be a big win.

@data-han
Copy link
Author

data-han commented Feb 13, 2025

Thanks for the comment @DavidJS01 . Faced with the same issue, I was planning to create a PR (#10890) to remove the extra text as well. I've been replacing the original python file with a custom file in my docker and works so far. Would like to see improvements in the main GX Core

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request feature request
Projects
Status: In progress
Development

No branches or pull requests

4 participants