mark crons features experimental

getsentry · Sep 20, 2023 · 409827e · 409827e
1 parent 86e5ded
commit 409827e
Show file tree

Hide file tree

Showing 20 changed files with 40 additions and 2 deletions.
diff --git a/sentry-quartz/src/main/java/io/sentry/quartz/SentryJobListener.java b/sentry-quartz/src/main/java/io/sentry/quartz/SentryJobListener.java
@@ -15,6 +15,7 @@
 import io.sentry.util.Objects;
 import java.util.List;
 import java.util.TimeZone;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.quartz.CalendarIntervalTrigger;
@@ -29,6 +30,7 @@
 import org.quartz.SimpleTrigger;
 import org.quartz.Trigger;
 
+@ApiStatus.Experimental
 public final class SentryJobListener implements JobListener {
 
   public static final String SENTRY_CHECK_IN_ID_KEY = "sentry-checkin-id";

diff --git a/...ing-jakarta/src/main/java/io/sentry/spring/jakarta/checkin/SentryQuartzConfiguration.java b/...ing-jakarta/src/main/java/io/sentry/spring/jakarta/checkin/SentryQuartzConfiguration.java
@@ -1,12 +1,14 @@
 package io.sentry.spring.jakarta.checkin;
 
 import com.jakewharton.nopen.annotation.Open;
+import org.jetbrains.annotations.ApiStatus;
 import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration(proxyBeanMethods = false)
 @Open
+@ApiStatus.Experimental
 public class SentryQuartzConfiguration {
 
   @Bean

diff --git a/.../src/main/java/io/sentry/spring/jakarta/checkin/SentrySchedulerFactoryBeanCustomizer.java b/.../src/main/java/io/sentry/spring/jakarta/checkin/SentrySchedulerFactoryBeanCustomizer.java
@@ -1,9 +1,11 @@
 package io.sentry.spring.jakarta.checkin;
 
 import io.sentry.quartz.SentryJobListener;
+import org.jetbrains.annotations.ApiStatus;
 import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer;
 import org.springframework.scheduling.quartz.SchedulerFactoryBean;
 
+@ApiStatus.Experimental
 public final class SentrySchedulerFactoryBeanCustomizer implements SchedulerFactoryBeanCustomizer {
   @Override
   public void customize(SchedulerFactoryBean schedulerFactoryBean) {

diff --git a/sentry-spring/src/main/java/io/sentry/spring/checkin/SentryQuartzConfiguration.java b/sentry-spring/src/main/java/io/sentry/spring/checkin/SentryQuartzConfiguration.java
@@ -1,12 +1,14 @@
 package io.sentry.spring.checkin;
 
 import com.jakewharton.nopen.annotation.Open;
+import org.jetbrains.annotations.ApiStatus;
 import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration(proxyBeanMethods = false)
 @Open
+@ApiStatus.Experimental
 public class SentryQuartzConfiguration {
 
   @Bean

diff --git a/...y-spring/src/main/java/io/sentry/spring/checkin/SentrySchedulerFactoryBeanCustomizer.java b/...y-spring/src/main/java/io/sentry/spring/checkin/SentrySchedulerFactoryBeanCustomizer.java
@@ -1,9 +1,11 @@
 package io.sentry.spring.checkin;
 
 import io.sentry.quartz.SentryJobListener;
+import org.jetbrains.annotations.ApiStatus;
 import org.springframework.boot.autoconfigure.quartz.SchedulerFactoryBeanCustomizer;
 import org.springframework.scheduling.quartz.SchedulerFactoryBean;
 
+@ApiStatus.Experimental
 public final class SentrySchedulerFactoryBeanCustomizer implements SchedulerFactoryBeanCustomizer {
   @Override
   public void customize(SchedulerFactoryBean schedulerFactoryBean) {

diff --git a/sentry/src/main/java/io/sentry/CheckIn.java b/sentry/src/main/java/io/sentry/CheckIn.java
@@ -9,6 +9,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+@ApiStatus.Experimental
 /** A check-in for a monitor (CRON). */
 public final class CheckIn implements JsonUnknown, JsonSerializable {
 

diff --git a/sentry/src/main/java/io/sentry/CheckInStatus.java b/sentry/src/main/java/io/sentry/CheckInStatus.java
@@ -1,9 +1,11 @@
 package io.sentry;
 
 import java.util.Locale;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
 /** Status of a CheckIn */
+@ApiStatus.Experimental
 public enum CheckInStatus {
   IN_PROGRESS,
   OK,

diff --git a/sentry/src/main/java/io/sentry/ExternalOptions.java b/sentry/src/main/java/io/sentry/ExternalOptions.java
@@ -8,6 +8,7 @@
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.concurrent.CopyOnWriteArraySet;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -392,18 +393,22 @@ public void setSendModules(final @Nullable Boolean sendModules) {
     this.sendModules = sendModules;
   }
 
+  @ApiStatus.Experimental
   public @Nullable Boolean isEnableAutomaticCheckIns() {
     return enableAutomaticCheckIns;
   }
 
+  @ApiStatus.Experimental
   public void setEnableAutomaticCheckIns(final @Nullable Boolean enableAutomaticCheckIns) {
     this.enableAutomaticCheckIns = enableAutomaticCheckIns;
   }
 
+  @ApiStatus.Experimental
   public void setIgnoredCheckIns(final @Nullable List<String> ignoredCheckIns) {
     this.ignoredCheckIns = ignoredCheckIns;
   }
 
+  @ApiStatus.Experimental
   public @Nullable List<String> getIgnoredCheckIns() {
     return ignoredCheckIns;
   }

diff --git a/sentry/src/main/java/io/sentry/Hub.java b/sentry/src/main/java/io/sentry/Hub.java
@@ -864,6 +864,7 @@ private Scope buildLocalScope(
   }
 
   @Override
+  @ApiStatus.Experimental
   public @NotNull SentryId captureCheckIn(final @NotNull CheckIn checkIn) {
     SentryId sentryId = SentryId.EMPTY_ID;
     if (!isEnabled()) {

diff --git a/sentry/src/main/java/io/sentry/HubAdapter.java b/sentry/src/main/java/io/sentry/HubAdapter.java
@@ -253,6 +253,7 @@ public void reportFullyDisplayed() {
   }
 
   @Override
+  @ApiStatus.Experimental
   public @NotNull SentryId captureCheckIn(final @NotNull CheckIn checkIn) {
     return Sentry.captureCheckIn(checkIn);
   }

diff --git a/sentry/src/main/java/io/sentry/IHub.java b/sentry/src/main/java/io/sentry/IHub.java
@@ -627,6 +627,7 @@ TransactionContext continueTrace(
   @Nullable
   BaggageHeader getBaggage();
 
+  @ApiStatus.Experimental
   @NotNull
   SentryId captureCheckIn(final @NotNull CheckIn checkIn);
 }
diff --git a/sentry/src/main/java/io/sentry/ISentryClient.java b/sentry/src/main/java/io/sentry/ISentryClient.java
@@ -266,5 +266,6 @@ SentryId captureTransaction(
   }
 
   @NotNull
+  @ApiStatus.Experimental
   SentryId captureCheckIn(@NotNull CheckIn checkIn, @Nullable Scope scope, @Nullable Hint hint);
 }
diff --git a/sentry/src/main/java/io/sentry/MonitorConfig.java b/sentry/src/main/java/io/sentry/MonitorConfig.java
@@ -4,9 +4,11 @@
 import java.io.IOException;
 import java.util.HashMap;
 import java.util.Map;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+@ApiStatus.Experimental
 public final class MonitorConfig implements JsonUnknown, JsonSerializable {
 
   private @NotNull MonitorSchedule schedule;

diff --git a/sentry/src/main/java/io/sentry/MonitorContexts.java b/sentry/src/main/java/io/sentry/MonitorContexts.java
@@ -6,9 +6,11 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.ConcurrentHashMap;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+@ApiStatus.Experimental
 public final class MonitorContexts extends ConcurrentHashMap<String, Object>
     implements JsonSerializable {
   private static final long serialVersionUID = 3987329379811822556L;

diff --git a/sentry/src/main/java/io/sentry/MonitorSchedule.java b/sentry/src/main/java/io/sentry/MonitorSchedule.java
@@ -8,6 +8,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+@ApiStatus.Experimental
 public final class MonitorSchedule implements JsonUnknown, JsonSerializable {
 
   public static @NotNull MonitorSchedule crontab(final @NotNull String value) {

diff --git a/sentry/src/main/java/io/sentry/MonitorScheduleType.java b/sentry/src/main/java/io/sentry/MonitorScheduleType.java
@@ -1,9 +1,11 @@
 package io.sentry;
 
 import java.util.Locale;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
 /** Type of a monitor schedule */
+@ApiStatus.Experimental
 public enum MonitorScheduleType {
   CRONTAB,
   INTERVAL;

diff --git a/sentry/src/main/java/io/sentry/MonitorScheduleUnit.java b/sentry/src/main/java/io/sentry/MonitorScheduleUnit.java
@@ -1,9 +1,11 @@
 package io.sentry;
 
 import java.util.Locale;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
 /** Time unit of a monitor schedule. */
+@ApiStatus.Experimental
 public enum MonitorScheduleUnit {
   MINUTE,
   HOUR,

diff --git a/sentry/src/main/java/io/sentry/NoOpHub.java b/sentry/src/main/java/io/sentry/NoOpHub.java
@@ -4,6 +4,7 @@
 import io.sentry.protocol.SentryTransaction;
 import io.sentry.protocol.User;
 import java.util.List;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -209,6 +210,7 @@ public void reportFullyDisplayed() {}
   }
 
   @Override
+  @ApiStatus.Experimental
   public @NotNull SentryId captureCheckIn(final @NotNull CheckIn checkIn) {
     return SentryId.EMPTY_ID;
   }

diff --git a/sentry/src/main/java/io/sentry/Sentry.java b/sentry/src/main/java/io/sentry/Sentry.java
@@ -1012,6 +1012,7 @@ public interface OptionsConfiguration<T extends SentryOptions> {
     return getCurrentHub().getBaggage();
   }
 
+  @ApiStatus.Experimental
   public static @NotNull SentryId captureCheckIn(final @NotNull CheckIn checkIn) {
     return getCurrentHub().captureCheckIn(checkIn);
   }

diff --git a/sentry/src/main/java/io/sentry/SentryOptions.java b/sentry/src/main/java/io/sentry/SentryOptions.java
@@ -444,10 +444,10 @@ public class SentryOptions {
   private boolean sendModules = true;
 
   /** Whether to automatically send check-ins for monitors (CRONS). */
-  private boolean enableAutomaticCheckIns = false;
+  @ApiStatus.Experimental private boolean enableAutomaticCheckIns = false;
 
   /** Contains a list of monitor slugs for which check-ins should not be sent. */
-  private @Nullable List<String> ignoredCheckIns = null;
+  @ApiStatus.Experimental private @Nullable List<String> ignoredCheckIns = null;
 
   /**
    * Adds an event processor
@@ -2152,6 +2152,7 @@ public boolean isSendModules() {
    *
    * @return true if check-ins should be sent automatically.
    */
+  @ApiStatus.Experimental
   public boolean isEnableAutomaticCheckIns() {
     return enableAutomaticCheckIns;
   }
@@ -2179,10 +2180,12 @@ public void setSendModules(boolean sendModules) {
    *
    * @param enableAutomaticCheckIns true if check-ins should be sent automatically.
    */
+  @ApiStatus.Experimental
   public void setEnableAutomaticCheckIns(boolean enableAutomaticCheckIns) {
     this.enableAutomaticCheckIns = enableAutomaticCheckIns;
   }
 
+  @ApiStatus.Experimental
   public void setIgnoredCheckIns(final @Nullable List<String> ignoredCheckIns) {
     if (ignoredCheckIns == null) {
       this.ignoredCheckIns = null;
@@ -2198,6 +2201,7 @@ public void setIgnoredCheckIns(final @Nullable List<String> ignoredCheckIns) {
     }
   }
 
+  @ApiStatus.Experimental
   public @Nullable List<String> getIgnoredCheckIns() {
     return ignoredCheckIns;
   }