Mark CRONS feature experimental (#2944)

adinauer · web-flow · commit 7ef79c24c9ad · 2023-09-25T14:41:13.000+02:00
diff --git a/sentry-quartz/src/main/java/io/sentry/quartz/SentryJobListener.java b/sentry-quartz/src/main/java/io/sentry/quartz/SentryJobListener.java
@@ -12,6 +12,7 @@
 import io.sentry.protocol.SentryId;
 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;
@@ -26,6 +27,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/sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/checkin/SentryQuartzConfiguration.java b/sentry-spring-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/sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/checkin/SentrySchedulerFactoryBeanCustomizer.java b/sentry-spring-jakarta/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/sentry-spring/src/main/java/io/sentry/spring/checkin/SentrySchedulerFactoryBeanCustomizer.java b/sentry-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/NoOpSentryClient.java b/sentry/src/main/java/io/sentry/NoOpSentryClient.java
@@ -2,6 +2,7 @@
 
 import io.sentry.protocol.SentryId;
 import io.sentry.protocol.SentryTransaction;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -54,6 +55,7 @@ public SentryId captureEnvelope(@NotNull SentryEnvelope envelope, @Nullable Hint
   }
 
   @Override
+  @ApiStatus.Experimental
   public @NotNull SentryId captureCheckIn(
       @NotNull CheckIn checkIn, @Nullable Scope scope, @Nullable Hint hint) {
     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/SentryClient.java b/sentry/src/main/java/io/sentry/SentryClient.java
@@ -672,6 +672,7 @@ public void captureSession(final @NotNull Session session, final @Nullable Hint
   }
 
   @Override
+  @ApiStatus.Experimental
   public @NotNull SentryId captureCheckIn(
       @NotNull CheckIn checkIn, final @Nullable Scope scope, @Nullable Hint hint) {
     if (hint == null) {
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;
   }

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`import java.util.concurrent.ConcurrentHashMap;`
`9`	`9`	`import java.util.concurrent.CopyOnWriteArrayList;`
`10`	`10`	`import java.util.concurrent.CopyOnWriteArraySet;`
	`11`	`+import org.jetbrains.annotations.ApiStatus;`
`11`	`12`	`import org.jetbrains.annotations.NotNull;`
`12`	`13`	`import org.jetbrains.annotations.Nullable;`
`13`	`14`
`@@ -392,18 +393,22 @@ public void setSendModules(final @Nullable Boolean sendModules) {`
`392`	`393`	`this.sendModules = sendModules;`
`393`	`394`	`}`
`394`	`395`
	`396`	`+ @ApiStatus.Experimental`
`395`	`397`	`public @Nullable Boolean isEnableAutomaticCheckIns() {`
`396`	`398`	`return enableAutomaticCheckIns;`
`397`	`399`	`}`
`398`	`400`
	`401`	`+ @ApiStatus.Experimental`
`399`	`402`	`public void setEnableAutomaticCheckIns(final @Nullable Boolean enableAutomaticCheckIns) {`
`400`	`403`	`this.enableAutomaticCheckIns = enableAutomaticCheckIns;`
`401`	`404`	`}`
`402`	`405`
	`406`	`+ @ApiStatus.Experimental`
`403`	`407`	`public void setIgnoredCheckIns(final @Nullable List<String> ignoredCheckIns) {`
`404`	`408`	`this.ignoredCheckIns = ignoredCheckIns;`
`405`	`409`	`}`
`406`	`410`
	`411`	`+ @ApiStatus.Experimental`
`407`	`412`	`public @Nullable List<String> getIgnoredCheckIns() {`
`408`	`413`	`return ignoredCheckIns;`
`409`	`414`	`}`
Original file line number	Diff line number	Diff line change
`@@ -864,6 +864,7 @@ private Scope buildLocalScope(`
`864`	`864`	`}`
`865`	`865`
`866`	`866`	`@Override`
	`867`	`+ @ApiStatus.Experimental`
`867`	`868`	`public @NotNull SentryId captureCheckIn(final @NotNull CheckIn checkIn) {`
`868`	`869`	`SentryId sentryId = SentryId.EMPTY_ID;`
`869`	`870`	`if (!isEnabled()) {`
Original file line number	Diff line number	Diff line change
`@@ -253,6 +253,7 @@ public void reportFullyDisplayed() {`
`253`	`253`	`}`
`254`	`254`
`255`	`255`	`@Override`
	`256`	`+ @ApiStatus.Experimental`
`256`	`257`	`public @NotNull SentryId captureCheckIn(final @NotNull CheckIn checkIn) {`
`257`	`258`	`return Sentry.captureCheckIn(checkIn);`
`258`	`259`	`}`