Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LocalTmpStorage for all services #17588

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add LocalTmpStorage for all services #17588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions processing/src/main/java/org/apache/druid/storage/local/LocalTmpStorage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
* 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.druid.storage.local;

import com.google.inject.Provider;
import org.apache.druid.java.util.common.FileUtils;

import java.io.File;

public interface LocalTmpStorage
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pretty similar to TempDirProducer ; to service this usecase maybe that could be enhanced with a lazy init and a getRoot ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TempDirProducer appears to have semantics around cleaning up with close(). That class is different from this class, this class is basically just a Config. It could be called a Config, but Rohan doesn't like the word config, so it got this name instead.

LocalTmpStorage is just delivering a location, nothing more, nothing less, it provides something that can be injected to get at a system-configured tmp storage location and is not intended to actually do anything beyond that. It probably deserves javadoc that describes that this class shouldn't be doing anything other than delivering configuration as it's just there to be an injectable configuration object.

It could absolutely make sense to have TempDirProducer depend on a LocalTmpStorage in order to get the tmp dir location that it's supposed to use.

{
/**
* Get a temporary directory.
*
* @return a temporary directory
*/
File getTmpDir();

class DefaultLocalTmpStorageProvider implements Provider<LocalTmpStorage>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doesn't seem like the system will prepare to clean up these files - wouldn't that will fill up the disk/create garabge?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tmpdir provided from this is just a location. Whether things are cleaned up or not is a question of the implementation. In general, most of the code that deals with tmp files cleans them up after itself and if it's not cleaning up after itself, that should either be intentional and have a design reason or it is a bug in the code that's dealing with the file, not a bug in the code that's delivering the location of the directory.

{
private final String prefix;

public DefaultLocalTmpStorageProvider(String prefix)
{
this.prefix = prefix;
}

@Override
public LocalTmpStorage get()
{
File tmpStorage = FileUtils.createTempDir(prefix);
return () -> tmpStorage;
}
}
}
5 changes: 5 additions & 0 deletions services/src/main/java/org/apache/druid/cli/CliBroker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
import org.apache.druid.server.router.TieredBrokerConfig;
import org.apache.druid.sql.calcite.schema.MetadataSegmentView;
import org.apache.druid.sql.guice.SqlModule;
import org.apache.druid.storage.local.LocalTmpStorage;
import org.apache.druid.timeline.PruneLoadSpec;
import org.eclipse.jetty.server.Server;

Expand Down Expand Up @@ -182,6 +183,10 @@ protected List<? extends Module> getModules()

Jerseys.addResource(binder, SelfDiscoveryResource.class);
LifecycleModule.registerKey(binder, Key.get(SelfDiscoveryResource.class));

binder.bind(LocalTmpStorage.class)
.toProvider(new LocalTmpStorage.DefaultLocalTmpStorageProvider("broker"))
.in(LazySingleton.class);
},
new LookupModule(),
new SqlModule()
Expand Down
5 changes: 5 additions & 0 deletions services/src/main/java/org/apache/druid/cli/CliCoordinator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@
import org.apache.druid.server.lookup.cache.LookupCoordinatorManagerConfig;
import org.apache.druid.server.metrics.ServiceStatusMonitor;
import org.apache.druid.server.router.TieredBrokerConfig;
import org.apache.druid.storage.local.LocalTmpStorage;
import org.eclipse.jetty.server.Server;
import org.joda.time.Duration;

Expand Down Expand Up @@ -293,6 +294,10 @@ public void configure(Binder binder)
binder.bind(CoordinatorCustomDutyGroups.class)
.toProvider(new CoordinatorCustomDutyGroupsProvider())
.in(LazySingleton.class);

binder.bind(LocalTmpStorage.class)
.toProvider(new LocalTmpStorage.DefaultLocalTmpStorageProvider("coordinator"))
.in(LazySingleton.class);
}

@Provides
Expand Down
5 changes: 5 additions & 0 deletions services/src/main/java/org/apache/druid/cli/CliHistorical.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
import org.apache.druid.server.http.SelfDiscoveryResource;
import org.apache.druid.server.initialization.jetty.JettyServerInitializer;
import org.apache.druid.server.metrics.QueryCountStatsProvider;
import org.apache.druid.storage.local.LocalTmpStorage;
import org.apache.druid.timeline.PruneLastCompactionState;
import org.eclipse.jetty.server.Server;

Expand Down Expand Up @@ -140,6 +141,10 @@ protected List<? extends Module> getModules()

Jerseys.addResource(binder, SelfDiscoveryResource.class);
LifecycleModule.registerKey(binder, Key.get(SelfDiscoveryResource.class));

binder.bind(LocalTmpStorage.class)
.toProvider(new LocalTmpStorage.DefaultLocalTmpStorageProvider("historical"))
.in(LazySingleton.class);
},
new LookupModule()
);
Expand Down
4 changes: 4 additions & 0 deletions services/src/main/java/org/apache/druid/cli/CliIndexer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@
import org.apache.druid.server.initialization.jetty.CliIndexerServerModule;
import org.apache.druid.server.initialization.jetty.JettyServerInitializer;
import org.apache.druid.server.metrics.IndexerTaskCountStatsProvider;
import org.apache.druid.storage.local.LocalTmpStorage;
import org.eclipse.jetty.server.Server;

import java.util.List;
Expand Down Expand Up @@ -196,6 +197,9 @@ public void configure(Binder binder)

Jerseys.addResource(binder, SelfDiscoveryResource.class);
LifecycleModule.registerKey(binder, Key.get(SelfDiscoveryResource.class));
binder.bind(LocalTmpStorage.class)
.toProvider(new LocalTmpStorage.DefaultLocalTmpStorageProvider("indexer"))
.in(LazySingleton.class);
}

@Provides
Expand Down
5 changes: 5 additions & 0 deletions services/src/main/java/org/apache/druid/cli/CliMiddleManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
import org.apache.druid.server.initialization.jetty.JettyServerInitializer;
import org.apache.druid.server.metrics.ServiceStatusMonitor;
import org.apache.druid.server.metrics.WorkerTaskCountStatsProvider;
import org.apache.druid.storage.local.LocalTmpStorage;
import org.apache.druid.timeline.PruneLastCompactionState;
import org.eclipse.jetty.server.Server;

Expand Down Expand Up @@ -184,6 +185,10 @@ public void configure(Binder binder)
LifecycleModule.registerKey(binder, Key.get(SelfDiscoveryResource.class));

configureIntermediaryData(binder);

binder.bind(LocalTmpStorage.class)
.toProvider(new LocalTmpStorage.DefaultLocalTmpStorageProvider("middle-manager"))
.in(LazySingleton.class);
}

private void configureIntermediaryData(Binder binder)
Expand Down
5 changes: 5 additions & 0 deletions services/src/main/java/org/apache/druid/cli/CliOverlord.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@
import org.apache.druid.server.security.AuthenticationUtils;
import org.apache.druid.server.security.Authenticator;
import org.apache.druid.server.security.AuthenticatorMapper;
import org.apache.druid.storage.local.LocalTmpStorage;
import org.apache.druid.tasklogs.TaskLogStreamer;
import org.apache.druid.tasklogs.TaskLogs;
import org.eclipse.jetty.rewrite.handler.RewriteHandler;
Expand Down Expand Up @@ -317,6 +318,10 @@ public void configure(Binder binder)

Jerseys.addResource(binder, SelfDiscoveryResource.class);
LifecycleModule.registerKey(binder, Key.get(SelfDiscoveryResource.class));

binder.bind(LocalTmpStorage.class)
.toProvider(new LocalTmpStorage.DefaultLocalTmpStorageProvider("overlord"))
.in(LazySingleton.class);
}

private void configureTaskStorage(Binder binder)
Expand Down
12 changes: 12 additions & 0 deletions services/src/main/java/org/apache/druid/cli/CliPeon.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@
import org.apache.druid.server.lookup.cache.LookupLoadingSpec;
import org.apache.druid.server.metrics.DataSourceTaskIdHolder;
import org.apache.druid.server.metrics.ServiceStatusMonitor;
import org.apache.druid.storage.local.LocalTmpStorage;
import org.apache.druid.tasklogs.TaskPayloadManager;
import org.eclipse.jetty.server.Server;

Expand Down Expand Up @@ -355,6 +356,17 @@ public BroadcastDatasourceLoadingSpec getBroadcastDatasourcesToLoad(final Task t
{
return task.getBroadcastDatasourceLoadingSpec();
}

@Provides
@LazySingleton
public LocalTmpStorage getLocalTmpStorage()
{
File tmpDir = new File(taskDirPath, "tmp");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cheddar : should we create the temporary storage per attempt? or should we share it across attempts for re-use of temp data?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's share it. The old default for cases where this would've been used is just java.io.tmpdir which was shared as well, so it shouldn't cause problems...

if (!tmpDir.mkdirs()) {
log.warn("Failed to create tmp directory [%s]", tmpDir);
}
return () -> tmpDir;
}
},
new QueryablePeonModule(),
new IndexingServiceInputSourceModule(),
Expand Down
5 changes: 5 additions & 0 deletions services/src/main/java/org/apache/druid/cli/CliRouter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
import org.apache.druid.server.router.TieredBrokerHostSelector;
import org.apache.druid.server.router.TieredBrokerSelectorStrategiesProvider;
import org.apache.druid.server.router.TieredBrokerSelectorStrategy;
import org.apache.druid.storage.local.LocalTmpStorage;
import org.eclipse.jetty.server.Server;

import java.util.List;
Expand Down Expand Up @@ -126,6 +127,10 @@ protected List<? extends Module> getModules()

Jerseys.addResource(binder, SelfDiscoveryResource.class);
LifecycleModule.registerKey(binder, Key.get(SelfDiscoveryResource.class));

binder.bind(LocalTmpStorage.class)
.toProvider(new LocalTmpStorage.DefaultLocalTmpStorageProvider("router"))
.in(LazySingleton.class);
},
new LookupSerdeModule()
);
Expand Down
Loading