jira integration #3590

jkroepke · 2023-11-01T20:00:08Z

This PR track the Atlassian JIRA integration into Alertmanger.

Replaces: https://github.com/prometheus-community/jiralert

What I test:

Jira Cloud only
Create issues
Auto-Close issue with resolve_transition
Reopen issue with reopen_transition
Reopen duration
Custom Fields
api_token_file

Signed-off-by: Jan-Otto Kröpke <[email protected]>

k0ste · 2023-11-18T12:48:14Z

Can this integration cover another of jiralert issue - is custom field for alert hash?
prometheus-community/jiralert#164

Current code search hash in hardcoded place - in labels

jql.WriteString(fmt.Sprintf(`project = "%s" and
labels=%q order by status ASC,
resolutiondate DESC`, n.conf.Project, key.Hash()))

Thanks

jkroepke · 2023-11-18T15:24:16Z

Sure. After merge. Everyone is invited to improve.

I would not like to add more feature here. Even I understand you request.

The current PR covery already a lot of cases to test. Adding more new features results into more testing. I would prefer to add new features in separate PRs.

holger-waschke · 2023-12-05T14:54:01Z

Is this implementation only for Jira Cloud or can I still use the on-premise API with a PAT Authentication?

jkroepke · 2023-12-05T17:00:41Z

Hi @holger-waschke

I'm not able to test on-premise. But you can enter an Server API Path to an on premise instance and the authentication is still auth basic which should work on on-premise, too.

The integration does not use any cloud specific features. If https://github.com/prometheus-community/jiralert works on-premise, this integration should work, too.

I remember that Issue handling, the Jira Software Server API v2 and Cloud API v2 is the same.

But please keep in mind that this integration will always have best-effort since most users are not able to setup a on premise instance.

simonpasquier

Thanks for starting this! I haven't looked yet in details into the notifier but I suppose that it's almost a 1:1 copy from the original project?

Not a blocker but I think that it's the first notifier which needs to query the external system before actually sending the notification. It should be highlighted in the documentation IMHO.

docs/configuration.md

config/config.go

config/notifiers.go

docs/configuration.md

notify/jira/jira.go

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

jkroepke · 2023-12-11T15:05:46Z

Thanks for starting this! I haven't looked yet in details into the notifier but I suppose that it's almost a 1:1 copy from the original project?

No. while jiralert uses a unofficial outdated REST SDK for JIRA, I used the standard http client to setup the few http calls.

Signed-off-by: Jan-Otto Kröpke <[email protected]>

# Conflicts: # asset/assets_vfsdata.go

Signed-off-by: Jan-Otto Kröpke <[email protected]>

SuperQ · 2024-07-02T05:14:29Z

Yes, I would like to see this merged so we can iterate on additional featres.

docs/configuration.md

simonpasquier · 2024-07-02T13:21:05Z

go.mod

@@ -37,6 +37,7 @@ require (
 	github.com/shurcooL/httpfs v0.0.0-20190707220628-8d4bc4ba7749
 	github.com/shurcooL/vfsgen v0.0.0-20200824052919-0d455de96546
 	github.com/stretchr/testify v1.9.0
+	github.com/trivago/tgo v1.0.7


json-iterator is already an indirect dependency via prometheus/client_golang so I'd say that it's ok to use it.

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

docs/configuration.md

SuperQ

Some minor doc consistency nits.

docs/configuration.md

Co-authored-by: Ben Kochie <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

Signed-off-by: Jan-Otto Kröpke <[email protected]>

jkroepke · 2024-07-02T20:20:13Z

Thanks for all the reviews.

I had some issues with jsoniter (as replacement for tcontainer), but I struggle here. Tests are failing with jsoniter.
I have implement a truncate for jira description (ref truncate descriptions that exceed -max-description-length (default 32KB) prometheus-community/jiralert#165) - also experienced this once already.
The notify context will be passed to all API calls.
I merged group_labels and static_labels as suggested by @simonpasquier

jkroepke · 2024-07-10T20:38:13Z

Hi all, after 2 approvals. how we should proceed?

SuperQ · 2024-07-12T14:58:38Z

Ping @gotjosh @simonpasquier

simonpasquier

I'll review by the end of the week, sorry for the delay.

simonpasquier

I'd have minor comments on making the code a bit more compact but nothing that should prevent merging this PR. Thanks again for your patience!
I'll also look into building a new RC for Alertmanager.

* Initial jira integration Signed-off-by: Jan-Otto Kröpke <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]> Co-authored-by: Simon Pasquier <[email protected]> Co-authored-by: Ben Kochie <[email protected]>

* [CHANGE] Deprecate and remove api/v1/ #2970 * [CHANGE] Remove unused feature flags #3676 * [CHANGE] Newlines in smtp password file are now ignored #3681 * [CHANGE] Change compat metrics to counters #3686 * [CHANGE] Do not register compat metrics in amtool #3713 * [CHANGE] Remove metrics from compat package #3714 * [CHANGE] Mark muted alerts #3793 * [FEATURE] Add metric for inhibit rules #3681 * [FEATURE] Support UTF-8 label matchers #3453, #3507, #3523, #3483, #3567, #3568, #3569, #3571, #3595, #3604, #3619, #3658, #3659, #3662, #3668, 3572 * [FEATURE] Add counter to track alerts dropped outside of time_intervals #3565 * [FEATURE] Add date and tz functions to templates #3812 * [FEATURE] Add limits for silences #3852 * [FEATURE] Add time helpers for templates #3863 * [FEATURE] Add auto GOMAXPROCS #3837 * [FEATURE] Add auto GOMEMLIMIT #3895 * [FEATURE] Add Jira receiver integration #3590 * [ENHANCEMENT] Add the receiver name to notification metrics #3045 * [ENHANCEMENT] Add the route ID to uuid #3372 * [ENHANCEMENT] Add duration to the notify success message #3559 * [ENHANCEMENT] Implement webhook_url_file for discord and msteams #3555 * [ENHANCEMENT] Add debug logs for muted alerts #3558 * [ENHANCEMENT] API: Allow the Silences API to use their own 400 response #3610 * [ENHANCEMENT] Add summary to msteams notification #3616 * [ENHANCEMENT] Add context reasons to notifications failed counter #3631 * [ENHANCEMENT] Add optional native histogram support to latency metrics #3737 * [ENHANCEMENT] Enable setting ThreadId for Telegram notifications #3638 * [ENHANCEMENT] Allow webex roomID from template #3801 * [BUGFIX] Add missing integrations to notify metrics #3480 * [BUGFIX] Add missing ttl in pushhover #3474 * [BUGFIX] Fix scheme required for webhook url in amtool #3409 * [BUGFIX] Remove duplicate integration from metrics #3516 * [BUGFIX] Reflect Discord's max length message limits #3597 * [BUGFIX] Fix nil error in warn logs about incompatible matchers #3683 * [BUGFIX] Fix a small number of inconsistencies in compat package logging #3718 * [BUGFIX] Fix log line in featurecontrol #3719 * [BUGFIX] Fix panic in acceptance tests #3592 * [BUGFIX] Fix flaky test TestClusterJoinAndReconnect/TestTLSConnection #3722 * [BUGFIX] Fix crash on errors when url_file is used #3800 * [BUGFIX] Fix race condition in dispatch.go #3826 * [BUGFIX] Fix race conditions in the memory alerts store #3648 * [BUGFIX] Hide config.SecretURL when the URL is incorrect. #3887 * [BUGFIX] Fix invalid silence causes incomplete updates #3898 * [BUGFIX] Fix leaking of Silences matcherCache entries #3930 * [BUGFIX] Close SMTP submission correctly to handle errors #4006 Signed-off-by: SuperQ <[email protected]>

* Release v0.28.0-rc.0 * [CHANGE] Templating errors in the SNS integration now return an error. #3531 #3879 * [FEATURE] Add a new Microsoft Teams integration based on Flows #4024 * [FEATURE] Add a new Rocket.Chat integration #3600 * [FEATURE] Add a new Jira integration #3590 #3931 * [FEATURE] Add support for `GOMEMLIMIT`, enable it via the feature flag `--enable-feature=auto-gomemlimit`. #3895 * [FEATURE] Add support for `GOMAXPROCS`, enable it via the feature flag `--enable-feature=auto-gomaxprocs`. #3837 * [FEATURE] Add support for limits of silences including the maximum number of active and pending silences, and the maximum size per silence (in bytes). You can use the flags `--silences.max-silences` and `--silences.max-silence-size-bytes` to set them accordingly #3852 #3862 #3866 #3885 #3886 #3877 * [FEATURE] Muted alerts now show whether they are suppressed or not in both the `/api/v2/alerts` endpoint and the Alertmanager UI. #3793 #3797 #3792 * [ENHANCEMENT] Add support for `content`, `username` and `avatar_url` in the Discord integration. `content` and `username` also support templating. #4007 * [ENHANCEMENT] Only invalidate the silences cache if a new silence is created or an existing silence replaced - should improve latency on both `GET api/v2/alerts` and `POST api/v2/alerts` API endpoint. #3961 * [ENHANCEMENT] Add image source label to Dockerfile. To get changelogs shown when using Renovate #4062 * [ENHANCEMENT] Build using go 1.23 #4071 * [ENHANCEMENT] Support setting a global SMTP TLS configuration. #3732 * [ENHANCEMENT] The setting `room_id` in the WebEx integration can now be templated to allow for dynamic room IDs. #3801 * [ENHANCEMENT] Enable setting `message_thread_id` for the Telegram integration. #3638 * [ENHANCEMENT] Support the `since` and `humanizeDuration` functions to templates. This means users can now format time to more human-readable text. #3863 * [ENHANCEMENT] Support the `date` and `tz` functions to templates. This means users can now format time in a specified format and also change the timezone to their specific locale. #3812 * [ENHANCEMENT] Latency metrics now support native histograms. #3737 * [BUGFIX] Fix the SMTP integration not correctly closing an SMTP submission, which may lead to unsuccessful dispatches being marked as successful. #4006 * [BUGFIX] The `ParseMode` option is now set explicitly in the Telegram integration. If we don't HTML tags had not been parsed by default. #4027 * [BUGFIX] Fix a memory leak that was caused by updates silences continuously. #3930 * [BUGFIX] Fix hiding secret URLs when the URL is incorrect. #3887 * [BUGFIX] Fix a race condition in the alerts - it was more of a hypothetical race condition that could have occurred in the alert reception pipeline. #3648 * [BUGFIX] Fix a race condition in the alert delivery pipeline that would cause a firing alert that was delivered earlier to be deleted from the aggregation group when instead it should have been delivered again. #3826 * [BUGFIX] Fix version in APIv1 deprecation notice. #3815 * [BUGFIX] Fix crash errors when using `url_file` in the Webhook integration. #3800 * [BUGFIX] fix `Route.ID()` returns conflicting IDs. #3803 * [BUGFIX] Fix deadlock on the alerts memory store. #3715 * [BUGFIX] Fix `amtool template render` when using the default values. #3725 * [BUGFIX] Fix `webhook_url_file` for both the Discord and Microsoft Teams integrations. #3728 #3745 --------- Signed-off-by: SuperQ <[email protected]> Signed-off-by: gotjosh <[email protected]> Co-authored-by: gotjosh <[email protected]>

* [CHANGE] Templating errors in the SNS integration now return an error. #3531 #3879 * [CHANGE] Adopt log/slog, drop go-kit/log #4089 * [FEATURE] Add a new Microsoft Teams integration based on Flows #4024 * [FEATURE] Add a new Rocket.Chat integration #3600 * [FEATURE] Add a new Jira integration #3590 #3931 * [FEATURE] Add support for `GOMEMLIMIT`, enable it via the feature flag `--enable-feature=auto-gomemlimit`. #3895 * [FEATURE] Add support for `GOMAXPROCS`, enable it via the feature flag `--enable-feature=auto-gomaxprocs`. #3837 * [FEATURE] Add support for limits of silences including the maximum number of active and pending silences, and the maximum size per silence (in bytes). You can use the flags `--silences.max-silences` and `--silences.max-silence-size-bytes` to set them accordingly #3852 #3862 #3866 #3885 #3886 #3877 * [FEATURE] Muted alerts now show whether they are suppressed or not in both the `/api/v2/alerts` endpoint and the Alertmanager UI. #3793 #3797 #3792 * [ENHANCEMENT] Add support for `content`, `username` and `avatar_url` in the Discord integration. `content` and `username` also support templating. #4007 * [ENHANCEMENT] Only invalidate the silences cache if a new silence is created or an existing silence replaced - should improve latency on both `GET api/v2/alerts` and `POST api/v2/alerts` API endpoint. #3961 * [ENHANCEMENT] Add image source label to Dockerfile. To get changelogs shown when using Renovate #4062 * [ENHANCEMENT] Build using go 1.23 #4071 * [ENHANCEMENT] Support setting a global SMTP TLS configuration. #3732 * [ENHANCEMENT] The setting `room_id` in the WebEx integration can now be templated to allow for dynamic room IDs. #3801 * [ENHANCEMENT] Enable setting `message_thread_id` for the Telegram integration. #3638 * [ENHANCEMENT] Support the `since` and `humanizeDuration` functions to templates. This means users can now format time to more human-readable text. #3863 * [ENHANCEMENT] Support the `date` and `tz` functions to templates. This means users can now format time in a specified format and also change the timezone to their specific locale. #3812 * [ENHANCEMENT] Latency metrics now support native histograms. #3737 * [ENHANCEMENT] Add timeout option for webhook notifier. #4137 * [BUGFIX] Fix the SMTP integration not correctly closing an SMTP submission, which may lead to unsuccessful dispatches being marked as successful. #4006 * [BUGFIX] The `ParseMode` option is now set explicitly in the Telegram integration. If we don't HTML tags had not been parsed by default. #4027 * [BUGFIX] Fix a memory leak that was caused by updates silences continuously. #3930 * [BUGFIX] Fix hiding secret URLs when the URL is incorrect. #3887 * [BUGFIX] Fix a race condition in the alerts - it was more of a hypothetical race condition that could have occurred in the alert reception pipeline. #3648 * [BUGFIX] Fix a race condition in the alert delivery pipeline that would cause a firing alert that was delivered earlier to be deleted from the aggregation group when instead it should have been delivered again. #3826 * [BUGFIX] Fix version in APIv1 deprecation notice. #3815 * [BUGFIX] Fix crash errors when using `url_file` in the Webhook integration. #3800 * [BUGFIX] fix `Route.ID()` returns conflicting IDs. #3803 * [BUGFIX] Fix deadlock on the alerts memory store. #3715 * [BUGFIX] Fix `amtool template render` when using the default values. #3725 * [BUGFIX] Fix `webhook_url_file` for both the Discord and Microsoft Teams integrations. #3728 #3745 * [BUGFIX] Fix wechat api link #4084 * [BUGFIX] Fix build info metric #4166 Signed-off-by: SuperQ <[email protected]>

jkroepke force-pushed the jira branch 5 times, most recently from 3df6162 to 78f7970 Compare November 1, 2023 20:31

jkroepke changed the title ~~WIP: jira integration~~ jira integration Nov 1, 2023

jkroepke marked this pull request as ready for review November 1, 2023 20:32

jkroepke force-pushed the jira branch 2 times, most recently from 47846a8 to 39315c1 Compare November 1, 2023 21:47

Initial jira integration

ab5c92c

Signed-off-by: Jan-Otto Kröpke <[email protected]>

jkroepke force-pushed the jira branch from 39315c1 to ab5c92c Compare November 1, 2023 22:22

jkroepke mentioned this pull request Nov 12, 2023

Proposal: Move to Alertmanager. prometheus-community/jiralert#145

Open

gotjosh self-assigned this Nov 14, 2023

simonpasquier reviewed Dec 11, 2023

View reviewed changes

jkroepke and others added 8 commits December 11, 2023 16:03

Update docs/configuration.md

cf3de82

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

Update config/notifiers.go

d236da4

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

Update notify/jira/jira.go

e22d06b

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

Update docs/configuration.md

bf991e0

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

Update docs/configuration.md

6fb2bd1

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

Update config/notifiers.go

c2ceba2

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

Update config/config.go

a0b94df

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

Update config/notifiers.go

3705a64

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

jkroepke added 3 commits December 11, 2023 18:26

Added check for jira_api_token/jira_api_token_file

25b2657

Signed-off-by: Jan-Otto Kröpke <[email protected]>

Merge branch 'main' into jira

d65ca8b

# Conflicts: # asset/assets_vfsdata.go

make assets

a3975d9

Signed-off-by: Jan-Otto Kröpke <[email protected]>

jkroepke force-pushed the jira branch from 88fb89e to dbda07a Compare June 25, 2024 20:32

SuperQ requested a review from gotjosh July 2, 2024 05:14

simonpasquier reviewed Jul 2, 2024

View reviewed changes

Apply suggestions from code review

b6df3c1

Co-authored-by: Simon Pasquier <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

SuperQ reviewed Jul 2, 2024

View reviewed changes

docs/configuration.md Outdated Show resolved Hide resolved

SuperQ reviewed Jul 2, 2024

View reviewed changes

docs/configuration.md Outdated Show resolved Hide resolved

docs/configuration.md Outdated Show resolved Hide resolved

docs/configuration.md Outdated Show resolved Hide resolved

jkroepke and others added 5 commits July 2, 2024 21:02

Apply suggestions from code review

8bb43d0

Co-authored-by: Ben Kochie <[email protected]> Signed-off-by: Jan-Otto Kröpke <[email protected]>

Merge branch 'main' into jira

e123003

pass context to api requests

0ac2ca5

Signed-off-by: Jan-Otto Kröpke <[email protected]>

truncate description

43c8f10

Signed-off-by: Jan-Otto Kröpke <[email protected]>

merge labels properties

3517487

Signed-off-by: Jan-Otto Kröpke <[email protected]>

SuperQ approved these changes Jul 3, 2024

View reviewed changes

SuperQ requested review from simonpasquier and cropalato July 3, 2024 06:51

cropalato approved these changes Jul 5, 2024

View reviewed changes

simonpasquier reviewed Jul 31, 2024

View reviewed changes

simonpasquier approved these changes Jul 31, 2024

View reviewed changes

simonpasquier merged commit a509c14 into prometheus:main Jul 31, 2024
11 checks passed

jkroepke deleted the jira branch July 31, 2024 15:27

SuperQ mentioned this pull request Oct 16, 2024

Release v0.28.0-rc.0 #4072

Merged

jkroepke mentioned this pull request Oct 25, 2024

alertmanager: Replace typed fields with plain string values #4083

Draft

SuperQ mentioned this pull request Dec 19, 2024

Release v0.28.0 #4176

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

jira integration #3590

jira integration #3590

jkroepke commented Nov 1, 2023 •

edited

Loading

k0ste commented Nov 18, 2023

jkroepke commented Nov 18, 2023

holger-waschke commented Dec 5, 2023

jkroepke commented Dec 5, 2023

simonpasquier left a comment

jkroepke commented Dec 11, 2023 •

edited

Loading

SuperQ commented Jul 2, 2024

simonpasquier Jul 2, 2024

SuperQ left a comment

jkroepke commented Jul 2, 2024 •

edited

Loading

jkroepke commented Jul 10, 2024

SuperQ commented Jul 12, 2024

simonpasquier left a comment

simonpasquier left a comment

jira integration #3590

jira integration #3590

Conversation

jkroepke commented Nov 1, 2023 • edited Loading

k0ste commented Nov 18, 2023

jkroepke commented Nov 18, 2023

holger-waschke commented Dec 5, 2023

jkroepke commented Dec 5, 2023

simonpasquier left a comment

Choose a reason for hiding this comment

jkroepke commented Dec 11, 2023 • edited Loading

SuperQ commented Jul 2, 2024

simonpasquier Jul 2, 2024

Choose a reason for hiding this comment

SuperQ left a comment

Choose a reason for hiding this comment

jkroepke commented Jul 2, 2024 • edited Loading

jkroepke commented Jul 10, 2024

SuperQ commented Jul 12, 2024

simonpasquier left a comment

Choose a reason for hiding this comment

simonpasquier left a comment

Choose a reason for hiding this comment

jkroepke commented Nov 1, 2023 •

edited

Loading

jkroepke commented Dec 11, 2023 •

edited

Loading

jkroepke commented Jul 2, 2024 •

edited

Loading