eab148 commented on code in PR #6327: URL: https://github.com/apache/hbase/pull/6327#discussion_r1803425740
########## hbase-examples/src/main/java/org/apache/hadoop/hbase/coprocessor/example/row/stats/RowStatisticsCompactionObserver.java: ########## @@ -0,0 +1,321 @@ +/* + * 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.hadoop.hbase.coprocessor.example.row.stats; + +import static org.apache.hadoop.hbase.coprocessor.example.row.stats.utils.RowStatisticsTableUtil.CF; +import static org.apache.hadoop.hbase.coprocessor.example.row.stats.utils.RowStatisticsTableUtil.NAMESPACE; +import static org.apache.hadoop.hbase.coprocessor.example.row.stats.utils.RowStatisticsTableUtil.NAMESPACED_TABLE_NAME; +import static org.apache.hadoop.hbase.coprocessor.example.row.stats.utils.RowStatisticsTableUtil.TABLE_RECORDER_KEY; + +import java.io.IOException; +import java.time.Duration; +import java.util.Arrays; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ConcurrentMap; +import java.util.stream.Collectors; +import org.apache.hadoop.hbase.Cell; +import org.apache.hadoop.hbase.CellUtil; +import org.apache.hadoop.hbase.CoprocessorEnvironment; +import org.apache.hadoop.hbase.ExtendedCell; +import org.apache.hadoop.hbase.NamespaceDescriptor; +import org.apache.hadoop.hbase.RawCellBuilder; +import org.apache.hadoop.hbase.TableName; +import org.apache.hadoop.hbase.client.Admin; +import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor; +import org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder; +import org.apache.hadoop.hbase.client.TableDescriptor; +import org.apache.hadoop.hbase.client.TableDescriptorBuilder; +import org.apache.hadoop.hbase.coprocessor.MasterCoprocessor; +import org.apache.hadoop.hbase.coprocessor.MasterCoprocessorEnvironment; +import org.apache.hadoop.hbase.coprocessor.MasterObserver; +import org.apache.hadoop.hbase.coprocessor.ObserverContext; +import org.apache.hadoop.hbase.coprocessor.RegionCoprocessor; +import org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment; +import org.apache.hadoop.hbase.coprocessor.RegionObserver; +import org.apache.hadoop.hbase.coprocessor.example.row.stats.recorder.RowStatisticsRecorder; +import org.apache.hadoop.hbase.coprocessor.example.row.stats.recorder.RowStatisticsTableRecorder; +import org.apache.hadoop.hbase.coprocessor.example.row.stats.utils.RowStatisticsUtil; +import org.apache.hadoop.hbase.io.hfile.BlockCacheFactory; +import org.apache.hadoop.hbase.metrics.Counter; +import org.apache.hadoop.hbase.regionserver.InternalScanner; +import org.apache.hadoop.hbase.regionserver.ScanType; +import org.apache.hadoop.hbase.regionserver.ScannerContext; +import org.apache.hadoop.hbase.regionserver.Shipper; +import org.apache.hadoop.hbase.regionserver.Store; +import org.apache.hadoop.hbase.regionserver.compactions.CompactionLifeCycleTracker; +import org.apache.hadoop.hbase.regionserver.compactions.CompactionRequest; +import org.apache.yetus.audience.InterfaceAudience; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@InterfaceAudience.Private +public class RowStatisticsCompactionObserver + implements RegionCoprocessor, RegionObserver, MasterCoprocessor, MasterObserver { + + private static final Logger LOG = LoggerFactory.getLogger(RowStatisticsCompactionObserver.class); + + // From private field BucketAllocator.DEFAULT_BUCKET_SIZES + private static final long DEFAULT_MAX_BUCKET_SIZE = 512 * 1024 + 1024; + private static final ConcurrentMap<String, Long> TABLE_COUNTERS = new ConcurrentHashMap(); + private static final String ROW_STATISTICS_DROPPED = "rowStatisticsDropped"; + private static final String ROW_STATISTICS_PUT_FAILED = "rowStatisticsPutFailures"; + private Counter rowStatisticsDropped; + private Counter rowStatisticsPutFailed; + private long maxCacheSize; + private final RowStatisticsRecorder recorder; + private RowStatisticsTableRecorder tableRecorder; + + @InterfaceAudience.Private + public RowStatisticsCompactionObserver(RowStatisticsRecorder recorder) { + this.recorder = recorder; + this.tableRecorder = null; + } + + public RowStatisticsCompactionObserver() { + this(null); + } + + @Override + public Optional<RegionObserver> getRegionObserver() { + return Optional.of(this); + } + + @Override + public Optional<MasterObserver> getMasterObserver() { + return Optional.of(this); + } + + @Override + public void start(CoprocessorEnvironment e) throws IOException { + if (e instanceof RegionCoprocessorEnvironment) { + RegionCoprocessorEnvironment regionEnv = (RegionCoprocessorEnvironment) e; + if (RowStatisticsUtil.isInternalTable(regionEnv)) { + return; + } + + String[] configuredBuckets = + regionEnv.getConfiguration().getStrings(BlockCacheFactory.BUCKET_CACHE_BUCKETS_KEY); + maxCacheSize = DEFAULT_MAX_BUCKET_SIZE; + if (configuredBuckets != null && configuredBuckets.length > 0) { + String lastBucket = configuredBuckets[configuredBuckets.length - 1]; + try { + maxCacheSize = Integer.parseInt(lastBucket.trim()); + } catch (NumberFormatException ex) { + LOG.warn("Failed to parse {} value {} as int", BlockCacheFactory.BUCKET_CACHE_BUCKETS_KEY, + lastBucket, ex); + } + } + + rowStatisticsDropped = + regionEnv.getMetricRegistryForRegionServer().counter(ROW_STATISTICS_DROPPED); + rowStatisticsPutFailed = + regionEnv.getMetricRegistryForRegionServer().counter(ROW_STATISTICS_PUT_FAILED); + + TableName tableName = regionEnv.getRegionInfo().getTable(); + TABLE_COUNTERS.merge(tableName.getNameAsString(), 1L, Long::sum); + } + } + + @Override + public void stop(CoprocessorEnvironment e) throws IOException { + if (e instanceof RegionCoprocessorEnvironment) { + RegionCoprocessorEnvironment regionEnv = (RegionCoprocessorEnvironment) e; + if (RowStatisticsUtil.isInternalTable(regionEnv)) { + return; + } + TableName tableName = regionEnv.getRegionInfo().getTable(); + long tableCount = TABLE_COUNTERS.merge(tableName.getNameAsString(), -1L, Long::sum); + if (tableCount == 0) { + long regionCount = 0; + for (long count : TABLE_COUNTERS.values()) { + regionCount += count; + } + if (regionCount == 0) { + regionEnv.getMetricRegistryForRegionServer().remove(ROW_STATISTICS_DROPPED, + rowStatisticsDropped); + regionEnv.getMetricRegistryForRegionServer().remove(ROW_STATISTICS_PUT_FAILED, + rowStatisticsPutFailed); + boolean removed = regionEnv.getSharedData().remove(TABLE_RECORDER_KEY, tableRecorder); + if (removed) { + tableRecorder.close(); + } + } + } + } + } + + @Override + public void postStartMaster(ObserverContext<MasterCoprocessorEnvironment> ctx) + throws IOException { + try (Admin admin = ctx.getEnvironment().getConnection().getAdmin()) { + if (admin.tableExists(NAMESPACED_TABLE_NAME)) { + LOG.info("Table {} already exists. Skipping table creation process.", + NAMESPACED_TABLE_NAME); + } else { + boolean shouldCreateNamespace = + Arrays.stream(admin.listNamespaces()).filter(namespace -> namespace.equals(NAMESPACE)) + .collect(Collectors.toUnmodifiableSet()).isEmpty(); + if (shouldCreateNamespace) { + NamespaceDescriptor nd = NamespaceDescriptor.create(NAMESPACE).build(); + try { + admin.createNamespace(nd); + } catch (IOException e) { + LOG.error("Failed to create namespace {}", NAMESPACE, e); + } + } + ColumnFamilyDescriptor cfd = ColumnFamilyDescriptorBuilder.newBuilder(CF).setMaxVersions(25) Review Comment: 25 versions was chosen pretty randomly. It let us have a history of row statistics for a given region in case we wanted to investigate how the stats changed over time. We haven't leveraged this versioning for any particular use case at my day job yet. I'd be open to setting the versioning to 1 (or honestly any value) if you'd prefer. -- 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: issues-unsubscr...@hbase.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
