upstream: b=main,r=d55c5224aa2fb5615acba07367f7da5125d10003,t=2024-03…

…-08-1342-44396

components/nexus-blobstore-api/src/main/java/org/sonatype/nexus/blobstore/api/BlobStore.java

@@ -22,6 +22,7 @@
 import javax.annotation.Nullable;
 
 import org.sonatype.goodies.lifecycle.Lifecycle;
+import org.sonatype.nexus.blobstore.api.metrics.BlobStoreMetricsService;
 import org.sonatype.nexus.transaction.TransactionalStore;
 
 import com.google.common.annotations.VisibleForTesting;
@@ -196,6 +197,15 @@ default Blob makeBlobPermanent(final BlobId blobId, final Map<String, String> he
    */
   boolean deleteHard(BlobId blobId);
 
+  /**
+   * Provides access to the blob store's metrics service instance
+   * <p>
+   * Note: this method may not be available for all the blob store implementations
+   * and, if not supported, expect a {@link UnsupportedOperationException}
+   * </p>
+   */
+  BlobStoreMetricsService getMetricsService();
+
   /**
    * Provides an immutable snapshot of metrics about the BlobStore's usage.
    */
@@ -264,6 +274,7 @@ default Blob makeBlobPermanent(final BlobId blobId, final Map<String, String> he
   /**
    * Get {@link BlobAttributes} for the {@link BlobId} provided.
    */
+  @Nullable
   BlobAttributes getBlobAttributes(BlobId blobId);
 
   /**

components/nexus-blobstore-api/src/main/java/org/sonatype/nexus/blobstore/api/metrics/BlobStoreMetricsService.java

@@ -38,7 +38,7 @@ public interface BlobStoreMetricsService
   void setBlobStore(BlobStore blobStore);
 
   /**
-   * Record a new blob being added to the blobstore.
+   * Record a new blob being added to the blob store.
    *
    * @param size Size of the newly added blob in bytes.
    */
@@ -61,6 +61,11 @@ public interface BlobStoreMetricsService
    */
   Map<OperationType, OperationMetrics> getOperationMetricsDelta();
 
+  /**
+   * Reset the total metrics (blob count / size)
+   */
+  void clearCountMetrics();
+
   /**
    * Reset the operational metrics.
    */

components/nexus-blobstore-api/src/main/java/org/sonatype/nexus/blobstore/api/metrics/BlobStoreMetricsStore.java

@@ -37,6 +37,12 @@ public interface BlobStoreMetricsStore
    */
   void clearOperationMetrics(String blobStoreName);
 
+  /**
+   * Clear the summary metrics for the given blob store name.
+   * (total size , blob count)
+   */
+  void clearCountMetrics(String blobStoreName);
+
   /**
    * Initialize the metrics for the given blobstore.
    */

components/nexus-blobstore-file/src/main/java/org/sonatype/nexus/blobstore/file/FileBlobStore.java

@@ -61,6 +61,7 @@
 import org.sonatype.nexus.blobstore.api.OperationMetrics;
 import org.sonatype.nexus.blobstore.api.OperationType;
 import org.sonatype.nexus.blobstore.api.RawObjectAccess;
+import org.sonatype.nexus.blobstore.api.metrics.BlobStoreMetricsService;
 import org.sonatype.nexus.blobstore.file.internal.BlobCollisionException;
 import org.sonatype.nexus.blobstore.file.internal.FileOperations;
 import org.sonatype.nexus.blobstore.metrics.MonitoringBlobStoreMetrics;
@@ -165,7 +166,7 @@ public class FileBlobStore
 
   private Path basedir;
 
-  private FileBlobStoreMetricsService metricsStore;
+  private FileBlobStoreMetricsService metricsService;
 
   private LoadingCache<BlobId, FileBlob> liveBlobs;
 
@@ -190,7 +191,7 @@ public FileBlobStore(
       final BlobIdLocationResolver blobIdLocationResolver,
       final FileOperations fileOperations,
       final ApplicationDirectories applicationDirectories,
-      final FileBlobStoreMetricsService metricsStore,
+      final FileBlobStoreMetricsService metricsService,
       final NodeAccess nodeAccess,
       final DryRunPrefix dryRunPrefix,
       final BlobStoreReconciliationLogger reconciliationLogger,
@@ -201,7 +202,7 @@ public FileBlobStore(
     super(blobIdLocationResolver, dryRunPrefix);
     this.fileOperations = checkNotNull(fileOperations);
     this.applicationDirectories = checkNotNull(applicationDirectories);
-    this.metricsStore = checkNotNull(metricsStore);
+    this.metricsService = checkNotNull(metricsService);
     this.nodeAccess = checkNotNull(nodeAccess);
     this.supportsHardLinkCopy = true;
     this.supportsAtomicMove = true;
@@ -216,7 +217,7 @@ public FileBlobStore(
       final Path contentDir, //NOSONAR
       final BlobIdLocationResolver blobIdLocationResolver,
       final FileOperations fileOperations,
-      final FileBlobStoreMetricsService metricsStore,
+      final FileBlobStoreMetricsService metricsService,
       final BlobStoreConfiguration configuration,
       final ApplicationDirectories directories,
       final NodeAccess nodeAccess,
@@ -227,7 +228,7 @@ public FileBlobStore(
       final FileBlobDeletionIndex blobDeletionIndex)
 
   {
-    this(blobIdLocationResolver, fileOperations, directories, metricsStore, nodeAccess, dryRunPrefix,
+    this(blobIdLocationResolver, fileOperations, directories, metricsService, nodeAccess, dryRunPrefix,
         reconciliationLogger, pruneEmptyDirectoryAge, blobStoreQuotaUsageChecker, blobDeletionIndex);
     this.contentDir = checkNotNull(contentDir);
     this.blobStoreConfiguration = checkNotNull(configuration);
@@ -251,9 +252,9 @@ protected void doStart() throws Exception {
     }
     liveBlobs = CacheBuilder.newBuilder().weakValues().build(from(FileBlob::new));
     blobDeletionIndex.initIndex(metadata, this);
-    metricsStore.setStorageDir(storageDir);
-    metricsStore.setBlobStore(this);
-    metricsStore.start();
+    metricsService.setStorageDir(storageDir);
+    metricsService.setBlobStore(this);
+    metricsService.start();
 
     blobStoreQuotaUsageChecker.setBlobStore(this);
     blobStoreQuotaUsageChecker.start();
@@ -306,7 +307,7 @@ protected void doStop() throws Exception {
       blobDeletionIndex.stopIndex();
     }
     finally {
-      metricsStore.stop();
+      metricsService.stop();
       blobStoreQuotaUsageChecker.stop();
     }
   }
@@ -425,14 +426,14 @@ private Blob tryCreate(
         if (existingSize != null) {
           overwrite(temporaryBlobPath, blobPath);
           overwrite(temporaryAttributePath, attributePath);
-          metricsStore.recordDeletion(existingSize);
+          metricsService.recordDeletion(existingSize);
         }
         else {
           move(temporaryBlobPath, blobPath);
           move(temporaryAttributePath, attributePath);
         }
 
-        metricsStore.recordAddition(blobAttributes.getMetrics().getContentSize());
+        metricsService.recordAddition(blobAttributes.getMetrics().getContentSize());
 
         return blob;
       }
@@ -582,7 +583,7 @@ protected boolean doDeleteHard(final BlobId blobId) {
       delete(attributePath);
 
       if (blobDeleted && contentSize != null) {
-        metricsStore.recordDeletion(contentSize);
+        metricsService.recordDeletion(contentSize);
       }
 
       return blobDeleted;
@@ -604,25 +605,31 @@ private Long getContentSizeForDeletion(final BlobId blobId) {
         .orElse(null);
   }
 
+  @Override
+  @Guarded(by = STARTED)
+  public BlobStoreMetricsService getMetricsService() {
+    return metricsService;
+  }
+
   @Override
   @Guarded(by = STARTED)
   public BlobStoreMetrics getMetrics() {
-    return metricsStore.getMetrics();
+    return metricsService.getMetrics();
   }
 
   @Override
   public Map<OperationType, OperationMetrics> getOperationMetricsByType() {
-    return metricsStore.getOperationMetrics();
+    return metricsService.getOperationMetrics();
   }
 
   @Override
   public Map<OperationType, OperationMetrics> getOperationMetricsDelta() {
-    return metricsStore.getOperationMetricsDelta();
+    return metricsService.getOperationMetricsDelta();
   }
 
   @Override
   public void clearOperationMetrics() {
-    metricsStore.clearOperationMetrics();
+    metricsService.clearOperationMetrics();
   }
 
   @Override
@@ -824,7 +831,7 @@ private Path getConfiguredBlobStorePath() {
   @Guarded(by = {NEW, STOPPED, FAILED, SHUTDOWN})
   public void remove() {
     try {
-      metricsStore.remove();
+      metricsService.remove();
 
       Path blobDir = getAbsoluteBlobDir();
       FileUtils.deleteDirectory(reconciliationLogDir.toFile());
@@ -1195,6 +1202,6 @@ public RawObjectAccess getRawObjectAccess() {
   @Override
   @VisibleForTesting
   public void flushMetrics() throws IOException {
-    metricsStore.flush();
+    metricsService.flush();
   }
 }

components/nexus-blobstore-file/src/main/java/org/sonatype/nexus/blobstore/file/internal/FileBlobStoreDescriptor.java

@@ -31,7 +31,6 @@
 import org.sonatype.nexus.blobstore.file.FileBlobStore;
 import org.sonatype.nexus.blobstore.quota.BlobStoreQuotaService;
 import org.sonatype.nexus.common.app.ApplicationDirectories;
-import org.sonatype.nexus.common.upgrade.AvailabilityVersion;
 import org.sonatype.nexus.formfields.FormField;
 import org.sonatype.nexus.formfields.StringTextFormField;
 import org.sonatype.nexus.rest.ValidationErrorsException;
@@ -49,7 +48,6 @@
  *
  * @since 3.6
  */
-@AvailabilityVersion(from = "1.0")
 @Named(FileBlobStore.TYPE)
 public class FileBlobStoreDescriptor
     extends BlobStoreDescriptorSupport

components/nexus-blobstore/pom.xml

@@ -37,6 +37,7 @@
       <groupId>org.sonatype.nexus</groupId>
       <artifactId>nexus-blobstore-api</artifactId>
     </dependency>
+
     <dependency>
       <groupId>org.sonatype.nexus</groupId>
       <artifactId>nexus-thread</artifactId>

components/nexus-blobstore/src/main/java/org/sonatype/nexus/blobstore/BlobStoreDescriptor.java

@@ -22,7 +22,6 @@
 
 /**
  * Describes a blob store.
- * Note: Do not inject Map<String, BlobStoreDescriptors> and instead opt to use BlobStoreDescriptorProvider
  *
  * @since 3.6
  */

components/nexus-blobstore/src/main/java/org/sonatype/nexus/blobstore/BlobStoreMetricsStoreSupport.java

@@ -287,6 +287,12 @@ private void readProperties() {
     }
   }
 
+  @Override
+  public void clearCountMetrics() {
+    totalSize.set(0L);
+    blobCount.set(0L);
+  }
+
   @Override
   public void clearOperationMetrics() {
     getOperationMetricsDelta().values().forEach(OperationMetrics::clear);

components/nexus-blobstore/src/main/java/org/sonatype/nexus/blobstore/group/BlobStoreGroup.java

@@ -48,6 +48,7 @@
 import org.sonatype.nexus.blobstore.api.OperationType;
 import org.sonatype.nexus.blobstore.api.RawObjectAccess;
 import org.sonatype.nexus.blobstore.api.UnimplementedRawObjectAccess;
+import org.sonatype.nexus.blobstore.api.metrics.BlobStoreMetricsService;
 import org.sonatype.nexus.blobstore.group.internal.BlobStoreGroupMetrics;
 import org.sonatype.nexus.blobstore.group.internal.WriteToFirstMemberFillPolicy;
 import org.sonatype.nexus.blobstore.metrics.MonitoringBlobStoreMetrics;
@@ -277,6 +278,12 @@ public boolean deleteHard(final BlobId blobId) {
     }
   }
 
+  @Override
+  @Guarded(by = STARTED)
+  public BlobStoreMetricsService getMetricsService() {
+    throw new UnsupportedOperationException("metrics service is not available at a group level");
+  }
+
   @Override
   @Guarded(by = STARTED)
   public BlobStoreMetrics getMetrics() {

components/nexus-blobstore/src/main/java/org/sonatype/nexus/blobstore/group/internal/BlobStoreGroupDescriptor.java

@@ -33,7 +33,6 @@
 import org.sonatype.nexus.blobstore.group.BlobStoreGroupService;
 import org.sonatype.nexus.blobstore.group.FillPolicy;
 import org.sonatype.nexus.blobstore.quota.BlobStoreQuotaService;
-import org.sonatype.nexus.common.upgrade.AvailabilityVersion;
 import org.sonatype.nexus.formfields.ComboboxFormField;
 import org.sonatype.nexus.formfields.FormField;
 import org.sonatype.nexus.formfields.ItemselectFormField;
@@ -58,7 +57,6 @@
  *
  * @since 3.14
  */
-@AvailabilityVersion(from = "1.0")
 @Named(BlobStoreGroup.TYPE)
 public class BlobStoreGroupDescriptor
     extends BlobStoreDescriptorSupport

components/nexus-blobstore/src/main/java/org/sonatype/nexus/blobstore/metrics/DatastoreBlobStoreMetricsServiceSupport.java

@@ -158,6 +158,11 @@ public void flush() throws IOException {
     blobStoreMetricsStore.updateMetrics(blobStoreMetricsEntity);
   }
 
+  @Override
+  public void clearCountMetrics() {
+    blobStoreMetricsStore.clearCountMetrics(blobStore.getBlobStoreConfiguration().getName());
+  }
+
   @Override
   public void clearOperationMetrics() {
     datastoreBlobStoreMetricsContainer.getOperationMetricsDelta().values().forEach(OperationMetrics::clear);

components/nexus-capability/src/main/java/org/sonatype/nexus/capability/CapabilityDescriptor.java

@@ -21,7 +21,6 @@
 
 /**
  * Describes a capability (its type).
- * Note: Do not inject List<BlobStoreDescriptors> and instead opt to use DefaultCapabilityDescriptorProvider
  */
 public interface CapabilityDescriptor
 {