mdmarshmallow commented on code in PR #11796: URL: https://github.com/apache/lucene/pull/11796#discussion_r977019915
########## lucene/core/src/java/org/apache/lucene/store/ByteTrackingIndexOutput.java: ########## @@ -0,0 +1,70 @@ +/* + * 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.store; + +import java.io.IOException; +import java.util.concurrent.atomic.AtomicLong; + +/** An {@link IndexOutput} that wraps another instance and tracks the number of bytes written */ +public class ByteTrackingIndexOutput extends IndexOutput { + + private final IndexOutput output; + private final AtomicLong byteTracker; + + protected ByteTrackingIndexOutput(IndexOutput output, AtomicLong byteTracker) { + super( + "Byte tracking wrapper for: " + output.getName(), + "ByteTrackingIndexOutput{" + output.getName() + "}"); + this.output = output; + this.byteTracker = byteTracker; + } + + @Override + public void writeByte(byte b) throws IOException { + byteTracker.incrementAndGet(); + output.writeByte(b); + } + + @Override + public void writeBytes(byte[] b, int offset, int length) throws IOException { + byteTracker.addAndGet(length); + output.writeBytes(b, offset, length); + } + + @Override + public void close() throws IOException { + output.close(); + } + + @Override + public long getFilePointer() { + return output.getFilePointer(); + } + + @Override + public long getChecksum() throws IOException { + return output.getChecksum(); + } + + public String getWrappedName() { Review Comment: `super#getName()` and `super#toString()` would give us the name and String representation of this class. I made these in case someone wants the access the wrapped class's name and String representation. With that being said, I'm not really sure how useful these two methods would be. I could remove them? ########## lucene/core/src/java/org/apache/lucene/store/ByteTrackingIndexOutput.java: ########## @@ -0,0 +1,70 @@ +/* + * 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.store; + +import java.io.IOException; +import java.util.concurrent.atomic.AtomicLong; + +/** An {@link IndexOutput} that wraps another instance and tracks the number of bytes written */ +public class ByteTrackingIndexOutput extends IndexOutput { + + private final IndexOutput output; + private final AtomicLong byteTracker; + + protected ByteTrackingIndexOutput(IndexOutput output, AtomicLong byteTracker) { + super( + "Byte tracking wrapper for: " + output.getName(), + "ByteTrackingIndexOutput{" + output.getName() + "}"); + this.output = output; + this.byteTracker = byteTracker; + } + + @Override + public void writeByte(byte b) throws IOException { + byteTracker.incrementAndGet(); Review Comment: Unfortunately, there is no pure `increment()` method: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html ########## lucene/core/src/java/org/apache/lucene/store/WriteAmplificationTrackingDirectoryWrapper.java: ########## @@ -0,0 +1,59 @@ +/* + * 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.store; + +import java.io.IOException; +import java.util.concurrent.atomic.AtomicLong; + +/** {@link FilterDirectory} that tracks write amplification factor */ +public final class WriteAmplificationTrackingDirectoryWrapper extends FilterDirectory { + + private final AtomicLong flushedBytes = new AtomicLong(); + private final AtomicLong mergedBytes = new AtomicLong(); + + /** + * Sole constructor, typically called from sub-classes. + * + * @param in input Directory + */ + public WriteAmplificationTrackingDirectoryWrapper(Directory in) { + super(in); + } + + @Override + public IndexOutput createOutput(String name, IOContext context) throws IOException { + IndexOutput output = in.createOutput(name, context); + IndexOutput byteTrackingIndexOutput; + if (context.context.equals(IOContext.Context.FLUSH)) { + byteTrackingIndexOutput = new ByteTrackingIndexOutput(output, flushedBytes); + } else if (context.context.equals(IOContext.Context.MERGE)) { + byteTrackingIndexOutput = new ByteTrackingIndexOutput(output, mergedBytes); + } else { + return output; + } + return byteTrackingIndexOutput; + } + + public double getApproximateWriteAmplificationFactor() { Review Comment: That's true, but is there ever a case where we would have two directories open for some reason or another? Then we'd have to think about this a bit more if we want to merge the write amplification factors or not. ########## lucene/core/src/java/org/apache/lucene/store/ByteTrackingIndexOutput.java: ########## @@ -0,0 +1,70 @@ +/* + * 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.store; + +import java.io.IOException; +import java.util.concurrent.atomic.AtomicLong; + +/** An {@link IndexOutput} that wraps another instance and tracks the number of bytes written */ +public class ByteTrackingIndexOutput extends IndexOutput { + + private final IndexOutput output; + private final AtomicLong byteTracker; + + protected ByteTrackingIndexOutput(IndexOutput output, AtomicLong byteTracker) { + super( + "Byte tracking wrapper for: " + output.getName(), + "ByteTrackingIndexOutput{" + output.getName() + "}"); + this.output = output; + this.byteTracker = byteTracker; + } + + @Override + public void writeByte(byte b) throws IOException { + byteTracker.incrementAndGet(); + output.writeByte(b); + } + + @Override + public void writeBytes(byte[] b, int offset, int length) throws IOException { + byteTracker.addAndGet(length); + output.writeBytes(b, offset, length); + } + + @Override + public void close() throws IOException { Review Comment: Since this is just a wrapper that we need to hold another `IndexOutput` (and instantiate so abstract classes won't work here), I'm not really sure how we could change this. ########## lucene/core/src/java/org/apache/lucene/store/WriteAmplificationTrackingDirectoryWrapper.java: ########## @@ -0,0 +1,59 @@ +/* + * 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.store; + +import java.io.IOException; +import java.util.concurrent.atomic.AtomicLong; + +/** {@link FilterDirectory} that tracks write amplification factor */ +public final class WriteAmplificationTrackingDirectoryWrapper extends FilterDirectory { + + private final AtomicLong flushedBytes = new AtomicLong(); + private final AtomicLong mergedBytes = new AtomicLong(); + + /** + * Sole constructor, typically called from sub-classes. + * + * @param in input Directory + */ + public WriteAmplificationTrackingDirectoryWrapper(Directory in) { + super(in); + } + + @Override + public IndexOutput createOutput(String name, IOContext context) throws IOException { + IndexOutput output = in.createOutput(name, context); + IndexOutput byteTrackingIndexOutput; + if (context.context.equals(IOContext.Context.FLUSH)) { Review Comment: Will do. -- 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
