|
| 1 | +package io.sentry.quartz; |
| 2 | + |
| 3 | +import io.sentry.BuildConfig; |
| 4 | +import io.sentry.CheckIn; |
| 5 | +import io.sentry.CheckInStatus; |
| 6 | +import io.sentry.MonitorConfig; |
| 7 | +import io.sentry.MonitorSchedule; |
| 8 | +import io.sentry.MonitorScheduleUnit; |
| 9 | +import io.sentry.Sentry; |
| 10 | +import io.sentry.SentryIntegrationPackageStorage; |
| 11 | +import io.sentry.SentryLevel; |
| 12 | +import io.sentry.protocol.SentryId; |
| 13 | +import java.util.List; |
| 14 | +import java.util.TimeZone; |
| 15 | +import org.jetbrains.annotations.NotNull; |
| 16 | +import org.jetbrains.annotations.Nullable; |
| 17 | +import org.quartz.CalendarIntervalTrigger; |
| 18 | +import org.quartz.CronTrigger; |
| 19 | +import org.quartz.DateBuilder; |
| 20 | +import org.quartz.Job; |
| 21 | +import org.quartz.JobDetail; |
| 22 | +import org.quartz.JobExecutionContext; |
| 23 | +import org.quartz.JobExecutionException; |
| 24 | +import org.quartz.JobKey; |
| 25 | +import org.quartz.JobListener; |
| 26 | +import org.quartz.SimpleTrigger; |
| 27 | +import org.quartz.Trigger; |
| 28 | + |
| 29 | +public final class SentryJobListener implements JobListener { |
| 30 | + |
| 31 | + public static final String SENTRY_CHECK_IN_ID_KEY = "sentry-checkin-id"; |
| 32 | + public static final String SENTRY_CHECK_IN_SLUG_KEY = "sentry-checkin-slug"; |
| 33 | + |
| 34 | + public SentryJobListener() { |
| 35 | + SentryIntegrationPackageStorage.getInstance().addIntegration("Quartz"); |
| 36 | + SentryIntegrationPackageStorage.getInstance() |
| 37 | + .addPackage("maven:io.sentry:sentry-quartz", BuildConfig.VERSION_NAME); |
| 38 | + } |
| 39 | + |
| 40 | + @Override |
| 41 | + public String getName() { |
| 42 | + return "sentry-job-listener"; |
| 43 | + } |
| 44 | + |
| 45 | + @Override |
| 46 | + public void jobToBeExecuted(JobExecutionContext context) { |
| 47 | + try { |
| 48 | + final @NotNull String slug = getSlug(context.getJobDetail()); |
| 49 | + final @NotNull CheckIn checkIn = new CheckIn(slug, CheckInStatus.IN_PROGRESS); |
| 50 | + |
| 51 | + final @Nullable MonitorConfig monitorConfig = extractMonitorConfig(context); |
| 52 | + if (monitorConfig != null) { |
| 53 | + checkIn.setMonitorConfig(monitorConfig); |
| 54 | + } |
| 55 | + |
| 56 | + final @NotNull SentryId checkInId = Sentry.captureCheckIn(checkIn); |
| 57 | + context.put(SENTRY_CHECK_IN_ID_KEY, checkInId); |
| 58 | + context.put(SENTRY_CHECK_IN_SLUG_KEY, slug); |
| 59 | + } catch (Throwable t) { |
| 60 | + Sentry.getCurrentHub() |
| 61 | + .getOptions() |
| 62 | + .getLogger() |
| 63 | + .log(SentryLevel.ERROR, "Unable to capture check-in in jobToBeExecuted.", t); |
| 64 | + } |
| 65 | + } |
| 66 | + |
| 67 | + private @NotNull String getSlug(final @Nullable JobDetail jobDetail) { |
| 68 | + if (jobDetail == null) { |
| 69 | + return "fallback"; |
| 70 | + } |
| 71 | + final @NotNull StringBuilder slugBuilder = new StringBuilder(); |
| 72 | + |
| 73 | + final @Nullable JobKey key = jobDetail.getKey(); |
| 74 | + if (key != null) { |
| 75 | + slugBuilder.append(key.getName()); |
| 76 | + slugBuilder.append("__"); |
| 77 | + } |
| 78 | + |
| 79 | + final @Nullable Class<? extends Job> jobClass = jobDetail.getJobClass(); |
| 80 | + if (jobClass != null) { |
| 81 | + slugBuilder.append(jobClass.getCanonicalName()); |
| 82 | + } |
| 83 | + |
| 84 | + return slugBuilder.toString(); |
| 85 | + } |
| 86 | + |
| 87 | + private @Nullable MonitorConfig extractMonitorConfig(final @NotNull JobExecutionContext context) { |
| 88 | + @Nullable MonitorSchedule schedule = null; |
| 89 | + @Nullable String cronExpression = null; |
| 90 | + @Nullable TimeZone timeZone = TimeZone.getDefault(); |
| 91 | + @Nullable Integer repeatInterval = null; |
| 92 | + @Nullable MonitorScheduleUnit timeUnit = null; |
| 93 | + |
| 94 | + try { |
| 95 | + List<? extends Trigger> triggersOfJob = |
| 96 | + context.getScheduler().getTriggersOfJob(context.getTrigger().getJobKey()); |
| 97 | + for (Trigger trigger : triggersOfJob) { |
| 98 | + if (trigger instanceof CronTrigger) { |
| 99 | + final CronTrigger cronTrigger = (CronTrigger) trigger; |
| 100 | + cronExpression = cronTrigger.getCronExpression(); |
| 101 | + timeZone = cronTrigger.getTimeZone(); |
| 102 | + } else if (trigger instanceof SimpleTrigger) { |
| 103 | + final SimpleTrigger simpleTrigger = (SimpleTrigger) trigger; |
| 104 | + long tmpRepeatInterval = simpleTrigger.getRepeatInterval(); |
| 105 | + repeatInterval = millisToMinutes(Double.valueOf(tmpRepeatInterval)); |
| 106 | + timeUnit = MonitorScheduleUnit.MINUTE; |
| 107 | + } else if (trigger instanceof CalendarIntervalTrigger) { |
| 108 | + final CalendarIntervalTrigger calendarIntervalTrigger = (CalendarIntervalTrigger) trigger; |
| 109 | + DateBuilder.IntervalUnit repeatIntervalUnit = |
| 110 | + calendarIntervalTrigger.getRepeatIntervalUnit(); |
| 111 | + int tmpRepeatInterval = calendarIntervalTrigger.getRepeatInterval(); |
| 112 | + if (DateBuilder.IntervalUnit.SECOND.equals(repeatIntervalUnit)) { |
| 113 | + repeatInterval = secondsToMinutes(Double.valueOf(tmpRepeatInterval)); |
| 114 | + timeUnit = MonitorScheduleUnit.MINUTE; |
| 115 | + } else if (DateBuilder.IntervalUnit.MILLISECOND.equals(repeatIntervalUnit)) { |
| 116 | + repeatInterval = millisToMinutes(Double.valueOf(tmpRepeatInterval)); |
| 117 | + timeUnit = MonitorScheduleUnit.MINUTE; |
| 118 | + } else { |
| 119 | + repeatInterval = tmpRepeatInterval; |
| 120 | + timeUnit = convertUnit(repeatIntervalUnit); |
| 121 | + } |
| 122 | + } |
| 123 | + } |
| 124 | + } catch (Throwable t) { |
| 125 | + Sentry.getCurrentHub() |
| 126 | + .getOptions() |
| 127 | + .getLogger() |
| 128 | + .log(SentryLevel.ERROR, "Unable to extract monitor config for check-in.", t); |
| 129 | + } |
| 130 | + if (cronExpression != null) { |
| 131 | + schedule = MonitorSchedule.crontab(cronExpression); |
| 132 | + } else if (repeatInterval != null && timeUnit != null) { |
| 133 | + schedule = MonitorSchedule.interval(repeatInterval.intValue(), timeUnit); |
| 134 | + } |
| 135 | + |
| 136 | + if (schedule != null) { |
| 137 | + final @Nullable MonitorConfig monitorConfig = new MonitorConfig(schedule); |
| 138 | + if (timeZone != null) { |
| 139 | + monitorConfig.setTimezone(timeZone.getID()); |
| 140 | + } |
| 141 | + return monitorConfig; |
| 142 | + } else { |
| 143 | + return null; |
| 144 | + } |
| 145 | + } |
| 146 | + |
| 147 | + private @Nullable Integer millisToMinutes(final @NotNull Double milis) { |
| 148 | + return Double.valueOf((milis / 1000.0) / 60.0).intValue(); |
| 149 | + } |
| 150 | + |
| 151 | + private @Nullable Integer secondsToMinutes(final @NotNull Double seconds) { |
| 152 | + return Double.valueOf(seconds / 60.0).intValue(); |
| 153 | + } |
| 154 | + |
| 155 | + private @Nullable MonitorScheduleUnit convertUnit( |
| 156 | + final @Nullable DateBuilder.IntervalUnit intervalUnit) { |
| 157 | + if (intervalUnit == null) { |
| 158 | + return null; |
| 159 | + } |
| 160 | + |
| 161 | + if (DateBuilder.IntervalUnit.MINUTE.equals(intervalUnit)) { |
| 162 | + return MonitorScheduleUnit.MINUTE; |
| 163 | + } else if (DateBuilder.IntervalUnit.HOUR.equals(intervalUnit)) { |
| 164 | + return MonitorScheduleUnit.HOUR; |
| 165 | + } else if (DateBuilder.IntervalUnit.DAY.equals(intervalUnit)) { |
| 166 | + return MonitorScheduleUnit.DAY; |
| 167 | + } else if (DateBuilder.IntervalUnit.WEEK.equals(intervalUnit)) { |
| 168 | + return MonitorScheduleUnit.WEEK; |
| 169 | + } else if (DateBuilder.IntervalUnit.MONTH.equals(intervalUnit)) { |
| 170 | + return MonitorScheduleUnit.MONTH; |
| 171 | + } else if (DateBuilder.IntervalUnit.YEAR.equals(intervalUnit)) { |
| 172 | + return MonitorScheduleUnit.YEAR; |
| 173 | + } |
| 174 | + |
| 175 | + return null; |
| 176 | + } |
| 177 | + |
| 178 | + @Override |
| 179 | + public void jobExecutionVetoed(JobExecutionContext context) { |
| 180 | + // do nothing |
| 181 | + } |
| 182 | + |
| 183 | + @Override |
| 184 | + public void jobWasExecuted(JobExecutionContext context, JobExecutionException jobException) { |
| 185 | + try { |
| 186 | + final @Nullable Object checkInIdObjectFromContext = context.get(SENTRY_CHECK_IN_ID_KEY); |
| 187 | + final @Nullable Object slugObjectFromContext = context.get(SENTRY_CHECK_IN_SLUG_KEY); |
| 188 | + final @NotNull SentryId checkInId = |
| 189 | + checkInIdObjectFromContext == null |
| 190 | + ? new SentryId() |
| 191 | + : (SentryId) checkInIdObjectFromContext; |
| 192 | + final @Nullable String slug = |
| 193 | + slugObjectFromContext == null ? null : (String) slugObjectFromContext; |
| 194 | + if (slug != null) { |
| 195 | + final boolean isFailed = jobException != null; |
| 196 | + final @NotNull CheckInStatus status = isFailed ? CheckInStatus.ERROR : CheckInStatus.OK; |
| 197 | + Sentry.captureCheckIn(new CheckIn(checkInId, slug, status)); |
| 198 | + } |
| 199 | + } catch (Throwable t) { |
| 200 | + Sentry.getCurrentHub() |
| 201 | + .getOptions() |
| 202 | + .getLogger() |
| 203 | + .log(SentryLevel.ERROR, "Unable to capture check-in in jobWasExecuted.", t); |
| 204 | + } |
| 205 | + } |
| 206 | +} |
0 commit comments