logs

Documentation

Index

• Constants
• Variables
• func AnalyzeBackendLogLines(logLines []state.LogLine) (logLinesOut []state.LogLine, samples []state.PostgresQuerySample)
• func AnalyzeLogLines(logLinesIn []state.LogLine) (logLinesOut []state.LogLine, samples []state.PostgresQuerySample)
• func IsSupportedPrefix(prefix string) bool
• func ParseAndAnalyzeBuffer(logStream LineReader, linesNewerThan time.Time, server *state.Server) ([]state.LogLine, []state.PostgresQuerySample)
• func ParseLogLineWithPrefix(prefix string, line string) (logLine state.LogLine, ok bool)
• func PrintDebugInfo(logFileContents string, logLines []state.LogLine, ...)
• func PrintDebugLogLines(logFileContents string, logLines []state.LogLine, ...)
• func ReplaceSecrets(input []byte, logLines []state.LogLine, filterLogSecret []state.LogSecretKind) []byte
• func ValidateLogCollectionConfig(server *state.Server, settings []state.PostgresSetting) (bool, bool, bool, string)
• type LineReader
• type MaybeHerokuLogReader
  • func NewMaybeHerokuLogReader(r io.Reader) *MaybeHerokuLogReader
  • func (lr *MaybeHerokuLogReader) ReadString(delim byte) (string, error)

Constants

const LogPrefixAmazonRds string = "%t:%r:%u@%d:[%p]:"

const LogPrefixAzure string = "%t-%c-"

const LogPrefixCustom1 string = "%m [%p][%v] : [%l-1] %q[app=%a] "

const LogPrefixCustom10 string = "%m [%p]: [%l-1] db=%d,user=%u "

const LogPrefixCustom11 string = "pid=%p,user=%u,db=%d,app=%a,client=%h "

const LogPrefixCustom12 string = "user=%u,db=%d,app=%a,client=%h "

const LogPrefixCustom13 string = "%p-%s-%c-%l-%h-%u-%d-%m "

const LogPrefixCustom14 string = "%m [%p][%b][%v][%x] %q[user=%u,db=%d,app=%a] "

const LogPrefixCustom15 string = "%m [%p] %q%u@%d "

const LogPrefixCustom16 string = "%t [%p] %q%u@%d %h "

const LogPrefixCustom2 string = "%t [%p-%l] %q%u@%d "

const LogPrefixCustom3 string = "%m [%p] %q[user=%u,db=%d,app=%a] "

const LogPrefixCustom4 string = "%m [%p] %q[user=%u,db=%d,app=%a,host=%h] "

const LogPrefixCustom5 string = "%t [%p]: [%l-1] user=%u,db=%d - PG-%e "

const LogPrefixCustom6 string = "%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h "

const LogPrefixCustom7 string = "%t [%p]: [%l-1] [trx_id=%x] user=%u,db=%d "

const LogPrefixCustom8 string = "[%p]: [%l-1] db=%d,user=%u "

const LogPrefixCustom9 string = "%m %r %u %a [%c] [%p] "

const LogPrefixEmpty string = ""

const LogPrefixHeroku1 string = " sql_error_code = %e "

const LogPrefixHeroku2 string = `` /* 186-byte string literal not displayed */

const LogPrefixHerokuHobbyTier string = " database = %d connection_source = %r sql_error_code = %e "

Used only to recognize the Heroku hobby tier log_line_prefix to give a warning (logs are not supported on hobby tier) and avoid errors during prefix check; logs with this prefix are never actually received

const LogPrefixSimple string = "%m [%p] "

const MinSupportedLogMinDurationStatement = 10

Variables

var AppBeforeCommaRegexp = `([^,]*)` // %a

var AppBeforeQuoteRegexp = `([^"]*)` // %a

var AppBeforeSpaceRegexp = `(\S*)` // %a

var AppInsideBracketsRegexp = `(\[unknown\]|[^,\]]*)` // %a

var BackendTypeRegexp = `([\w ]+)` // %b

var DbRegexp = `(\S*)` // %d

var HerokuPostgresDebugRegexp = regexp.MustCompile(`^(\w+ \d+ \d+:\d+:\d+ \w+ app\[postgres\] \w+ )?\[(\w+)\] \[\d+-\d+\] (.+)`)

var HostAndPortRegexp = `(.+(?:\(\d+\))?)?` // %r

var HostRegexp = `(\S*)` // %h

var LevelAndContentRegexp = `(\w+):\s+(.*\n?)$`

var LogLineCounterRegexp = `(\d+)` // %l

var LogPrefixAmazonRdsRegexp = regexp.MustCompile(`(?s)^` + TimeRegexp + `:` + HostAndPortRegexp + `:` + UserRegexp + `@` + DbRegexp + `:\[` + PidRegexp + `\]:` + LevelAndContentRegexp)

var LogPrefixAzureRegexp = regexp.MustCompile(`(?s)^` + TimeRegexp + `-` + SessionIdRegexp + `-` + LevelAndContentRegexp)

var LogPrefixCustom10Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\]: \[` + LogLineCounterRegexp + `-1\] db=` + DbRegexp + `,user=` + UserRegexp + ` ` + LevelAndContentRegexp)

var LogPrefixCustom11Regexp = regexp.MustCompile(`(?s)^pid=` + PidRegexp + `,user=` + UserRegexp + `,db=` + DbRegexp + `,app=` + AppBeforeCommaRegexp + `,client=` + HostRegexp + ` ` + LevelAndContentRegexp)

var LogPrefixCustom12Regexp = regexp.MustCompile(`(?s)^user=` + UserRegexp + `,db=` + DbRegexp + `,app=` + AppBeforeCommaRegexp + `,client=` + HostRegexp + ` ` + LevelAndContentRegexp)

var LogPrefixCustom13Regexp = regexp.MustCompile(`(?s)^` + PidRegexp + `-` + TimeRegexp + `-` + SessionIdRegexp + `-` + LogLineCounterRegexp + `-` + HostRegexp + `-` + UserRegexp + `-` + DbRegexp + `-` + TimeRegexp + ` ` + LevelAndContentRegexp)

var LogPrefixCustom14Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\]\[` + BackendTypeRegexp + `\]\[` + VirtualTxRegexp + `\]\[` + TransactionIdRegexp + `\] (?:\[user=` + UserRegexp + `,db=` + DbRegexp + `,app=` + AppInsideBracketsRegexp + `\] )?` + LevelAndContentRegexp)

var LogPrefixCustom15Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\] ` + `(?:` + UserRegexp + `@` + DbRegexp + ` )?` + LevelAndContentRegexp)

var LogPrefixCustom16Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\] ` + `(?:` + UserRegexp + `@` + DbRegexp + ` ` + HostRegexp + ` )?` + LevelAndContentRegexp)

var LogPrefixCustom1Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\]\[` + VirtualTxRegexp + `\] : \[` + LogLineCounterRegexp + `-1\] (?:\[app=` + AppInsideBracketsRegexp + `\] )?` + LevelAndContentRegexp)

var LogPrefixCustom2Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `-` + LogLineCounterRegexp + `\] ` + `(?:` + UserRegexp + `@` + DbRegexp + ` )?` + LevelAndContentRegexp)

var LogPrefixCustom3Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\] (?:\[user=` + UserRegexp + `,db=` + DbRegexp + `,app=` + AppInsideBracketsRegexp + `\] )?` + LevelAndContentRegexp)

var LogPrefixCustom4Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\] (?:\[user=` + UserRegexp + `,db=` + DbRegexp + `,app=` + AppBeforeCommaRegexp + `,host=` + HostRegexp + `\] )?` + LevelAndContentRegexp)

var LogPrefixCustom5Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\]: \[` + LogLineCounterRegexp + `-1\] user=` + UserRegexp + `,db=` + DbRegexp + ` - PG-` + SqlstateRegexp + ` ` + LevelAndContentRegexp)

var LogPrefixCustom6Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\]: \[` + LogLineCounterRegexp + `-1\] user=` + UserRegexp + `,db=` + DbRegexp + `,app=` + AppBeforeCommaRegexp + `,client=` + HostRegexp + ` ` + LevelAndContentRegexp)

var LogPrefixCustom7Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\]: \[` + LogLineCounterRegexp + `-1\] \[trx_id=` + TransactionIdRegexp + `\] user=` + UserRegexp + `,db=` + DbRegexp + ` ` + LevelAndContentRegexp)

var LogPrefixCustom8Regexp = regexp.MustCompile(`(?s)^\[` + PidRegexp + `\]: \[` + LogLineCounterRegexp + `-1\] db=` + DbRegexp + `,user=` + UserRegexp + ` ` + LevelAndContentRegexp)

var LogPrefixCustom9Regexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` ` + HostAndPortRegexp + ` ` + UserRegexp + ` ` + AppBeforeSpaceRegexp + ` \[` + SessionIdRegexp + `\] \[` + PidRegexp + `\] ` + LevelAndContentRegexp)

var LogPrefixHeroku1Regexp = regexp.MustCompile(`^ sql_error_code = ` + SqlstateRegexp + " " + LevelAndContentRegexp)

var LogPrefixHeroku2Regexp = regexp.MustCompile(`^ sql_error_code = ` + SqlstateRegexp + ` time_ms = "` + TimeRegexp + `" pid="` + PidRegexp + `" proc_start_time="` + TimeRegexp + `" session_id="` + SessionIdRegexp + `" vtid="` + VirtualTxRegexp + `" tid="` + TransactionIdRegexp + `" log_line="` + LogLineCounterRegexp + `" (?:database="` + DbRegexp + `" connection_source="` + HostAndPortRegexp + `" user="` + UserRegexp + `" application_name="` + AppBeforeQuoteRegexp + `" )?` + LevelAndContentRegexp)

var LogPrefixNoTimestampUserDatabaseAppRegexp = regexp.MustCompile(`(?s)^\[user=` + UserRegexp + `,db=` + DbRegexp + `,app=` + AppInsideBracketsRegexp + `\] ` + LevelAndContentRegexp)

var LogPrefixSimpleRegexp = regexp.MustCompile(`(?s)^` + TimeRegexp + ` \[` + PidRegexp + `\] ` + LevelAndContentRegexp)

var PidRegexp = `(\d+)` // %p

var RecommendedPrefixIdx = 4

var RsyslogHostnameRegxp = `(\S+)`

var RsyslogLevelAndContentRegexp = `(?:(\w+):\s+)?(.*\n?)$`

var RsyslogProcessNameRegexp = `(\w+)`

var RsyslogRegexp = regexp.MustCompile(`^` + RsyslogTimeRegexp + ` ` + RsyslogHostnameRegxp + ` ` + RsyslogProcessNameRegexp + `\[` + PidRegexp + `\]: ` + SyslogSequenceAndSplitRegexp + ` ` + RsyslogLevelAndContentRegexp)

var RsyslogTimeRegexp = `(\w+\s+\d+ \d{2}:\d{2}:\d{2})`

var SessionIdRegexp = `(\w+\.\w+)` // %c

var SqlstateRegexp = `(\w{5})` // %e

var SupportedPrefixes = []string{
	LogPrefixAmazonRds, LogPrefixAzure, LogPrefixCustom1, LogPrefixCustom2,
	LogPrefixCustom3, LogPrefixCustom4, LogPrefixCustom5, LogPrefixCustom6,
	LogPrefixCustom7, LogPrefixCustom8, LogPrefixCustom9, LogPrefixCustom10,
	LogPrefixCustom11, LogPrefixCustom12, LogPrefixCustom13, LogPrefixCustom14,
	LogPrefixCustom15, LogPrefixCustom16,
	LogPrefixSimple, LogPrefixHeroku1, LogPrefixHeroku2, LogPrefixEmpty,
}

var SyslogSequenceAndSplitRegexp = `(\[[\d-]+\])?`

var TimeRegexp = `(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}(?:\.\d+)? [\-+]?\w+)` // %t or %m (or %s)

Every one of these regexps should produce exactly one matching group

var TransactionIdRegexp = `(\d+)` // %x

var UserRegexp = `(\S*)` // %u

var VirtualTxRegexp = `(\d+/\d+)?` // %v

Functions

func AnalyzeBackendLogLines

func AnalyzeBackendLogLines(logLines []state.LogLine) (logLinesOut []state.LogLine, samples []state.PostgresQuerySample)

func AnalyzeLogLines

func AnalyzeLogLines(logLinesIn []state.LogLine) (logLinesOut []state.LogLine, samples []state.PostgresQuerySample)

func IsSupportedPrefix

func IsSupportedPrefix(prefix string) bool

func ParseAndAnalyzeBuffer

func ParseAndAnalyzeBuffer(logStream LineReader, linesNewerThan time.Time, server *state.Server) ([]state.LogLine, []state.PostgresQuerySample)

func ParseLogLineWithPrefix

func ParseLogLineWithPrefix(prefix string, line string) (logLine state.LogLine, ok bool)

func PrintDebugInfo

func PrintDebugInfo(logFileContents string, logLines []state.LogLine, samples []state.PostgresQuerySample)

func PrintDebugLogLines

func PrintDebugLogLines(logFileContents string, logLines []state.LogLine, classifications map[pganalyze_collector.LogLineInformation_LogClassification]bool)

func ReplaceSecrets

func ReplaceSecrets(input []byte, logLines []state.LogLine, filterLogSecret []state.LogSecretKind) []byte

ReplaceSecrets - Replaces the secrets of the specified kind with the replacement character in the text

func ValidateLogCollectionConfig

func ValidateLogCollectionConfig(server *state.Server, settings []state.PostgresSetting) (bool, bool, bool, string)

Types

type LineReader

type LineReader interface {
	ReadString(delim byte) (string, error)
}

type MaybeHerokuLogReader

type MaybeHerokuLogReader struct {
	LineReader
}

func NewMaybeHerokuLogReader

func NewMaybeHerokuLogReader(r io.Reader) *MaybeHerokuLogReader

func (*MaybeHerokuLogReader) ReadString

func (lr *MaybeHerokuLogReader) ReadString(delim byte) (string, error)