Allow users to customize the Teams message card

[bzon]

Using the Go templating engine, we can include a feature to let the user create their own YAML templates and feed it to prometheus-msteams. The teams message card creation reference is here https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/cards/cards-reference.

We can add a new function named CreateCardFromTemplates that will be called if the user use the --card-template $TEMPLATE_FILE.

[Knappek]

Did somebody already start to work on that? If not, I would do so.

[bzon]

@Knappek I haven’t planned on working on this yet. Feel free to play around and see how you can bring this feature to life. Thanks.

[Knappek]

Just realized that a message card is not only limited to a size of 14KB but also to a maximum number of 10 sections (see https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/cards/cards-reference#notes-on-the-office-365-connector-card). Hence, we still have a bug that seemed to be fixed #29 . I will address this in the PR for this issue.

[Knappek]

@bzon I have created another PR draft: #37. We might need to talk about how to handle too large message cards as I think this might not be possible anymore using this templating approach (see my last commit).
Therefore, I thought of make it super easy and send out a teams message for each and every prometheus alert.

[Knappek]

@bzon is very busy these days, therefor I'd like to have some input from other folks. @LudwigTirazona @shabeermm @daviddob what do you think about sending out a teams message for each and every prometheus alert and don't combine multiple alerts to a single teams message card. Would that be a problem for you? I want to have your opinion on that as you were involved in #29.

[LudwigTirazona]

It's not too big of an issue for me, but what I foresee is that in some cases, prometheus-msteams will hit the MS Teams API rate limit. This will be more avoidable if each message sent to MS Teams has its maximum allowed size well-utilized, rather than one alert/item sent per message.

…

On Wed, Mar 13, 2019, 02:49 Andreas (Andy) Knapp, ***@***.***> wrote: @bzon <https://github.com/bzon> is very busy these days, therefor I'd like to have some input from other folks. @LudwigTirazona <https://github.com/LudwigTirazona> @shabeermm <https://github.com/shabeermm> @daviddob <https://github.com/daviddob> what do you think about sending out a teams message for each and every prometheus alert and don't combine multiple alerts to a single teams message card. Would that be a problem for you? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#12 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAw1ScfpJcDqooK-X_CBjX5gANAl3Pbwks5vV_azgaJpZM4S4HkJ> .

[Knappek]

Good point, I didn't know about the MS Teams api rate limit. I agree that it is more appropriate to bundle alerts to single message cards...

Then I'd like to verify my assumptions how to split messages in case that they are too big: Referencing a detailed example teams message card we need to split the sections part as this is the part where we loop over the prometheus alerts as shown in this example card template, am I right?

[LudwigTirazona]

Correct! :)

[Knappek]

PR #37 implements the functionality described in this issue. Just a few little things missing (like updating Readme etc.) that I will add in the upcoming days.
Would be great if some people can already test it and provide some feedback. @sosoriov this might be of interest for you as well.

[Knappek]

@cordula-grau fyi, this enhancement solves #27 .

[Knappek]

opened PR #37 . Would appreciate some code review, otherwise I'll merge it in the next couple of days and create the minor release 1.1.0.

[Knappek]

This feature is now available in v1.1.0 release.