def test_parser(self):
"""
Test whether the parser reads the right values
"""
from flask_monitoringdashboard.core.config.parser import parse_literal, parse_bool, parse_string, parse_version
parser = configparser.RawConfigParser()
version = '1.2.3'
string = 'string-value'
bool = 'False'
literal = "['a', 'b', 'c']"
literal2 = '1.23'
section = 'dashboard'
parser.add_section(section)
parser.set(section, 'APP_VERSION', version)
parser.set(section, 'string', string)
parser.set(section, 'bool', bool)
parser.set(section, 'literal', literal)
parser.set(section, 'literal2', literal2)
self.assertEqual(parse_version(parser, section, 'default'), version)
self.assertEqual(parse_string(parser, section, 'string', 'default'),
string)
self.assertEqual(parse_bool(parser, section, 'bool', 'True'), False)
self.assertEqual(parse_literal(parser, section, 'literal', 'default'),
['a', 'b', 'c'])
self.assertEqual(parse_literal(parser, section, 'literal2', 'default'),
1.23)
def test_parser():
"""Test whether the parser reads the right values."""
parser = configparser.RawConfigParser()
version = '1.2.3'
string = 'string-value'
bool = 'False'
literal = "['a', 'b', 'c']"
literal2 = '1.23'
section = 'dashboard'
parser.add_section(section)
parser.set(section, 'APP_VERSION', version)
parser.set(section, 'string', string)
parser.set(section, 'bool', bool)
parser.set(section, 'literal', literal)
parser.set(section, 'literal2', literal2)
assert parse_version(parser, section, 'default') == version
assert parse_string(parser, section, 'string', 'default') == string
assert not parse_bool(parser, section, 'bool', 'True')
assert parse_literal(parser, section, 'literal',
'default') == ['a', 'b', 'c']
assert parse_literal(parser, section, 'literal2', 'default') == 1.23
def init_from(self, file=None, envvar=None):
"""
The config_file must at least contains the following variables in section 'dashboard':
- APP_VERSION: the version of the app that you use. Updating the version helps in
showing differences in execution times of a function over a period of time.
- GIT = If you're using git, then it is easier to set the location to the .git-folder,
The location is relative to the config-file.
- CUSTOM_LINK: The dashboard can be visited at localhost:5000/{CUSTOM_LINK}.
- MONITOR_LEVEL: The level for monitoring your endpoints. The default value is 3.
- OUTLIER_DETECTION_CONSTANT: When the execution time is more than this constant *
average, extra information is logged into the database. A default value for this
variable is 2.5.
- SAMPLING_PERIOD: Time between two profiler-samples. The time must be specified in ms.
If this value is not set, the profiler continuously monitors.
The config_file must at least contains the following variables in section 'authentication':
- USERNAME: for logging into the dashboard, a username and password is required. The
username can be set using this variable.
- PASSWORD: same as for the username, but this is the password variable.
- GUEST_USERNAME: A guest can only see the results, but cannot configure/download data.
- GUEST_PASSWORD: A guest can only see the results, but cannot configure/download data.
- SECURITY_TOKEN: Used for getting the data in /get_json_data
The config_file must at least contains the following variables in section 'database':
- DATABASE: Suppose you have multiple projects where you're working on and want to
separate the results. Then you can specify different database_names, such that the
result of each project is stored in its own database.
- TABLE_PREFIX: A prefix to every table that the Flask-MonitoringDashboard uses, to ensure
that there are no conflicts with the user of the dashboard.
The config_file must at least contains the following variables in section 'visualization':
- TIMEZONE: The timezone for converting a UTC timestamp to a local timestamp.
for a list of all timezones, use the following:
>>> import pytz # pip install pytz
>>> print(pytz.all_timezones)
- COLORS: A dictionary to override the colors used per endpoint.
:param file: a string pointing to the location of the config-file.
:param envvar: a string specifying which environment variable holds the config file location
"""
if envvar:
file = os.getenv(envvar)
if not file:
# Travis does not need a config file.
if '/home/travis/build/' in os.getcwd():
return
print("No configuration file specified. Please do so.")
return
parser = configparser.RawConfigParser()
try:
parser.read(file)
# parse 'dashboard'
self.version = parse_version(parser, 'dashboard', self.version)
self.link = parse_string(parser, 'dashboard', 'CUSTOM_LINK',
self.link)
self.monitor_level = parse_literal(parser, 'dashboard',
'MONITOR_LEVEL',
self.monitor_level)
self.outlier_detection_constant = parse_literal(
parser, 'dashboard', 'OUTlIER_DETECTION_CONSTANT',
self.outlier_detection_constant)
self.sampling_period = parse_literal(parser, 'dashboard',
'SAMPLING_RATE',
self.sampling_period) / 1000
# parse 'authentication'
self.username = parse_string(parser, 'authentication', 'USERNAME',
self.username)
self.password = parse_string(parser, 'authentication', 'PASSWORD',
self.password)
self.security_token = parse_string(parser, 'authentication',
'SECURITY_TOKEN',
self.security_token)
self.guest_username = parse_string(parser, 'authentication',
'GUEST_USERNAME',
self.guest_username)
self.guest_password = parse_literal(parser, 'authentication',
'GUEST_PASSWORD',
self.guest_password)
# database
self.database_name = parse_string(parser, 'database', 'DATABASE',
self.database_name)
self.table_prefix = parse_string(parser, 'database',
'TABLE_PREFIX', self.table_prefix)
# visualization
self.colors = parse_literal(parser, 'visualization', 'COLORS',
self.colors)
self.timezone = pytz.timezone(
parse_string(parser, 'visualization', 'TIMEZONE',
self.timezone.zone))
except configparser.Error:
raise
def init_from(self, file=None, envvar=None, log_verbose=False):
"""
The config_file must at least contains the following variables in section 'dashboard':
- APP_VERSION: the version of the app that you use. Updating the version helps in
showing differences in execution times of a function over a period of time.
- GIT = If you're using git, then it is easier to set the location to the .git-folder,
The location is relative to the config-file.
- BLUEPRINT_NAME: The name of the blueprint the FMD adds to the Flask app.
default: "dashboard"
- CUSTOM_LINK: The dashboard can be visited at localhost:5000/{CUSTOM_LINK}.
- MONITOR_LEVEL: The level for monitoring your endpoints. The default value is 3.
- OUTLIER_DETECTION_CONSTANT: When the execution time is more than this constant *
average, extra information is logged into the database. A default value for this
variable is 2.5.
- SAMPLING_PERIOD: Time between two profiler-samples. The time must be specified in ms.
If this value is not set, the profiler continuously monitors.
- ENABLE_LOGGING: Boolean if you want additional logs to be printed to the console.
Default value is False
- BRAND_NAME: The name displayed in the Dashboard Navbar.
Default value is 'Flask Monitoring Dashboard'
- TITLE_NAME: The name displayed in the browser tab.
Default value is 'Flask-MonitoringDashboard'
- DESCRIPTION: The text displayed in center of the Dashboard Navbar.
Default value is 'Automatically monitor the evolving performance of Flask/Python web services'
- SHOW_LOGIN_BANNER: Boolean if you want the login page to show the 'Flask Monitoring Dashboard' logo and title.
Default value is True
- SHOW_LOGIN_FOOTER: Boolean if you want the login page to show a link to the official documentation.
Default value is True
The config_file must at least contains the following variables in section
'authentication':
- USERNAME: for logging into the dashboard, a username and password is required. The
username can be set using this variable.
- PASSWORD: same as for the username, but this is the password variable.
- SECURITY_TOKEN: Used for getting the data in /get_json_data
The config_file must at least contains the following variables in section 'database':
- DATABASE: Suppose you have multiple projects where you're working on and want to
separate the results. Then you can specify different database_names, such that the
result of each project is stored in its own database.
- TABLE_PREFIX: A prefix to every table that the Flask-MonitoringDashboard uses, to
ensure that there are no conflicts with the user of the dashboard.
The config_file must at least contains the following variables in section
'visualization':
- TIMEZONE: The timezone for converting a UTC timestamp to a local timestamp.
for a list of all timezones, use the following:
>>> import pytz # pip install pytz
>>> print(pytz.all_timezones)
- COLORS: A dictionary to override the colors used per endpoint.
:param file: a string pointing to the location of the config-file.
:param envvar: a string specifying which environment variable holds the config file
location.
:param log_verbose: flag to print the location of the config file.
"""
if envvar:
file = os.getenv(envvar)
if log_verbose:
log("Running with config from: " + (str(file)))
if not file:
# Travis does not need a config file.
if '/home/travis/build/' in os.getcwd():
return
log("No configuration file specified. Please do so.")
return
try:
parser = configparser.RawConfigParser()
parser.read(file)
# parse 'dashboard'
self.version = parse_version(parser, 'dashboard', self.version)
self.blueprint_name = parse_string(parser, 'dashboard', 'BLUEPRINT_NAME',
self.blueprint_name)
self.link = parse_string(parser, 'dashboard', 'CUSTOM_LINK', self.link)
self.monitor_level = parse_literal(
parser, 'dashboard', 'MONITOR_LEVEL', self.monitor_level
)
self.outlier_detection_constant = parse_literal(
parser, 'dashboard', 'OUTlIER_DETECTION_CONSTANT', self.outlier_detection_constant
)
self.sampling_period = (
parse_literal(parser, 'dashboard', 'SAMPLING_RATE', self.sampling_period) / 1000.0
)
self.enable_logging = parse_bool(
parser, 'dashboard', 'ENABLE_LOGGING', self.enable_logging
)
self.brand_name = parse_string(parser, 'dashboard', 'BRAND_NAME', self.brand_name)
self.title_name = parse_string(parser, 'dashboard', 'TITLE_NAME', self.title_name)
self.description = parse_string(parser, 'dashboard', 'DESCRIPTION', self.description)
self.show_login_banner = parse_bool(parser, 'dashboard', 'SHOW_LOGIN_BANNER', self.show_login_banner)
self.show_login_footer = parse_bool(parser, 'dashboard', 'SHOW_LOGIN_FOOTER', self.show_login_footer)
# parse 'authentication'
self.username = parse_string(parser, 'authentication', 'USERNAME', self.username)
self.password = parse_string(parser, 'authentication', 'PASSWORD', self.password)
self.security_token = parse_string(
parser, 'authentication', 'SECURITY_TOKEN', self.security_token
)
# database
self.database_name = parse_string(parser, 'database', 'DATABASE', self.database_name)
self.table_prefix = parse_string(parser, 'database', 'TABLE_PREFIX', self.table_prefix)
# visualization
self.colors = parse_literal(parser, 'visualization', 'COLORS', self.colors)
self.timezone = pytz.timezone(
parse_string(parser, 'visualization', 'TIMEZONE', self.timezone.zone)
)
if log_verbose:
log("version: " + self.version)
log("username: " + self.username)
except AttributeError:
log('Cannot use configparser in python2.7')
raise
