devmadhuu commented on code in PR #6231: URL: https://github.com/apache/ozone/pull/6231#discussion_r1495238483
########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, Review Comment: does this `searchPrefix` param value will be searched in prefix value path for existing in both leading and trailing prefix path ? or just leading or just trailing ? ########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, Review Comment: Can we keep default value as `/` for `searchPrefix` ? ########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, Review Comment: Can you put an example in comments javadoc, how this searchPrefix will be used. Is it a full path or just path after the bucket. Pls specify in javadoc. ########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, + @DefaultValue("10") @QueryParam("limit") int limit) + throws IOException { + + if (searchPrefix == null || searchPrefix.isEmpty()) { Review Comment: If we use default value, we might not need this. ########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, + @DefaultValue("10") @QueryParam("limit") int limit) + throws IOException { + + if (searchPrefix == null || searchPrefix.isEmpty()) { + return createBadRequestResponse( + "searchPrefix query parameter is required."); + } + List<OmKeyInfo> matchedKeys = new ArrayList<>(); + + for (BucketLayout layout : Arrays.asList( + BucketLayout.LEGACY, BucketLayout.FILE_SYSTEM_OPTIMIZED)) { + + Table<String, OmKeyInfo> openKeyTable = + omMetadataManager.getOpenKeyTable(layout); + try ( + TableIterator<String, ? extends Table.KeyValue<String, OmKeyInfo>> + keyIter = openKeyTable.iterator()) { + if (layout == BucketLayout.FILE_SYSTEM_OPTIMIZED) { + searchPrefix = convertToObjectPath(searchPrefix); + } + keyIter.seek(searchPrefix); + while (keyIter.hasNext() && matchedKeys.size() < limit) { + Table.KeyValue<String, OmKeyInfo> entry = keyIter.next(); + String key = entry.getKey(); + // Break if the key no longer matches the prefix + if (!key.startsWith(searchPrefix)) { + break; + } + OmKeyInfo omKeyInfo = entry.getValue(); + // Add it to the list of matched keys. + matchedKeys.add(omKeyInfo); + } + } catch (NullPointerException e) { + return noMatchedKeysResponse(searchPrefix); + } + } + if (matchedKeys.isEmpty()) { Review Comment: Can be slightly optimized. ``` if (!matchedKeys.isEmpty()) { return Response.ok(matchedKeys).build(); } return noMatchedKeysResponse(searchPrefix); ``` ########## hadoop-ozone/recon/src/test/java/org/apache/hadoop/ozone/recon/api/TestOMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,305 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.client.StandaloneReplicationConfig; +import org.apache.hadoop.hdds.protocol.proto.HddsProtos; +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.ozone.om.OMMetadataManager; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.om.helpers.OmVolumeArgs; +import org.apache.hadoop.ozone.recon.ReconTestInjector; +import org.apache.hadoop.ozone.recon.persistence.AbstractReconSqlDBTest; +import org.apache.hadoop.ozone.recon.persistence.ContainerHealthSchemaManager; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconStorageContainerManagerFacade; +import org.apache.hadoop.ozone.recon.spi.StorageContainerServiceProvider; +import org.apache.hadoop.ozone.recon.spi.impl.OzoneManagerServiceProviderImpl; +import org.apache.hadoop.ozone.recon.spi.impl.StorageContainerServiceProviderImpl; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; +import javax.ws.rs.core.Response; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.HashSet; +import java.util.List; +import java.util.Random; +import java.util.Set; + +import static org.apache.hadoop.ozone.recon.OMMetadataManagerTestUtils.getTestReconOmMetadataManager; +import static org.apache.hadoop.ozone.recon.OMMetadataManagerTestUtils.initializeNewOmMetadataManager; +import static org.apache.hadoop.ozone.recon.OMMetadataManagerTestUtils.getBucketLayout; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.Mockito.mock; + +/** + * Test for OMDBInsightSearchEndpoint. + */ +public class TestOMDBInsightSearchEndpoint extends AbstractReconSqlDBTest { + @TempDir + private Path temporaryFolder; + private OMMetadataManager omMetadataManager; + private ReconOMMetadataManager reconOMMetadataManager; + private OMDBInsightSearchEndpoint omdbInsightSearchEndpoint; + private Random random = new Random(); + private Set<Long> generatedIds = new HashSet<>(); + public TestOMDBInsightSearchEndpoint() { + super(); + } + + private long generateUniqueRandomLong() { + long newValue; + do { + newValue = random.nextLong(); + } while (generatedIds.contains(newValue)); + + generatedIds.add(newValue); + return newValue; + } + + @BeforeEach + public void setUp() throws Exception { + omMetadataManager = initializeNewOmMetadataManager( + Files.createDirectory(temporaryFolder.resolve( + "JunitOmMetadata")).toFile()); + reconOMMetadataManager = getTestReconOmMetadataManager(omMetadataManager, + Files.createDirectory(temporaryFolder.resolve( + "JunitOmMetadataTest")).toFile()); + ReconTestInjector reconTestInjector = + new ReconTestInjector.Builder(temporaryFolder.toFile()) + .withReconSqlDb() + .withReconOm(reconOMMetadataManager) + .withOmServiceProvider(mock(OzoneManagerServiceProviderImpl.class)) + .addBinding(OzoneStorageContainerManager.class, + ReconStorageContainerManagerFacade.class) + .withContainerDB() + .addBinding(StorageContainerServiceProvider.class, + mock(StorageContainerServiceProviderImpl.class)) + .addBinding(OMDBInsightEndpoint.class) + .addBinding(ContainerHealthSchemaManager.class) + .build(); + omdbInsightSearchEndpoint = reconTestInjector.getInstance( + OMDBInsightSearchEndpoint.class); + } + + @Test + public void testSearchOpenKeys() throws Exception { + // Create 3 keys in 'bucketOne' and 2 keys in 'bucketTwo' + for (int i = 1; i <= 3; i++) { + OmKeyInfo omKeyInfo = + getOmKeyInfo("sampleVol", "bucketOne", "key_" + i, true); + String keyPath = String.format("/sampleVol/%s/key_%d", "bucketOne", i); + reconOMMetadataManager.getOpenKeyTable(getBucketLayout()) + .put(keyPath, omKeyInfo); + } + + for (int i = 1; i <= 2; i++) { + OmKeyInfo omKeyInfo = + getOmKeyInfo("sampleVol", "bucketTwo", "key_" + i, true); + String keyPath = String.format("/sampleVol/%s/key_%d", "bucketTwo", i); + reconOMMetadataManager.getOpenKeyTable(getBucketLayout()) + .put(keyPath, omKeyInfo); + } + + // Search for keys in 'bucketOne' + String searchPrefixBucketOne = "/sampleVol/bucketOne/"; Review Comment: Pls add some test cases having `searchKey` excluding volume and bucket in path. ########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, + @DefaultValue("10") @QueryParam("limit") int limit) + throws IOException { + + if (searchPrefix == null || searchPrefix.isEmpty()) { + return createBadRequestResponse( + "searchPrefix query parameter is required."); + } + List<OmKeyInfo> matchedKeys = new ArrayList<>(); + + for (BucketLayout layout : Arrays.asList( + BucketLayout.LEGACY, BucketLayout.FILE_SYSTEM_OPTIMIZED)) { + + Table<String, OmKeyInfo> openKeyTable = + omMetadataManager.getOpenKeyTable(layout); + try ( + TableIterator<String, ? extends Table.KeyValue<String, OmKeyInfo>> + keyIter = openKeyTable.iterator()) { + if (layout == BucketLayout.FILE_SYSTEM_OPTIMIZED) { + searchPrefix = convertToObjectPath(searchPrefix); + } + keyIter.seek(searchPrefix); + while (keyIter.hasNext() && matchedKeys.size() < limit) { + Table.KeyValue<String, OmKeyInfo> entry = keyIter.next(); + String key = entry.getKey(); + // Break if the key no longer matches the prefix + if (!key.startsWith(searchPrefix)) { + break; + } + OmKeyInfo omKeyInfo = entry.getValue(); + // Add it to the list of matched keys. + matchedKeys.add(omKeyInfo); + } + } catch (NullPointerException e) { + return noMatchedKeysResponse(searchPrefix); + } + } + if (matchedKeys.isEmpty()) { + return noMatchedKeysResponse(searchPrefix); + } else { + return Response.ok(matchedKeys).build(); + } + } + + /** + * Converts a given key prefix to an object path for FSO buckets. + * The conversion is necessary because keys in FSO buckets are stored in a + * object format in the OpenFileTable, + * e.g., "/volumeId/bucketId/parentId/fileName/id -> KeyInfo". + * + * @param prevKeyPrefix The key prefix to convert. + * @return The object path for the given key prefix. + * @throws IOException if an error occurs during conversion. + */ + public String convertToObjectPath(String prevKeyPrefix) throws IOException { Review Comment: This method doesn't seem to be throwing IOException. ########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, + @DefaultValue("10") @QueryParam("limit") int limit) + throws IOException { + + if (searchPrefix == null || searchPrefix.isEmpty()) { + return createBadRequestResponse( + "searchPrefix query parameter is required."); + } + List<OmKeyInfo> matchedKeys = new ArrayList<>(); + + for (BucketLayout layout : Arrays.asList( + BucketLayout.LEGACY, BucketLayout.FILE_SYSTEM_OPTIMIZED)) { + + Table<String, OmKeyInfo> openKeyTable = + omMetadataManager.getOpenKeyTable(layout); + try ( + TableIterator<String, ? extends Table.KeyValue<String, OmKeyInfo>> + keyIter = openKeyTable.iterator()) { + if (layout == BucketLayout.FILE_SYSTEM_OPTIMIZED) { + searchPrefix = convertToObjectPath(searchPrefix); + } + keyIter.seek(searchPrefix); + while (keyIter.hasNext() && matchedKeys.size() < limit) { + Table.KeyValue<String, OmKeyInfo> entry = keyIter.next(); + String key = entry.getKey(); + // Break if the key no longer matches the prefix + if (!key.startsWith(searchPrefix)) { + break; + } + OmKeyInfo omKeyInfo = entry.getValue(); + // Add it to the list of matched keys. + matchedKeys.add(omKeyInfo); + } + } catch (NullPointerException e) { + return noMatchedKeysResponse(searchPrefix); Review Comment: This is not a good practice to catch specific RuntimeExceptions like this. Catch a generic CheckedException and instead of returning `No keys exist for the specified search prefix` response in case of exception, return something like "`Unexpected Error!!!`" along with 500 server code. ########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, + @DefaultValue("10") @QueryParam("limit") int limit) + throws IOException { + + if (searchPrefix == null || searchPrefix.isEmpty()) { + return createBadRequestResponse( + "searchPrefix query parameter is required."); + } + List<OmKeyInfo> matchedKeys = new ArrayList<>(); + + for (BucketLayout layout : Arrays.asList( + BucketLayout.LEGACY, BucketLayout.FILE_SYSTEM_OPTIMIZED)) { + + Table<String, OmKeyInfo> openKeyTable = + omMetadataManager.getOpenKeyTable(layout); + try ( + TableIterator<String, ? extends Table.KeyValue<String, OmKeyInfo>> + keyIter = openKeyTable.iterator()) { + if (layout == BucketLayout.FILE_SYSTEM_OPTIMIZED) { + searchPrefix = convertToObjectPath(searchPrefix); + } + keyIter.seek(searchPrefix); + while (keyIter.hasNext() && matchedKeys.size() < limit) { + Table.KeyValue<String, OmKeyInfo> entry = keyIter.next(); + String key = entry.getKey(); + // Break if the key no longer matches the prefix + if (!key.startsWith(searchPrefix)) { + break; + } + OmKeyInfo omKeyInfo = entry.getValue(); + // Add it to the list of matched keys. + matchedKeys.add(omKeyInfo); + } + } catch (NullPointerException e) { + return noMatchedKeysResponse(searchPrefix); + } + } + if (matchedKeys.isEmpty()) { + return noMatchedKeysResponse(searchPrefix); + } else { + return Response.ok(matchedKeys).build(); + } + } + + /** + * Converts a given key prefix to an object path for FSO buckets. + * The conversion is necessary because keys in FSO buckets are stored in a + * object format in the OpenFileTable, + * e.g., "/volumeId/bucketId/parentId/fileName/id -> KeyInfo". + * + * @param prevKeyPrefix The key prefix to convert. + * @return The object path for the given key prefix. + * @throws IOException if an error occurs during conversion. + */ + public String convertToObjectPath(String prevKeyPrefix) throws IOException { + if (prevKeyPrefix.isEmpty()) { + return ""; + } + + // Fetch the volumeID + try { + String[] names = parseRequestPath(normalizePath(prevKeyPrefix)); + String volumeName = names[0]; + String volumeKey = omMetadataManager.getVolumeKey(volumeName); + long volumeId = + omMetadataManager.getVolumeTable().getSkipCache(volumeKey).getObjectID(); + + if (names.length == 1) { + return constructObjectPathWithPrefix(volumeId); + } + + // Fetch the bucketID + String bucketName = names[1]; + String bucketKey = omMetadataManager.getBucketKey(volumeName, bucketName); + OmBucketInfo bucketInfo = + omMetadataManager.getBucketTable().getSkipCache(bucketKey); + long bucketId = bucketInfo.getObjectID(); + + if (names.length == 2) { + return constructObjectPathWithPrefix(volumeId, bucketId); + } + + // Fetch the intermediate parentID + BucketHandler handler = + getBucketHandler(reconNamespaceSummaryManager, omMetadataManager, + reconSCM, bucketInfo); + long parentId = getParentId(handler, names, bucketName, bucketId); + String keyName = names[names.length - 1]; + return constructObjectPathWithPrefix(volumeId, bucketId, parentId) + + OM_KEY_PREFIX + keyName; + } catch (IOException e) { + LOG.error("Error converting key prefix to object path: {}", prevKeyPrefix, + e); + return prevKeyPrefix; // Fallback to original prefix in case of exception + } catch (Exception e) { + LOG.error("Unexpected error during conversion: {}", prevKeyPrefix, e); + return prevKeyPrefix; + } + } + + private long getParentId(BucketHandler handler, String[] names, + String bucketName, long bucketId) + throws IOException { + String parentName = names[names.length - 2]; + if (bucketName.equals(parentName) && names.length == 3) { + return bucketId; + } + return handler.getDirObjectId(names, names.length - 1); + } + + /** + * Constructs an object path with the given IDs. + * + * @param ids The IDs to construct the object path with. + * @return The constructed object path. + */ + private String constructObjectPathWithPrefix(long... ids) { + StringBuilder pathBuilder = new StringBuilder(); + for (long id : ids) { + pathBuilder.append(OM_KEY_PREFIX).append(id); + } + return pathBuilder.toString(); + } + + /** + * Returns a response indicating that no keys matched the search prefix. + * + * @param searchPrefix The search prefix that was used. + * @return The response indicating that no keys matched the search prefix. + */ + private Response noMatchedKeysResponse(String searchPrefix) { Review Comment: You are not using this `searchPrefix` passed here. ########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, + @DefaultValue("10") @QueryParam("limit") int limit) + throws IOException { + + if (searchPrefix == null || searchPrefix.isEmpty()) { + return createBadRequestResponse( + "searchPrefix query parameter is required."); + } + List<OmKeyInfo> matchedKeys = new ArrayList<>(); + + for (BucketLayout layout : Arrays.asList( + BucketLayout.LEGACY, BucketLayout.FILE_SYSTEM_OPTIMIZED)) { + + Table<String, OmKeyInfo> openKeyTable = + omMetadataManager.getOpenKeyTable(layout); + try ( + TableIterator<String, ? extends Table.KeyValue<String, OmKeyInfo>> + keyIter = openKeyTable.iterator()) { + if (layout == BucketLayout.FILE_SYSTEM_OPTIMIZED) { + searchPrefix = convertToObjectPath(searchPrefix); + } + keyIter.seek(searchPrefix); + while (keyIter.hasNext() && matchedKeys.size() < limit) { Review Comment: Shouldn't it be `matchedKeys.size() <= limit` ? ########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, + @DefaultValue("10") @QueryParam("limit") int limit) + throws IOException { + + if (searchPrefix == null || searchPrefix.isEmpty()) { + return createBadRequestResponse( + "searchPrefix query parameter is required."); + } + List<OmKeyInfo> matchedKeys = new ArrayList<>(); + + for (BucketLayout layout : Arrays.asList( + BucketLayout.LEGACY, BucketLayout.FILE_SYSTEM_OPTIMIZED)) { Review Comment: Any reason we don't want to include OBS keys ? ########## hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/api/OMDBInsightSearchEndpoint.java: ########## @@ -0,0 +1,258 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.hadoop.ozone.recon.api; + +import org.apache.hadoop.hdds.scm.server.OzoneStorageContainerManager; +import org.apache.hadoop.hdds.utils.db.Table; +import org.apache.hadoop.hdds.utils.db.TableIterator; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.om.helpers.BucketLayout; +import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; +import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; +import org.apache.hadoop.ozone.recon.api.handlers.BucketHandler; +import org.apache.hadoop.ozone.recon.recovery.ReconOMMetadataManager; +import org.apache.hadoop.ozone.recon.scm.ReconContainerManager; +import org.apache.hadoop.ozone.recon.spi.ReconContainerMetadataManager; +import org.apache.hadoop.ozone.recon.spi.impl.ReconNamespaceSummaryManagerImpl; +import org.hadoop.ozone.recon.schema.tables.daos.GlobalStatsDao; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.inject.Inject; +import javax.ws.rs.DefaultValue; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.QueryParam; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX; +import static org.apache.hadoop.ozone.recon.api.handlers.BucketHandler.getBucketHandler; +import static org.apache.hadoop.ozone.recon.api.handlers.EntityHandler.parseRequestPath; + +/** + * REST endpoint for search implementation in OM DB Insight. + */ +@Path("/insights") +@Produces(MediaType.APPLICATION_JSON) +@AdminOnly +public class OMDBInsightSearchEndpoint { + + @Inject + private ContainerEndpoint containerEndpoint; + private OzoneStorageContainerManager reconSCM; + @Inject + private ReconContainerMetadataManager reconContainerMetadataManager; + private final ReconOMMetadataManager omMetadataManager; + private final ReconContainerManager containerManager; + private static final Logger LOG = + LoggerFactory.getLogger(OMDBInsightSearchEndpoint.class); + private final GlobalStatsDao globalStatsDao; + private ReconNamespaceSummaryManagerImpl reconNamespaceSummaryManager; + + + @Inject + public OMDBInsightSearchEndpoint(OzoneStorageContainerManager reconSCM, + ReconOMMetadataManager omMetadataManager, + GlobalStatsDao globalStatsDao, + ReconNamespaceSummaryManagerImpl + reconNamespaceSummaryManager) { + this.reconSCM = reconSCM; + this.containerManager = + (ReconContainerManager) reconSCM.getContainerManager(); + this.omMetadataManager = omMetadataManager; + this.globalStatsDao = globalStatsDao; + this.reconNamespaceSummaryManager = reconNamespaceSummaryManager; + } + + + /** + * Search for open keys in the OM DB Insight. + * + * @param searchPrefix The prefix to search for. + * @param limit The maximum number of keys to return. + * @return The response containing the matched keys. + * @throws IOException if an error occurs during the search. + */ + @GET + @Path("/openKeys/search") + public Response searchOpenKeys( + @QueryParam("searchPrefix") String searchPrefix, + @DefaultValue("10") @QueryParam("limit") int limit) + throws IOException { + + if (searchPrefix == null || searchPrefix.isEmpty()) { + return createBadRequestResponse( + "searchPrefix query parameter is required."); + } + List<OmKeyInfo> matchedKeys = new ArrayList<>(); + + for (BucketLayout layout : Arrays.asList( + BucketLayout.LEGACY, BucketLayout.FILE_SYSTEM_OPTIMIZED)) { + + Table<String, OmKeyInfo> openKeyTable = + omMetadataManager.getOpenKeyTable(layout); + try ( + TableIterator<String, ? extends Table.KeyValue<String, OmKeyInfo>> + keyIter = openKeyTable.iterator()) { + if (layout == BucketLayout.FILE_SYSTEM_OPTIMIZED) { + searchPrefix = convertToObjectPath(searchPrefix); + } + keyIter.seek(searchPrefix); + while (keyIter.hasNext() && matchedKeys.size() < limit) { + Table.KeyValue<String, OmKeyInfo> entry = keyIter.next(); + String key = entry.getKey(); + // Break if the key no longer matches the prefix + if (!key.startsWith(searchPrefix)) { + break; + } + OmKeyInfo omKeyInfo = entry.getValue(); + // Add it to the list of matched keys. + matchedKeys.add(omKeyInfo); + } + } catch (NullPointerException e) { + return noMatchedKeysResponse(searchPrefix); + } + } + if (matchedKeys.isEmpty()) { + return noMatchedKeysResponse(searchPrefix); + } else { + return Response.ok(matchedKeys).build(); + } + } + + /** + * Converts a given key prefix to an object path for FSO buckets. + * The conversion is necessary because keys in FSO buckets are stored in a + * object format in the OpenFileTable, + * e.g., "/volumeId/bucketId/parentId/fileName/id -> KeyInfo". + * + * @param prevKeyPrefix The key prefix to convert. + * @return The object path for the given key prefix. + * @throws IOException if an error occurs during conversion. + */ + public String convertToObjectPath(String prevKeyPrefix) throws IOException { + if (prevKeyPrefix.isEmpty()) { Review Comment: If we use default value, then this check or logic may not be needed. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
