adctk.syslog_publisher.SyslogPublisher Class Reference

Publish to syslog. More...

Inheritance diagram for adctk.syslog_publisher.SyslogPublisher:

Collaboration diagram for adctk.syslog_publisher.SyslogPublisher:

Public Member Functions
	__init__ (self)
int	config (self, **kwargs)
int	initialize (self)
	Set up any resources needed for reuse in publish().
int	publish (self, builder.Builder b)
	Publish json extracted from builder.
None	finalize (self)
	Clean up any resources set up in initialize (files, pipes, etc).
Public Member Functions inherited from adctk.publisher.Publisher
str	name (self)
	Get the name which a factory or error message should use.
str	version (self)
dict[str, str]	get_option_defaults (self)
None	pause (self)
	Cause publish calls to be ignored until resume is called.
None	resume (self)
	Cancel an prior calls to pause.
int	publish_str (self, str json_string)
int	publish_obj (self, obj)

Public Attributes
	defaults
	paused
	plugin_prefix
	mode
Public Attributes inherited from adctk.publisher.Publisher
	defaults
	plugin_prefix
	paused
	state
	mode

Protected Member Functions
int	_config (self, str priority)
Protected Member Functions inherited from adctk.publisher.Publisher
str	_get (self, dict[str, str] opts, str field)
bool	_get_bool (self, dict[str, str] opts, str field)

Static Protected Attributes
str	_name = "syslog"
str	_version = "1.0.0"
	_priority = None
Static Protected Attributes inherited from adctk.publisher.Publisher
str	_name = "unknown"
str	_version = "0.0.0"

Additional Inherited Members
Static Public Member Functions inherited from adctk.publisher.Publisher
tuple[float]	get_timeout_defaults ()
	Get the adc server connect and response timeouts defined in the environment ADC_SERVER_CONNECT_TIMEOUT and ADC_SERVER_POST_TIMEOUT as a tuple or default values if not defined.
str	get_url_default ()
	Get the alleged adc server url base from environment ADC_SERVER_URL or the default if it is not present.
str	get_port_default ()
	Get the adc server port number to use if it is properly defined in the environment ADC_SERVER_PORT or the default if it is not.
Static Public Attributes inherited from adctk.publisher.Publisher
	API_VERSION = adc_version.AdcVersion()._dict()

Detailed Description

Publish to syslog.

Syslog priority is a global in C, so _priority is the last value we set it to using openlog across all instances of this publisher.

Environment variables:

• ADC_SYSLOG_PLUGIN_PRIORITY

Constructor & Destructor Documentation

__init__()

adctk.syslog_publisher.SyslogPublisher.__init__

(

self

)

Reimplemented from adctk.publisher.Publisher.

    def __init__(self):
        super().__init__()
        self.defaults = _defaults
        self.paused = False
        self.plugin_prefix = "ADC_SYSLOG_PLUGIN_"
 

Member Function Documentation

_config()

int adctk.syslog_publisher.SyslogPublisher._config (   self, str  priority  )

protected

    def _config(self, priority: str) -> int:
        SyslogPublisher._priority = _get_priority_from_string(priority)
        return 0
 

config()

int adctk.syslog_publisher.SyslogPublisher.config	(		self,
		**	kwargs
	)

the only option for the syslog plugin is "PRIORITY=<syslog_level>

Reimplemented from adctk.publisher.Publisher.

    def config(self, **kwargs) -> int:
        """the only option for the syslog plugin is "PRIORITY=<syslog_level>"""
        priority = self._get(kwargs, "PRIORITY")
        self.mode = publisher.Publisher.Mode.INIT
        return self._config(priority.lower())
 

finalize()

None adctk.syslog_publisher.SyslogPublisher.finalize

(

self

)

Clean up any resources set up in initialize (files, pipes, etc).

Reimplemented from adctk.publisher.Publisher.

    def finalize(self) -> None:
        return None

initialize()

int adctk.syslog_publisher.SyslogPublisher.initialize

(

self

)

Set up any resources needed for reuse in publish().

Reimplemented from adctk.publisher.Publisher.

    def initialize(self) -> int:
        syslog.openlog("ADC", logoption=(syslog.LOG_CONS | syslog.LOG_PID),
            facility=syslog.LOG_USER)
        self.mode = publisher.Publisher.Mode.PUB_OR_FINAL
        return 0
 

publish()

int adctk.syslog_publisher.SyslogPublisher.publish	(		self,
		builder.Builder	b
	)

Publish json extracted from builder.

Reimplemented from adctk.publisher.Publisher.

    def publish(self, b: builder.Builder) -> int:
        if self.paused:
            return 0
        if SyslogPublisher._priority is None:
            self._config("info")
        if self.mode != publisher.Publisher.Mode.PUB_OR_FINAL:
            self.initialize()
        message = b.serialize()
        syslog.syslog(SyslogPublisher._priority, message)
        return 0
 

Member Data Documentation

_name

str adctk.syslog_publisher.SyslogPublisher._name = "syslog"

staticprotected

_priority

adctk.syslog_publisher.SyslogPublisher._priority = None

staticprotected

_version

str adctk.syslog_publisher.SyslogPublisher._version = "1.0.0"

staticprotected

defaults

adctk.syslog_publisher.SyslogPublisher.defaults

mode

adctk.syslog_publisher.SyslogPublisher.mode

paused

adctk.syslog_publisher.SyslogPublisher.paused

plugin_prefix

adctk.syslog_publisher.SyslogPublisher.plugin_prefix

---

The documentation for this class was generated from the following file:

• src/adctk/syslog_publisher.py