danmuzi commented on code in PR #11796:
URL: https://github.com/apache/lucene/pull/11796#discussion_r984184997
##########
lucene/CHANGES.txt:
##########
@@ -98,6 +98,11 @@ API Changes
* GITHUB#11804: FacetsCollector#collect is no longer final, allowing
extension. (Greg Miller)
+New Features
+---------------------
+* GITHUB#11795: Add ByteWritesTrackingDirectoryWrapper to expose metrics for
bytes merged, flushed, and overall
+write amplification factor. (Marc D'Mello)
Review Comment:
Usually, when a new line is needed for a description in CHANGES.txt, two
whitespaces are added in front.
(see other multi-line description)
write amp... -> {space}{space}write amp...
##########
lucene/misc/src/java/org/apache/lucene/misc/store/ByteWritesTrackingDirectoryWrapper.java:
##########
@@ -0,0 +1,96 @@
+/*
+ * 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.lucene.misc.store;
+
+import java.io.IOException;
+import java.util.concurrent.atomic.AtomicLong;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.FilterDirectory;
+import org.apache.lucene.store.IOContext;
+import org.apache.lucene.store.IndexOutput;
+
+/** {@link FilterDirectory} that tracks write amplification factor */
+public final class ByteWritesTrackingDirectoryWrapper extends FilterDirectory {
+
+ private final AtomicLong flushedBytes = new AtomicLong();
+ private final AtomicLong mergedBytes = new AtomicLong();
+ public final boolean trackTempOutput;
+
+ public ByteWritesTrackingDirectoryWrapper(Directory in) {
+ this(in, false);
+ }
+ /**
+ * Constructor with option to track tempOutput
+ *
+ * @param in input Directory
+ * @param trackTempOutput if true, will also track temporary outputs created
by this directory
+ */
+ public ByteWritesTrackingDirectoryWrapper(Directory in, boolean
trackTempOutput) {
+ super(in);
+ this.trackTempOutput = trackTempOutput;
+ }
+
+ @Override
+ public IndexOutput createOutput(String name, IOContext ioContext) throws
IOException {
+ IndexOutput output = in.createOutput(name, ioContext);
+ return createByteTrackingOutput(output, ioContext.context);
+ }
+
+ @Override
+ public IndexOutput createTempOutput(String prefix, String suffix, IOContext
ioContext)
+ throws IOException {
+ IndexOutput output = in.createTempOutput(prefix, suffix, ioContext);
+ return trackTempOutput ? createByteTrackingOutput(output,
ioContext.context) : output;
+ }
+
+ private IndexOutput createByteTrackingOutput(IndexOutput output,
IOContext.Context context) {
+ switch (context) {
+ case FLUSH:
+ return new ByteTrackingIndexOutput(output, flushedBytes);
+ case MERGE:
+ return new ByteTrackingIndexOutput(output, mergedBytes);
+ case DEFAULT:
+ case READ:
+ default:
Review Comment:
DEFAULT and READ can be handled by default.
--
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...@lucene.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
