Jackie-Jiang commented on code in PR #8355: URL: https://github.com/apache/pinot/pull/8355#discussion_r864302884
########## pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/PinotUpsertRestletResource.java: ########## @@ -0,0 +1,153 @@ +/** + * 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.api.resources; + +import com.fasterxml.jackson.databind.node.ObjectNode; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiParam; +import java.io.IOException; +import java.util.List; +import javax.ws.rs.Consumes; +import javax.ws.rs.POST; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.QueryParam; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import org.apache.pinot.controller.api.exception.ControllerApplicationException; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.FieldSpec; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.spi.utils.JsonUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +@Api(tags = Constants.UPSERT_RESOURCE_TAG) +@Path("/") +public class PinotUpsertRestletResource { + + public static final Logger LOGGER = LoggerFactory.getLogger(PinotUpsertRestletResource.class); + + /** + * The API to estimate heap usage for a Pinot upsert table. + * + * Sample usage: provide tableConfig, tableSchema, and ColumnStats payload. + * + * The tool calculates heap usage by estimating total Key/Value space based on unique key combinations. + * It used the following formula + * ``` + * TotalHeapSize = uniqueCombinations * (BytesPerKey + BytesPerValue). + * ``` + * The following params need to be provided: + * ``` + * -schemaFile, it contains primary key information. + * -tableConfigFile, it contains upsertConfig, tablePartitionConfig etc. + * -columnStats, which stores column information, collected from kafka or staging pinot table. + * ``` + * For columns stats, we need to gather the following stats + * ``` + * -cardinality, a required information unique combination of primary keys. + * -primaryKeySize, it uses for calculating BytesPerKey. + * -comparisonColSize, it uses for calculating BytesPerValue. + * -partitionNums(optional), it uses for host assignment calculation. + * ``` + */ + @POST + @Path("/estimateHeapUsage") Review Comment: ```suggestion @Path("/upsert/estimateHeapUsage") ``` -- 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
