ppkarwasz commented on code in PR #2104: URL: https://github.com/apache/logging-log4j2/pull/2104#discussion_r1430031071
########## log4j-api/src/main/java/org/apache/logging/log4j/spi/recycler/RecyclerFactoryProvider.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.logging.log4j.spi.recycler; + +import edu.umd.cs.findbugs.annotations.Nullable; +import org.apache.logging.log4j.util.PropertyEnvironment; + +/** + * Contract for providing {@link RecyclerFactory} instances. + * + * @since 3.0.0 + */ +public interface RecyclerFactoryProvider { + + /** + * Denotes the value to be used while sorting recycler factory providers to determine the precedence order. + * Values will be sorted naturally, that is, lower values will imply higher precedence. + * + * @return the value to be used while sorting + */ + default int getOrder() { + return 100; + } + + /** + * The name of this recycler factory provider. + * Recycler factory providers are required to have unique names. + * + * @return the name of this recycler factory provider + */ + String getName(); Review Comment: In the future we might consider using `ServiceLoader.Provider<RecyclerFactory>` instead of this class and add an `@Named` and `@Order` annotation to the implementations of `RecyclerFactory`. We already have a `@Named` and `@Order` annotation in `log4j-core` and `log4j-plugins`. @jvz, what do you think? I could open an issue to explore this direction, although I don't have too much confidence in `ServiceLoader#stream`, which is the only way to obtain `ServiceLoader.Provider` instances: it is unable to skip faulty service implementations. ########## log4j-api/src/main/java/org/apache/logging/log4j/internal/recycler/ThreadLocalRecyclerFactoryProvider.java: ########## @@ -0,0 +1,125 @@ +/* + * 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.logging.log4j.internal.recycler; + +import static java.util.Objects.requireNonNull; +import static org.apache.logging.log4j.spi.recycler.Recycler.DEFAULT_CAPACITY; + +import aQute.bnd.annotation.spi.ServiceProvider; +import edu.umd.cs.findbugs.annotations.Nullable; +import java.util.Queue; +import java.util.function.Consumer; +import java.util.function.Supplier; +import org.apache.logging.log4j.spi.LoggingSystemProperty; +import org.apache.logging.log4j.spi.recycler.AbstractRecycler; +import org.apache.logging.log4j.spi.recycler.Recycler; +import org.apache.logging.log4j.spi.recycler.RecyclerFactory; +import org.apache.logging.log4j.spi.recycler.RecyclerFactoryProvider; +import org.apache.logging.log4j.util.PropertyEnvironment; + +/** + * A {@link Recycler} factory provider such that the recycler pools objects in a fixed-size queue stored in a {@link ThreadLocal}. + * <p> + * This strategy may not be appropriate in workloads where units of work are independent of operating system threads such as reactive streams, coroutines, or virtual threads. + * For such use cases, see {@link QueueingRecyclerFactoryProvider}. + * </p> + * + * @since 3.0.0 + */ +@ServiceProvider(RecyclerFactoryProvider.class) +public final class ThreadLocalRecyclerFactoryProvider implements RecyclerFactoryProvider { + + @Override + public int getOrder() { + return 700; + } + + @Override + public String getName() { + return "threadLocal"; + } + + @Nullable + @Override + public RecyclerFactory createForEnvironment(PropertyEnvironment environment) { + requireNonNull(environment, "environment"); + final boolean threadLocalEnabled = + environment.getBooleanProperty(LoggingSystemProperty.THREAD_LOCALS_ENABLE, true); + if (!threadLocalEnabled) { + return null; + } Review Comment: I would just drop (and document) the support for the `ThreadLocals.enable`. Unless I am mistaken it was only used in the recycling process, setting `ThreadLocals.enable=false` never disabled **all** thread locals. For example `ThreadContext` still used them. The `ThreadLocals.enable` property seems misleading and deprecated, since `Recycler.factory` replaces it. ########## log4j-api/src/main/java/org/apache/logging/log4j/spi/recycler/package-info.java: ########## @@ -0,0 +1,26 @@ +/* + * 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. + */ +/** + * Internal interfaces and classes to be used by authors of logging implementations or for internal use by + * API classes. + */ +@Export +@Version("2.20.1") Review Comment: ```suggestion @Version("3.0.0") ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
