[
https://issues.apache.org/jira/browse/FLINK-10423?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16650232#comment-16650232
]
ASF GitHub Bot commented on FLINK-10423:
----------------------------------------
sjwiesman commented on a change in pull request #6814:
[FLINK-10423][rocksdb][metrics] rocksdb native metrics monitor
URL: https://github.com/apache/flink/pull/6814#discussion_r225171804
##########
File path:
flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBNativeMetricMonitor.java
##########
@@ -0,0 +1,134 @@
+/*
+ * 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.flink.contrib.streaming.state;
+
+import org.apache.flink.annotation.Internal;
+import org.apache.flink.metrics.Gauge;
+import org.apache.flink.metrics.MetricGroup;
+import org.apache.flink.metrics.View;
+import org.apache.flink.runtime.metrics.groups.OperatorMetricGroup;
+
+import org.rocksdb.ColumnFamilyHandle;
+import org.rocksdb.RocksDB;
+import org.rocksdb.RocksDBException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.annotation.Nonnull;
+
+import java.io.Closeable;
+
+/**
+ * A monitor which pull {{@link RocksDB}} native metrics
+ * and forwards them to Flink's metric group. All metrics are
+ * unsigned longs and are reported at the column family level.
+ */
+@Internal
+public class RocksDBNativeMetricMonitor implements Closeable {
+ private static final Logger LOG =
LoggerFactory.getLogger(RocksDBNativeMetricMonitor.class);
+
+ private final RocksDBNativeMetricOptions options;
+
+ private final OperatorMetricGroup metricGroup;
+
+ private final Object lock;
+
+ private RocksDB rocksDB;
+
+ RocksDBNativeMetricMonitor(
+ @Nonnull RocksDB rocksDB,
+ @Nonnull RocksDBNativeMetricOptions options,
+ @Nonnull OperatorMetricGroup metricGroup
+ ) {
+ this.options = options;
+ this.metricGroup = metricGroup;
+ this.rocksDB = rocksDB;
+
+ this.lock = new Object();
+ }
+
+ /**
+ * Register gauges to pull native metrics for the column family.
+ * @param columnFamilyName group name for the new gauges
+ * @param handle native handle to the column family
+ */
+ void registerColumnFamily(String columnFamilyName, ColumnFamilyHandle
handle) {
+ MetricGroup group = metricGroup.addGroup(columnFamilyName);
+
+ for (String property : options.getProperties()) {
+ RocksDBNativeMetricView gauge = new
RocksDBNativeMetricView(handle, property);
+ group.gauge(property, gauge);
+ }
+ }
+
+ /**
+ * Updates the value of metricView if the reference is still valid.
+ */
+ private void setProperty(ColumnFamilyHandle handle, String property,
RocksDBNativeMetricView metricView) {
+ try {
+ synchronized (lock) {
+ if (rocksDB != null) {
+ long value =
rocksDB.getLongProperty(handle, property);
+ metricView.setValue(value);
+ }
+ }
+ } catch (RocksDBException e) {
+ LOG.warn("Failed to read native metric %s from
RocksDB", property, e);
+ }
+ }
+
+ @Override
+ public void close() {
+ synchronized (lock) {
+ this.rocksDB = null;
+ }
+ }
+
+ class RocksDBNativeMetricView implements Gauge<String>, View {
+ private final String property;
+
+ private final ColumnFamilyHandle handle;
+
+
+ private long value;
+
+ private RocksDBNativeMetricView(
+ @Nonnull ColumnFamilyHandle handle,
+ @Nonnull String property
+ ) {
+ this.handle = handle;
+ this.property = property;
+ }
+
+ public void setValue(long value) {
+ this.value = value;
+ }
+
+ @Override
+ public String getValue() {
+ return Long.toUnsignedString(value);
Review comment:
adding a comment
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Forward RocksDB native metrics to Flink metrics reporter
> ---------------------------------------------------------
>
> Key: FLINK-10423
> URL: https://issues.apache.org/jira/browse/FLINK-10423
> Project: Flink
> Issue Type: New Feature
> Components: Metrics, State Backends, Checkpointing
> Reporter: Seth Wiesman
> Assignee: Seth Wiesman
> Priority: Major
> Labels: pull-request-available
>
> RocksDB contains a number of metrics at the column family level about current
> memory usage, open memtables, etc that would be useful to users wishing
> greater insight what rocksdb is doing. This work is inspired heavily by the
> comments on this rocksdb issue thread
> (https://github.com/facebook/rocksdb/issues/3216#issuecomment-348779233)
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
