logging.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	PG_LOG_FLAG_TERSE   1
#define	pg_log_fatal(...)
#define	pg_log_error(...)
#define	pg_log_warning(...)
#define	pg_log_info(...)
#define	pg_log_debug(...)

Enumerations
enum	pg_log_level {   PG_LOG_NOTSET = 0, PG_LOG_DEBUG, PG_LOG_INFO, PG_LOG_WARNING,   PG_LOG_ERROR, PG_LOG_FATAL, PG_LOG_OFF }

Functions
void	pg_logging_init (const char *argv0)
void	pg_logging_config (int new_flags)
void	pg_logging_set_level (enum pg_log_level new_level)
void	pg_logging_increase_verbosity (void)
void	pg_logging_set_pre_callback (void(*cb)(void))
void	pg_logging_set_locus_callback (void(*cb)(const char **filename, uint64 *lineno))
void	pg_log_generic (enum pg_log_level level, const char *pg_restrict fmt,...) pg_attribute_printf(2
void void	pg_log_generic_v (enum pg_log_level level, const char *pg_restrict fmt, va_list ap) pg_attribute_printf(2

Variables
enum pg_log_level	__pg_log_level

Macro Definition Documentation

pg_log_debug

#define pg_log_debug

(

...

)

Value:

do { \
        if (unlikely(__pg_log_level <= PG_LOG_DEBUG)) pg_log_generic(PG_LOG_DEBUG, __VA_ARGS__); \
    } while(0)

Definition at line 92 of file logging.h.

Referenced by _allocAH(), _discoverArchiveFormat(), _tarGetHeader(), _tarPositionTo(), advanceConnectionState(), check_file_excluded(), CleanupPriorWALFiles(), datapagemap_print(), dump_lo_buf(), executeMetaCommand(), getRestoreCommand(), getTimelineHistory(), libpq_fetch_file(), main(), pop_next_work_item(), print_filemap(), process_queued_fetch_requests(), readCommandResponse(), ReadToc(), reduce_dependencies(), repoint_table_dependencies(), restore_toc_entries_parallel(), restore_toc_entries_postfork(), restore_toc_entries_prefork(), runShellCommand(), sendCommand(), and SimpleXLogPageRead().

pg_log_error

#define pg_log_error

(

...

)

Value:

do { \
        if (likely(__pg_log_level <= PG_LOG_ERROR)) pg_log_generic(PG_LOG_ERROR, __VA_ARGS__); \
    } while(0)

Definition at line 80 of file logging.h.

Referenced by _check_database_version(), AcceptResult(), advanceConnectionState(), appendQualifiedRelation(), BaseBackup(), bootstrap_template1(), check_authmethod_valid(), check_input(), check_locale_encoding(), check_locale_name(), check_need_password(), CheckCopyStreamStop(), CheckDataVersion(), CheckServerVersionForStreaming(), cleanup_directories_atexit(), CleanupPriorWALFiles(), close_destination_dir(), close_walfile(), cluster_one_database(), coerceToBool(), coerceToDouble(), coerceToInt(), commandFailed(), compile_database_list(), compile_relation_list_one_db(), connectDatabase(), CopyStreamPoll(), CopyStreamReceive(), create_data_directory(), create_xlog_or_symlink(), CreateReplicationSlot(), describeAccessMethods(), describeFunctions(), describeOneTableDetails(), describePublications(), describeSubscriptions(), describeTableDetails(), die_on_query_failure(), do_connect(), do_copy(), do_edit(), do_pset(), do_shell(), do_watch(), doConnect(), DropReplicationSlot(), dumpDatabases(), dumpPolicy(), dumpRule(), dumpSequence(), dumpSequenceData(), dumpTableData_copy(), dumpTablespaces(), dumpTrigger(), editFile(), ensureCleanShutdown(), escape_quotes(), evalStandardFunc(), evaluateExpr(), evaluateSleep(), exec_command_cd(), exec_command_edit(), exec_command_ef_ev(), exec_command_elif(), exec_command_else(), exec_command_encoding(), exec_command_endif(), exec_command_errverbose(), exec_command_include(), exec_command_lo(), exec_command_password(), exec_command_prompt(), exec_command_setenv(), exec_command_sf_sv(), exec_command_unset(), exec_command_write(), executeCommand(), executeQuery(), FindEndOfXLOG(), findParentsByOid(), FindStreamingStart(), GenerateRecoveryConfig(), get_create_object_cmd(), get_destination_dir(), get_encoding_id(), get_id(), get_restricted_token(), get_su_pwd(), GetConnection(), getRestoreCommand(), gets_fromFile(), getTableAttrs(), handle_args(), handleCopyOut(), HandleCopyStream(), HandleEndOfCopyStream(), HandleSlashCmds(), indexOfColumn(), init_parallel_dump_utils(), Initialize(), initialize_data_directory(), initializeInput(), KillExistingArchiveStatus(), KillExistingXLOG(), listCollations(), listDbRoleSettings(), listDefaultACLs(), listExtendedStats(), listExtensionContents(), listExtensions(), listForeignDataWrappers(), listForeignServers(), listForeignTables(), listPartitionedTables(), listPublications(), listTables(), listTSConfigs(), listTSConfigsVerbose(), listTSDictionaries(), listTSParsers(), listTSParsersVerbose(), listTSTemplates(), listUserMappings(), LogStreamerMain(), lookupCreateVariable(), main(), MainLoop(), makeVariableValue(), mark_file_as_archived(), minimal_error_message(), open_walfile(), openQueryOutputFile(), parse_max_rate(), parse_slash_copy(), parseOidArray(), parseQuery(), ParseVariableBool(), ParseVariableNum(), popen_check(), printCrosstab(), printHistory(), printPsetInfo(), PrintQueryResults(), PrintQueryTuples(), PrintResultsInCrosstab(), process_command_g_options(), process_file(), ProcessKeepaliveMsg(), ProcessResult(), ProcessXLogDataMsg(), psql_get_variable(), PSQLexec(), PSQLexecWatch(), PsqlVarEnumError(), reached_end_position(), read_controlfile(), readCommandResponse(), ReadEndOfStreamingResult(), readfile(), readMessageFromPipe(), ReceiveAndUnpackTarFile(), ReceiveBackupManifest(), ReceiveBackupManifestChunk(), ReceiveCopyData(), ReceiveTarAndUnpackCopyChunk(), ReceiveTarFile(), ReceiveXlogStream(), reindex_one_database(), RestoreArchivedFile(), RetrieveDataDirCreatePerm(), RetrieveWalSegSize(), rewind_parseTimeLineHistory(), run_command(), run_reindex_command(), run_vacuum_command(), RunIdentifySystem(), runShellCommand(), scan_directory(), scan_file(), sendCommand(), sendFeedback(), SendQuery(), set_dump_section(), set_null_conf(), set_random_seed(), setup_bin_paths(), setup_config(), setup_locale_encoding(), setup_pgdata(), SetVariable(), SetWALFileNameForCleanup(), SimpleXLogPageRead(), sql_conn(), sql_exec(), start_lo_xact(), StartLogStreamer(), StoreQueryTuple(), StreamLogicalLog(), strip_lineno_from_objdesc(), strtodouble(), strtoint64(), TableCommandResultHandler(), tablespace_list_append(), threadRun(), tryExecuteStatement(), vacuum_one_database(), vacuumlo(), verify_dir_is_empty_or_create(), write_version_file(), WriteEmptyXLOG(), writefile(), WriteRecoveryConfig(), writeTarData(), and writeTimeLineHistoryFile().

pg_log_fatal

#define pg_log_fatal

(

...

)

Value:

do { \
        if (likely(__pg_log_level <= PG_LOG_FATAL)) pg_log_generic(PG_LOG_FATAL, __VA_ARGS__); \
    } while(0)

Definition at line 76 of file logging.h.

Referenced by add_socket_to_set(), addScript(), CheckConnection(), checkInitSteps(), ConditionError(), connect_slot(), evaluateExpr(), executeStatement(), findBuiltin(), get_controlfile(), get_hex(), GetTableInfo(), HandleCopyStream(), initGenerateDataClientSide(), main(), on_exit_nicely(), open_walfile(), OutputFsync(), parse_psql_options(), parseScriptWeight(), pg_hex_decode(), pg_hex_encode(), process_file(), process_psqlrc(), ProcessKeepaliveMsg(), RestoreArchivedFile(), runInitSteps(), setalarm(), syntax_error(), threadRun(), update_controlfile(), and usage().

PG_LOG_FLAG_TERSE

#define PG_LOG_FLAG_TERSE   1

Definition at line 64 of file logging.h.

Referenced by main(), pg_log_generic_v(), and process_file().

pg_log_info

#define pg_log_info

(

...

)

Value:

do { \
        if (likely(__pg_log_level <= PG_LOG_INFO)) pg_log_generic(PG_LOG_INFO, __VA_ARGS__); \
    } while(0)

Definition at line 88 of file logging.h.

Referenced by _disableTriggersIfNecessary(), _enableTriggersIfNecessary(), _LoadBlobs(), AcceptResult(), BaseBackup(), CheckDataVersion(), checkInitSteps(), cleanup_directories_atexit(), close_walfile(), compile_database_list(), compile_relation_list_one_db(), DescribeQuery(), describeTablespaces(), do_connect(), do_lo_export(), do_lo_import(), do_lo_unlink(), dumpBlobs(), dumpDatabase(), dumpDatabases(), dumpEncoding(), dumpSearchPath(), dumpStdStrings(), dumpTableData_copy(), dumpToastCompression(), EndRestoreBlobs(), ensureCleanShutdown(), exec_command_password(), executeCommand(), executeQuery(), executeStatement(), getBlobs(), getConstraints(), getDependencies(), getIndexes(), getPolicies(), getSchemaData(), getTableAttrs(), GetTableInfo(), getTriggers(), handleCopyIn(), handleCopyOut(), HandleSlashCmds(), inhibit_data_for_failed_table(), main(), mark_dump_job_done(), mark_restore_job_done(), NoticeProcessor(), perform_rewind(), prepareToTerminate(), psql_get_variable(), read_controlfile(), restore_toc_entries_parallel(), restore_toc_entries_postfork(), restore_toc_entries_prefork(), restore_toc_entry(), RestoreArchive(), runPgDump(), scan_file(), sendFeedback(), SendQuery(), set_random_seed(), setup_text_search(), StartLogStreamer(), StartRestoreBlob(), stop_streaming(), StreamLog(), StreamLogicalLog(), tryExecuteStatement(), and verify_btree_slot_handler().

pg_log_warning

#define pg_log_warning

(

...

)

Value:

do { \
        if (likely(__pg_log_level <= PG_LOG_WARNING)) pg_log_generic(PG_LOG_WARNING, __VA_ARGS__); \
    } while(0)

Definition at line 84 of file logging.h.

Enumeration Type Documentation

pg_log_level

enum pg_log_level

Enumerator
PG_LOG_NOTSET
PG_LOG_DEBUG
PG_LOG_INFO
PG_LOG_WARNING
PG_LOG_ERROR
PG_LOG_FATAL
PG_LOG_OFF

Definition at line 16 of file logging.h.

{
    /*
     * Not initialized yet
     */
    PG_LOG_NOTSET = 0,

    /*
     * Low level messages that are normally off by default.
     */
    PG_LOG_DEBUG,

    /*
     * Any program messages that go to stderr, shown by default.  (The
     * program's normal output should go to stdout and not use the logging
     * system.)
     */
    PG_LOG_INFO,

    /*
     * Warnings and "almost" errors, depends on the program
     */
    PG_LOG_WARNING,

    /*
     * Errors
     */
    PG_LOG_ERROR,

    /*
     * Severe errors that cause program termination.  (One-shot programs may
     * chose to label even fatal errors as merely "errors".  The distinction
     * is up to the program.)
     */
    PG_LOG_FATAL,

    /*
     * Turn all logging off.
     */
    PG_LOG_OFF,
};

Function Documentation

pg_log_generic()

void pg_log_generic	(	enum pg_log_level	level,
		const char *pg_restrict	fmt,
			...
	)

pg_log_generic_v()

void void pg_log_generic_v	(	enum pg_log_level	level,
		const char *pg_restrict	fmt,
		va_list	ap
	)

pg_logging_config()

void pg_logging_config

(

int

new_flags

)

Definition at line 155 of file logging.c.

References log_flags.

Referenced by main(), and process_file().

{
    log_flags = new_flags;
}

pg_logging_increase_verbosity()

void pg_logging_increase_verbosity

(

void

)

Definition at line 174 of file logging.c.

References __pg_log_level, and PG_LOG_NOTSET.

Referenced by main().

{
    /*
     * The enum values are chosen such that we have to decrease __pg_log_level
     * in order to become more verbose.
     */
    if (__pg_log_level > PG_LOG_NOTSET + 1)
        __pg_log_level--;
}

pg_logging_init()

void pg_logging_init

(

const char *

argv0

)

Definition at line 81 of file logging.c.

References __pg_log_level, free, get_progname(), name, PG_LOG_INFO, progname, sgr_error, SGR_ERROR_DEFAULT, sgr_locus, SGR_LOCUS_DEFAULT, sgr_warning, SGR_WARNING_DEFAULT, and value.

Referenced by get_opts(), main(), and regression_main().

{
    const char *pg_color_env = getenv("PG_COLOR");
    bool        log_color = false;
    bool        color_terminal = isatty(fileno(stderr));

#ifdef WIN32

    /*
     * On Windows, check if environment is VT100-compatible if using a
     * terminal.
     */
    if (color_terminal)
        color_terminal = enable_vt_processing();
#endif

    /* usually the default, but not on Windows */
    setvbuf(stderr, NULL, _IONBF, 0);

    progname = get_progname(argv0);
    __pg_log_level = PG_LOG_INFO;

    if (pg_color_env)
    {
        if (strcmp(pg_color_env, "always") == 0 ||
            (strcmp(pg_color_env, "auto") == 0 && color_terminal))
            log_color = true;
    }

    if (log_color)
    {
        const char *pg_colors_env = getenv("PG_COLORS");

        if (pg_colors_env)
        {
            char       *colors = strdup(pg_colors_env);

            if (colors)
            {
                for (char *token = strtok(colors, ":"); token; token = strtok(NULL, ":"))
                {
                    char       *e = strchr(token, '=');

                    if (e)
                    {
                        char       *name;
                        char       *value;

                        *e = '\0';
                        name = token;
                        value = e + 1;

                        if (strcmp(name, "error") == 0)
                            sgr_error = strdup(value);
                        if (strcmp(name, "warning") == 0)
                            sgr_warning = strdup(value);
                        if (strcmp(name, "locus") == 0)
                            sgr_locus = strdup(value);
                    }
                }

                free(colors);
            }
        }
        else
        {
            sgr_error = SGR_ERROR_DEFAULT;
            sgr_warning = SGR_WARNING_DEFAULT;
            sgr_locus = SGR_LOCUS_DEFAULT;
        }
    }
}

pg_logging_set_level()

void pg_logging_set_level

(

enum pg_log_level

new_level

)

Definition at line 165 of file logging.c.

References __pg_log_level.

Referenced by main().

{
    __pg_log_level = new_level;
}

pg_logging_set_locus_callback()

void pg_logging_set_locus_callback

(

void(*)(const char **filename, uint64 *lineno)

cb

)

Definition at line 191 of file logging.c.

References log_locus_callback.

Referenced by main().

{
    log_locus_callback = cb;
}

pg_logging_set_pre_callback()

void pg_logging_set_pre_callback

(

void(*)(void)

cb

)

Definition at line 185 of file logging.c.

References log_pre_callback.

Referenced by main().

{
    log_pre_callback = cb;
}

Variable Documentation

__pg_log_level

enum pg_log_level __pg_log_level

Definition at line 21 of file logging.c.

Referenced by executeMetaCommand(), pg_logging_increase_verbosity(), pg_logging_init(), and pg_logging_set_level().