Skip to content

[feat] Allow Syslog's address to be set from an environment variable #1427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 21, 2020
Merged

[feat] Allow Syslog's address to be set from an environment variable #1427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
070a903
Allow Syslog's address to be set from an environment variable.
Jul 19, 2020
0b1e253
Merge branch 'master' into feat/syslog-addr-envvar
Jul 20, 2020
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
28 changes: 27 additions & 1 deletion docs/manpage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ Here is an alphabetical list of the environment variables recognized by ReFrame:
================================== ==================


.. envvar:: RFM_GRAYLOG_SERVER
.. envvar:: RFM_GRAYLOG_ADDRESS

The address of the Graylog server to send performance logs.
The address is specified in ``host:port`` format.
Expand All @@ -651,6 +651,15 @@ Here is an alphabetical list of the environment variables recognized by ReFrame:
================================== ==================


.. versionadded:: 3.1


.. envvar:: RFM_GRAYLOG_SERVER

.. deprecated:: 3.1
Please :envvar:`RFM_GRAYLOG_ADDRESS` instead.


.. envvar:: RFM_IGNORE_CHECK_CONFLICTS

Ignore tests with conflicting names when loading.
Expand Down Expand Up @@ -807,6 +816,23 @@ Here is an alphabetical list of the environment variables recognized by ReFrame:
================================== ==================


.. envvar:: RFM_SYSLOG_ADDRESS

The address of the Syslog server to send performance logs.
The address is specified in ``host:port`` format.
If no port is specified, the address refers to a UNIX socket.

.. table::
:align: left

================================== ==================
Associated command line option N/A
Associated configuration parameter :js:attr:`address` syslog log handler configuration parameter
================================== ==================


.. versionadded:: 3.1

.. envvar:: RFM_SYSTEM

Set the current system.
Expand Down
14 changes: 13 additions & 1 deletion reframe/frontend/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,10 +347,16 @@ def main():
# Options not associated with command-line arguments
argparser.add_argument(
dest='graylog_server',
envvar='RFM_GRAYLOG_SERVER',
envvar='RFM_GRAYLOG_ADDRESS',
configvar='logging/handlers_perflog/graylog_address',
help='Graylog server address'
)
argparser.add_argument(
dest='syslog_address',
envvar='RFM_SYSLOG_ADDRESS',
configvar='logging/handlers_perflog/syslog_address',
help='Syslog server address'
)
argparser.add_argument(
dest='ignore_reqnodenotavail',
envvar='RFM_IGNORE_REQNODENOTAVAIL',
Expand Down Expand Up @@ -386,6 +392,12 @@ def main():
printer = PrettyPrinter()
printer.colorize = site_config.get('general/0/colorize')
printer.inc_verbosity(site_config.get('general/0/verbose'))
if os.getenv('RFM_GRAYLOG_SERVER'):
printer.warning(
'RFM_GRAYLOG_SERVER environment variable is deprecated; '
'please use RFM_GRAYLOG_ADDRESS instead'
)
os.environ['RFM_GRAYLOG_ADDRESS'] = os.getenv('RFM_GRAYLOG_SERVER')

if options.upgrade_config_file is not None:
old_config, *new_config = options.upgrade_config_file.split(
Expand Down