def database_s3_backup(self, *args, **kwargs):
"""
Uploads a PostgreSQL file cluster to S3
Mechanism: just wraps _s3_upload_pg_cluster_dir with
start/stop backup actions with exception handling.
In particular there is a 'finally' block to stop the backup in
most situations.
"""
upload_good = False
backup_stop_good = False
try:
start_backup_info = PgBackupStatements.run_start_backup()
version = PgBackupStatements.pg_version()['version']
uploaded_to, expanded_size_bytes = self._s3_upload_pg_cluster_dir(
start_backup_info, version=version, *args, **kwargs)
upload_good = True
finally:
if not upload_good:
logger.warning(
'blocking on sending WAL segments',
detail=('The backup was not completed successfully, '
'but we have to wait anyway. '
'See README: TODO about pg_cancel_backup'))
stop_backup_info = PgBackupStatements.run_stop_backup()
backup_stop_good = True
if upload_good and backup_stop_good:
# Make a best-effort attempt to write a sentinel file to
# the cluster backup directory that indicates that the
# base backup upload has definitely run its course (it may
# have, even without this file, though) and also
# communicates what WAL segments are needed to get to
# consistency.
try:
sentinel_content = StringIO()
json.dump(
{'wal_segment_backup_stop':
stop_backup_info['file_name'],
'wal_segment_offset_backup_stop':
stop_backup_info['file_offset'],
'expanded_size_bytes': expanded_size_bytes},
sentinel_content)
# XXX: distinguish sentinels by *PREFIX* not suffix,
# which makes searching harder. (For the next version
# bump).
s3_worker.uri_put_file(
uploaded_to + '_backup_stop_sentinel.json',
sentinel_content, content_encoding='application/json')
except KeyboardInterrupt, e:
# Specially re-raise exception on SIGINT to allow
# propagation.
raise
except:
def database_s3_backup(self, data_directory, *args, **kwargs):
"""Uploads a PostgreSQL file cluster to S3
Mechanism: just wraps _s3_upload_pg_cluster_dir with
start/stop backup actions with exception handling.
In particular there is a 'finally' block to stop the backup in
most situations.
"""
upload_good = False
backup_stop_good = False
while_offline = False
start_backup_info = None
if 'while_offline' in kwargs:
while_offline = kwargs.pop('while_offline')
try:
if not while_offline:
start_backup_info = PgBackupStatements.run_start_backup()
version = PgBackupStatements.pg_version()['version']
else:
if os.path.exists(os.path.join(data_directory,
'postmaster.pid')):
hint = ('Shut down postgres. '
'If there is a stale lockfile, '
'then remove it after being very sure postgres '
'is not running.')
raise UserException(
msg='while_offline set, but pg looks to be running',
detail='Found a postmaster.pid lockfile, and aborting',
hint=hint)
controldata = PgControlDataParser(data_directory)
start_backup_info = \
controldata.last_xlog_file_name_and_offset()
version = controldata.pg_version()
uploaded_to, expanded_size_bytes = self._s3_upload_pg_cluster_dir(
start_backup_info, data_directory, version=version,
*args, **kwargs)
upload_good = True
finally:
if not upload_good:
logger.warning(
'blocking on sending WAL segments',
detail=('The backup was not completed successfully, '
'but we have to wait anyway. '
'See README: TODO about pg_cancel_backup'))
if not while_offline:
stop_backup_info = PgBackupStatements.run_stop_backup()
else:
stop_backup_info = start_backup_info
backup_stop_good = True
# XXX: Ugly, this is more of a 'worker' task because it might
# involve retries and error messages, something that is not
# treated by the "operator" category of modules. So
# basically, if this small upload fails, the whole upload
# fails!
if upload_good and backup_stop_good:
# Try to write a sentinel file to the cluster backup
# directory that indicates that the base backup upload has
# definitely run its course and also communicates what WAL
# segments are needed to get to consistency.
sentinel_content = StringIO()
json.dump(
{'wal_segment_backup_stop':
stop_backup_info['file_name'],
'wal_segment_offset_backup_stop':
stop_backup_info['file_offset'],
'expanded_size_bytes': expanded_size_bytes},
sentinel_content)
# XXX: should use the storage.s3_storage operators.
#
# XXX: distinguish sentinels by *PREFIX* not suffix,
# which makes searching harder. (For the next version
# bump).
sentinel_content.seek(0)
s3_worker.uri_put_file(
uploaded_to + '_backup_stop_sentinel.json',
sentinel_content, content_encoding='application/json')
else:
# NB: Other exceptions should be raised before this that
# have more informative results, it is intended that this
# exception never will get raised.
raise UserCritical('could not complete backup process')
def database_s3_backup(self, data_directory, *args, **kwargs):
"""
Uploads a PostgreSQL file cluster to S3
Mechanism: just wraps _s3_upload_pg_cluster_dir with
start/stop backup actions with exception handling.
In particular there is a 'finally' block to stop the backup in
most situations.
"""
upload_good = False
backup_stop_good = False
while_offline = False
start_backup_info = None
if 'while_offline' in kwargs:
while_offline = kwargs.pop('while_offline')
try:
if not while_offline:
start_backup_info = PgBackupStatements.run_start_backup()
version = PgBackupStatements.pg_version()['version']
else:
if os.path.exists(os.path.join(data_directory, 'postmaster.pid')):
raise UserException(
msg='while_offline set, but pg looks to be running',
detail='Found a postmaster.pid lockfile, and aborting',
hint='Shut down postgres. If there is a stale lockfile, '
'then remove it after being very sure postgres is not '
'running.')
controldata = PgControlDataParser(data_directory)
start_backup_info = controldata.last_xlog_file_name_and_offset()
version = controldata.pg_version()
uploaded_to, expanded_size_bytes = self._s3_upload_pg_cluster_dir(
start_backup_info, data_directory, version=version, *args, **kwargs)
upload_good = True
finally:
if not upload_good:
logger.warning(
'blocking on sending WAL segments',
detail=('The backup was not completed successfully, '
'but we have to wait anyway. '
'See README: TODO about pg_cancel_backup'))
if not while_offline:
stop_backup_info = PgBackupStatements.run_stop_backup()
else:
stop_backup_info = start_backup_info
backup_stop_good = True
# XXX: Ugly, this is more of a 'worker' task because it might
# involve retries and error messages, something that is not
# treated by the "operator" category of modules. So
# basically, if this small upload fails, the whole upload
# fails!
if upload_good and backup_stop_good:
# Try to write a sentinel file to the cluster backup
# directory that indicates that the base backup upload has
# definitely run its course and also communicates what WAL
# segments are needed to get to consistency.
sentinel_content = StringIO()
json.dump(
{'wal_segment_backup_stop':
stop_backup_info['file_name'],
'wal_segment_offset_backup_stop':
stop_backup_info['file_offset'],
'expanded_size_bytes': expanded_size_bytes},
sentinel_content)
# XXX: should use the storage.s3_storage operators.
#
# XXX: distinguish sentinels by *PREFIX* not suffix,
# which makes searching harder. (For the next version
# bump).
sentinel_content.seek(0)
s3_worker.uri_put_file(
uploaded_to + '_backup_stop_sentinel.json',
sentinel_content, content_encoding='application/json')
else:
# NB: Other exceptions should be raised before this that
# have more informative results, it is intended that this
# exception never will get raised.
raise UserCritical('could not complete backup process')