Skip to content
This repository was archived by the owner on Mar 4, 2026. It is now read-only.

Allows custom message and date format. #4

Open
didip wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Allows custom message and date format. #4

Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
ab9bde9
Add ability to pass custom message format via os.environment[‘SYSLOG_…
Jul 30, 2014
b52f896
Set default values for SYSLOG_SERVER, SYSLOG_PORT, SYSLOG_PROTO, and …
Jul 30, 2014
944eee0
shorter env vars
Jul 30, 2014
da88faf
pep8 compliance.
Jul 30, 2014
286f307
Default date format uses ISO 8601
Jul 31, 2014
f9b92c8
Comply to pylint.
Jul 31, 2014
90c6c54
Added 2 more tests around date formatting.
Jul 31, 2014
479f9a2
typo
Jul 31, 2014
1819c76
Change DFLT to DEFAULT
Jul 31, 2014
860015a
pep8 compliance.
Jul 31, 2014
7c5f7e0
Don’t shorten MSG
Jul 31, 2014
20716dd
Another pylint compliance.
Jul 31, 2014
696ba2d
No need to reach into __class__ explicitly.
Jul 31, 2014
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
50 changes: 31 additions & 19 deletions supervisor_logging/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,38 @@ class PalletFormatter(logging.Formatter):
"""

HOSTNAME = re.sub(
r':\d+$', '', os.environ.get('SITE_DOMAIN', socket.gethostname()))
FORMAT = '%(asctime)s {hostname} %(name)s[%(process)d]: %(message)s'.\
format(hostname=HOSTNAME)
DATE_FORMAT = '%b %d %H:%M:%S'
r':\d+$',
'',
os.environ.get('SITE_DOMAIN', socket.gethostname())
)
DFLT_DATE_FORMAT = '%b %d %H:%M:%S'

@koterpillar koterpillar Jul 30, 2014

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please spell DEFAULT out, it's not like we have identifier length restrictions.

DFLT_MSG_FORMAT = \
'%(asctime)s %(hostname)s %(name)s[%(process)d]: %(message)s'

def __init__(self):
super(PalletFormatter, self).__init__(fmt=self.FORMAT,
datefmt=self.DATE_FORMAT)
super(PalletFormatter, self).__init__(
fmt=self.message_format(), datefmt=self.date_format()
)

def format(self, record):
# strip newlines
message = super(PalletFormatter, self).format(record)
message = message.replace('\n', ' ')
message += '\n'
return message
return message.replace('\n', ' ') + '\n'

def message_format(self):
fmt = os.environ.get(
'SYSLOG_MESSAGE_FORMAT',
self.__class__.DFLT_MSG_FORMAT

@koterpillar koterpillar Jul 30, 2014

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why not self.DFLT_MSG_FORMAT (here and below)?

@didip didip Jul 31, 2014

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Log routers such as Heka or Logstash are picky about which syslog RFC it is accepting.
So I figured why not let user defines which format they want through os.environ[SYSLOG_MESSAGE_FORMAT]

@koterpillar koterpillar Jul 31, 2014

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I see the reason; I'm just saying you shouldn't use .__class__ here.

@didip didip Jul 31, 2014

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Would that work? message_format is an instance method and DEFAULT_MESSAGE_FORMAT is class variable.

@koterpillar koterpillar Jul 31, 2014

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes, it will.

)
return fmt.replace(
'%(hostname)s',
self.__class__.HOSTNAME
) # Accepts hostname in the form of %(hostname)s

def date_format(self):
return os.environ.get(
'SYSLOG_DATE_FORMAT',
self.__class__.DFLT_DATE_FORMAT
)


class SysLogHandler(logging.handlers.SysLogHandler):
Expand Down Expand Up @@ -102,15 +119,10 @@ def main():
Main application loop.
"""

env = os.environ

try:
host = env['SYSLOG_SERVER']
port = int(env['SYSLOG_PORT'])
socktype = socket.SOCK_DGRAM if env['SYSLOG_PROTO'] == 'udp' \
else socket.SOCK_STREAM
except KeyError:
sys.exit("SYSLOG_SERVER, SYSLOG_PORT and SYSLOG_PROTO are required.")
host = os.environ.get('SYSLOG_SERVER', '127.0.0.1')
port = int(os.environ.get('SYSLOG_PORT', '514'))
proto = os.environ.get('SYSLOG_PROTO', 'udp')
socktype = socket.SOCK_DGRAM if proto == 'udp' else socket.SOCK_STREAM

handler = SysLogHandler(
address=(host, port),
Expand Down