com.netflix.priam.backupv2

Class SnapshotMetaTask

java.lang.Object

com.netflix.priam.scheduler.Task

com.netflix.priam.backup.AbstractBackup

com.netflix.priam.backupv2.SnapshotMetaTask

All Implemented Interfaces:

org.quartz.Job

@Singleton
public class SnapshotMetaTask
extends AbstractBackup

This service will run on CRON as specified by IBackupRestoreConfig.getSnapshotMetaServiceCronExpression() The intent of this service is to run a full snapshot on Cassandra, get the list of the SSTables on disk and then create a manifest.json file which will encapsulate the list of the files i.e. capture filesystem at a moment in time. This manifest.json file will ensure the true filesystem status is exposed (for external entities) and will be used in future for Priam Backup Version 2 where a file is not uploaded to backup file system unless SSTable has been modified. This will lead to huge reduction in storage costs and provide bandwidth back to Cassandra instead of creating/uploading snapshots. Note that this component will "try" to enqueue the files to upload, but no guarantee is provided. If the enqueue fails for any reason, it is considered "OK" as there will be another service pushing all the files in the queue for upload (think of this like a cleanup thread and will help us in "resuming" any failed backup for any reason). Created by aagrawal on 6/18/18.

Nested Class Summary

Nested classes/interfaces inherited from class com.netflix.priam.scheduler.Task

Task.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JOBNAME

Fields inherited from class com.netflix.priam.backup.AbstractBackup

SNAPSHOT_FOLDER

Fields inherited from class com.netflix.priam.scheduler.Task

status

Method Summary

Modifier and Type	Method and Description
void	execute()
java.lang.String	getName()
static TaskTimer	getTimer(IBackupRestoreConfig config) Interval between generating snapshot meta file using SnapshotMetaTask.
static boolean	isBackupEnabled(IBackupRestoreConfig backupRestoreConfig)
protected void	processColumnFamily(java.io.File backupDir) Process the columnfamily in a given snapshot/backup directory.
void	uploadFiles() Enqueue all the files for upload in the snapshot directory.

Methods inherited from class com.netflix.priam.backup.AbstractBackup

getBackupDirectories, getColumnFamily, getKeyspace, getSecondaryIndexDirectories, initiateBackup, isAReadableDirectory

Methods inherited from class com.netflix.priam.scheduler.Task

execute, getErrorCount, getExecutionCount, initialize, state

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JOBNAME

public static final java.lang.String JOBNAME

See Also:

Constant Field Values

Method Detail

getTimer

public static TaskTimer getTimer(IBackupRestoreConfig config)
                          throws java.lang.IllegalArgumentException

Interval between generating snapshot meta file using SnapshotMetaTask.

Parameters:

config - IBackupRestoreConfig.getSnapshotMetaServiceCronExpression() to get configuration details from priam. Use "-1" to disable the service.

Returns:

the timer to be used for snapshot meta service.

Throws:

java.lang.IllegalArgumentException - if the configuration is not set correctly or are not valid. This is to ensure we fail-fast.

isBackupEnabled

public static boolean isBackupEnabled(IBackupRestoreConfig backupRestoreConfig)
                               throws java.lang.Exception

Throws:

java.lang.Exception

uploadFiles

public void uploadFiles()

Enqueue all the files for upload in the snapshot directory. This will only enqueue the files and do not give guarantee as when they will be uploaded. It will only try to upload files which matches backup version 2.0 naming conventions.

execute

public void execute()
             throws java.lang.Exception

Specified by:

execute in class Task

Throws:

java.lang.Exception

getName

public java.lang.String getName()

Specified by:

getName in class Task

processColumnFamily

protected void processColumnFamily(java.io.File backupDir)
                            throws java.lang.Exception

Description copied from class: AbstractBackup

Process the columnfamily in a given snapshot/backup directory.

Specified by:

processColumnFamily in class AbstractBackup

Parameters:

backupDir - Location of the backup/snapshot directory in that columnfamily.

Throws:

java.lang.Exception - throws exception if there is any error in process the directory.