vrajat commented on code in PR #14110: URL: https://github.com/apache/pinot/pull/14110#discussion_r1870717036
########## pinot-controller/src/main/java/org/apache/pinot/controller/cursors/ResponseStoreCleaner.java: ########## @@ -0,0 +1,222 @@ +/** + * 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 + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * 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.pinot.controller.cursors; + +import com.fasterxml.jackson.core.type.TypeReference; +import java.io.IOException; +import java.net.URI; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import java.util.concurrent.CompletionService; +import java.util.concurrent.Executor; +import java.util.concurrent.TimeUnit; +import java.util.function.Function; +import java.util.stream.Collectors; +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.lang3.tuple.Pair; +import org.apache.hc.client5.http.classic.methods.HttpDelete; +import org.apache.hc.client5.http.classic.methods.HttpGet; +import org.apache.hc.client5.http.classic.methods.HttpUriRequestBase; +import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; +import org.apache.hc.core5.http.io.entity.EntityUtils; +import org.apache.helix.model.InstanceConfig; +import org.apache.pinot.common.auth.AuthProviderUtils; +import org.apache.pinot.common.http.MultiHttpRequest; +import org.apache.pinot.common.http.MultiHttpRequestResponse; +import org.apache.pinot.common.metrics.ControllerMetrics; +import org.apache.pinot.common.response.CursorResponse; +import org.apache.pinot.common.response.broker.CursorResponseNative; +import org.apache.pinot.controller.ControllerConf; +import org.apache.pinot.controller.LeadControllerManager; +import org.apache.pinot.controller.api.resources.InstanceInfo; +import org.apache.pinot.controller.helix.core.PinotHelixResourceManager; +import org.apache.pinot.controller.helix.core.periodictask.ControllerPeriodicTask; +import org.apache.pinot.spi.auth.AuthProvider; +import org.apache.pinot.spi.utils.CommonConstants; +import org.apache.pinot.spi.utils.JsonUtils; +import org.apache.pinot.spi.utils.TimeUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +/** + * ResponseStoreCleaner periodically gets all responses stored in a response store and deletes the ones that have + * expired. From each broker, tt gets the list of responses. Each of the response has an expiration unix timestamp. + * If the current timestamp is greater, it calls a DELETE API for every response that has expired. + */ +public class ResponseStoreCleaner extends ControllerPeriodicTask<Void> { + private static final Logger LOGGER = LoggerFactory.getLogger(ResponseStoreCleaner.class); + private static final int TIMEOUT_MS = 3000; + private static final String QUERY_RESULT_STORE = "%s://%s:%d/responseStore"; + private static final String DELETE_QUERY_RESULT = "%s://%s:%d/responseStore/%s"; + // Used in tests to trigger the delete instead of waiting for the wall clock to move to an appropriate time. + public static final String CLEAN_AT_TIME = "response.store.cleaner.clean.at.ms"; + private final ControllerConf _controllerConf; + private final Executor _executor; + private final PoolingHttpClientConnectionManager _connectionManager; + private final AuthProvider _authProvider; + + public ResponseStoreCleaner(ControllerConf config, PinotHelixResourceManager pinotHelixResourceManager, + LeadControllerManager leadControllerManager, ControllerMetrics controllerMetrics, Executor executor, + PoolingHttpClientConnectionManager connectionManager) { + super("ResponseStoreCleaner", getFrequencyInSeconds(config), getInitialDelayInSeconds(config), + pinotHelixResourceManager, leadControllerManager, controllerMetrics); + _controllerConf = config; + _executor = executor; + _connectionManager = connectionManager; + _authProvider = + AuthProviderUtils.extractAuthProvider(config, CommonConstants.CursorConfigs.RESPONSE_STORE_AUTH_PREFIX); + } + + private static long getInitialDelayInSeconds(ControllerConf config) { + long initialDelay = config.getPeriodicTaskInitialDelayInSeconds(); + String responseStoreCleanerTaskInitialDelay = + config.getProperty(CommonConstants.CursorConfigs.RESPONSE_STORE_CLEANER_INITIAL_DELAY); + if (responseStoreCleanerTaskInitialDelay != null) { + initialDelay = TimeUnit.SECONDS.convert(TimeUtils.convertPeriodToMillis(responseStoreCleanerTaskInitialDelay), + TimeUnit.MILLISECONDS); + } + return initialDelay; + } + + private static long getFrequencyInSeconds(ControllerConf config) { + long frequencyInSeconds = TimeUnit.SECONDS.convert( + TimeUtils.convertPeriodToMillis(CommonConstants.CursorConfigs.DEFAULT_RESPONSE_STORE_CLEANER_FREQUENCY_PERIOD), + TimeUnit.MILLISECONDS); + String responseStoreCleanerTaskPeriod = + config.getProperty(CommonConstants.CursorConfigs.RESPONSE_STORE_CLEANER_FREQUENCY_PERIOD); + if (responseStoreCleanerTaskPeriod != null) { + frequencyInSeconds = TimeUnit.SECONDS.convert(TimeUtils.convertPeriodToMillis(responseStoreCleanerTaskPeriod), + TimeUnit.MILLISECONDS); + } + + return frequencyInSeconds; + } + + @Override + protected void processTables(List<String> tableNamesWithType, Properties periodicTaskProperties) { + long cleanAtMs = System.currentTimeMillis(); + String cleanAtMsStr = periodicTaskProperties.getProperty(CLEAN_AT_TIME); + if (cleanAtMsStr != null) { + cleanAtMs = Long.parseLong(cleanAtMsStr); + } + doClean(cleanAtMs); + } + + public void doClean(long currentTime) { + List<InstanceConfig> brokerList = _pinotHelixResourceManager.getAllBrokerInstanceConfigs(); + Map<String, InstanceInfo> brokers = new HashMap<>(); + for (InstanceConfig broker : brokerList) { + brokers.put(getInstanceKey(broker.getHostName(), broker.getPort()), + new InstanceInfo(broker.getInstanceName(), broker.getHostName(), Integer.parseInt(broker.getPort()))); + } + + try { + Map<String, String> requestHeaders = AuthProviderUtils.makeAuthHeadersMap(_authProvider); + + Map<String, List<CursorResponseNative>> brokerCursorsMap = getAllQueryResults(brokers, requestHeaders); + + String protocol = _controllerConf.getControllerBrokerProtocol(); + int portOverride = _controllerConf.getControllerBrokerPortOverride(); + + List<String> brokerUrls = new ArrayList<>(); + for (Map.Entry<String, List<CursorResponseNative>> entry : brokerCursorsMap.entrySet()) { + for (CursorResponse response : entry.getValue()) { + if (response.getExpirationTimeMs() <= currentTime) { + InstanceInfo broker = brokers.get(entry.getKey()); + int port = portOverride > 0 ? portOverride : broker.getPort(); + brokerUrls.add( + String.format(DELETE_QUERY_RESULT, protocol, broker.getHost(), port, response.getRequestId())); + } + } + Map<String, String> deleteStatus = getResponseMap(requestHeaders, brokerUrls, "DELETE", HttpDelete::new); Review Comment: i had assumed that shared storage is superior. However in production it hasnt been that useful. In a multi-broker setup, clients will connect to a broker and contacting the same broker for paging through is fine. Even if there is a load balancer/proxy, the response has the broker host/port to request the proxy to connect to a specific broker. The pinning mechanism may differ based on the proxy. So I am leaning towards a shared nothing model (even if underneath it is a shared storage). -- 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: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
