retries = 60
ORDER = ['response_statuses', 'response_codes', 'bandwidth', 'response_time', 'requests_per_url', 'http_method',
- 'requests_per_ipproto', 'clients', 'clients_all']
+ 'http_version', 'requests_per_ipproto', 'clients', 'clients_all']
CHARTS = {
'response_codes': {
'options': [None, 'Response Codes', 'requests/s', 'responses', 'web_log.response_codes', 'stacked'],
'lines': [
['GET', 'GET', 'incremental', 1, 1]
]},
+ 'http_version': {
+ 'options': [None, 'Requests Per HTTP Version', 'requests/s', 'http versions',
+ 'web_log.http_version', 'stacked'],
+ 'lines': []},
'requests_per_ipproto': {
'options': [None, 'Requests Per IP Protocol', 'requests/s', 'ip protocols', 'web_log.requests_per_ipproto',
'stacked'],
NAMED_URL_PATTERN = namedtuple('URL_PATTERN', ['description', 'pattern'])
+DET_RESP_AGGR = ['', '_1xx', '_2xx', '_3xx', '_4xx', '_5xx', '_Other']
+
class Service(LogService):
def __init__(self, configuration=None, name=None):
# self._get_data = None # will be assigned in 'check' method.
# self.order = None # will be assigned in 'create_*_method' method.
# self.definitions = None # will be assigned in 'create_*_method' method.
- # self.detailed_chart = None # will be assigned in 'create_*_method' method.
- # self.http_method_chart = None # will be assigned in 'create_*_method' method.
"""
LogService.__init__(self, configuration=configuration, name=name)
# Variables from module configuration file
+ self.log_type = self.configuration.get('type', 'web_access')
self.log_path = self.configuration.get('path')
- self.detailed_response_codes = self.configuration.get('detailed_response_codes', True)
- self.all_time = self.configuration.get('all_time', True)
self.url_pattern = self.configuration.get('categories') # dict
self.custom_log_format = self.configuration.get('custom_log_format') # dict
# Instance variables
- self.unique_all_time = list() # sorted list of unique IPs
self.regex = None # will be assigned in 'find_regex' or 'find_regex_custom' method
- self.resp_time_func = None # will be assigned in 'find_regex' or 'find_regex_custom' method
self.data = {'bytes_sent': 0, 'resp_length': 0, 'resp_time_min': 0, 'resp_time_max': 0,
'resp_time_avg': 0, 'unique_cur_ipv4': 0, 'unique_cur_ipv6': 0, '2xx': 0,
'5xx': 0, '3xx': 0, '4xx': 0, '1xx': 0, '0xx': 0, 'unmatched': 0, 'req_ipv4': 0,
"""
:return: bool
- We need to make sure:
1. "log_path" is specified in the module configuration file
2. "log_path" must be readable by netdata user and must exist
3. "log_path' must not be empty. We need at least 1 line to find appropriate pattern to parse
- 4. Plugin can work using predefined patterns (OK for nginx, apache default log format) or user defined
- pattern. So we need to check if we can parse last line from log file with user pattern OR module patterns.
- 5. All patterns for per_url_request_counter feature are valid regex expressions
+ 4. other checks depends on log "type"
"""
if not self.log_path:
self.error('log path is not specified')
self.error(str(error))
return False
- # Custom_log_format or predefined log format.
- if self.custom_log_format:
- match_dict, log_name, error = self.find_regex_custom(last_line)
- else:
- match_dict, log_name, error = self.find_regex(last_line)
+ if self.log_type == 'web_access':
+ self.unique_all_time = list() # sorted list of unique IPs
+ self.detailed_response_codes = self.configuration.get('detailed_response_codes', True)
+ self.detailed_response_aggregate = self.configuration.get('detailed_response_aggregate', True)
+ self.all_time = self.configuration.get('all_time', True)
- # "match_dict" is None if there are any problems
- if match_dict is None:
- self.error(str(error))
- return False
+ # Custom_log_format or predefined log format.
+ if self.custom_log_format:
+ match_dict, error = self.find_regex_custom(last_line)
+ else:
+ match_dict, error = self.find_regex(last_line)
- # self.url_pattern check
- if self.url_pattern:
- self.url_pattern = check_req_per_url_pattern(self.url_pattern)
+ # "match_dict" is None if there are any problems
+ if match_dict is None:
+ self.error(str(error))
+ return False
- # Double check
- if not (self.regex and self.resp_time_func):
- self.error('That can not happen, but it happened. "regex" or "resp_time_func" is None')
+ # self.url_pattern check
+ if self.url_pattern:
+ self.url_pattern = check_req_per_url_pattern('rpu', self.url_pattern)
- # All is ok. We are about to start.
- if log_name == 'web_access':
self.create_access_charts(match_dict) # Create charts
- self._get_data = self._get_access_data
- self.info('Collected data: %s' % list(match_dict.keys()))
- return True
+ self._get_data = self._get_access_data # _get_data assignment
else:
- # If it's not access_logs.. Not used at the moment
+ self.error('Not implemented')
return False
+ # Double check
+ if not self.regex:
+ self.error('That can not happen, but it happened. "regex" is None')
+
+ self.info('Collected data: %s' % list(match_dict.keys()))
+ return True
+
def find_regex_custom(self, last_line):
"""
:param last_line: str: literally last line from log file
:return: tuple where:
[0]: dict or None: match_dict or None
- [1]: str or None: log_name or None
- [2]: str: error description
+ [1]: str: error description
We are here only if "custom_log_format" is in logs. We need to make sure:
1. "custom_log_format" is a dict
("resp_length" is integer or "-", "resp_time" is integer or float)
"""
- if not is_dict(self.custom_log_format):
+ if not hasattr(self.custom_log_format, 'keys'):
return find_regex_return(msg='Custom log: "custom_log_format" is not a <dict>')
pattern = self.custom_log_format.get('pattern')
'method': r'[A-Z]+',
'bytes_sent': r'\d+|-'}
optional_dict = {'resp_length': r'\d+',
- 'resp_time': r'[\d.]+'}
+ 'resp_time': r'[\d.]+',
+ 'http_version': r'\d\.\d'}
mandatory_values = set(mandatory_dict) - set(match_dict)
if mandatory_values:
return find_regex_return(msg='Custom log: search OK but some mandatory keys (%s) are missing'
- % list(mandatory_values))
+ % list(mandatory_values))
else:
for key in mandatory_dict:
if not re.search(mandatory_dict[key], match_dict[key]):
self.resp_time_func = lambda time: time * (resp_time_func or 1)
self.regex = regex
- return find_regex_return(match_dict=match_dict,
- log_name='web_access')
+ return find_regex_return(match_dict=match_dict)
def find_regex(self, last_line):
"""
:param last_line: str: literally last line from log file
:return: tuple where:
[0]: dict or None: match_dict or None
- [1]: str or None: log_name or None
- [2]: str: error description
+ [1]: str: error description
We need to find appropriate pattern for current log file
All logic is do a regex search through the string for all predefined patterns
until we find something or fail.
# 5. Bytes sent 6. Response length 7. Response process time
acs_default = re.compile(r'(?P<address>[\da-f.:]+)'
r' -.*?"(?P<method>[A-Z]+)'
- r' (?P<url>.*?)"'
+ r' (?P<url>[^ ]+)'
+ r' [A-Z]+/(?P<http_version>\d\.\d)"'
r' (?P<code>[1-9]\d{2})'
r' (?P<bytes_sent>\d+|-)')
acs_apache_ext_insert = re.compile(r'(?P<address>[\da-f.:]+)'
r' -.*?"(?P<method>[A-Z]+)'
- r' (?P<url>.*?)"'
+ r' (?P<url>[^ ]+)'
+ r' [A-Z]+/(?P<http_version>\d\.\d)"'
r' (?P<code>[1-9]\d{2})'
r' (?P<bytes_sent>\d+|-)'
r' (?P<resp_length>\d+)'
acs_apache_ext_append = re.compile(r'(?P<address>[\da-f.:]+)'
r' -.*?"(?P<method>[A-Z]+)'
- r' (?P<url>.*?)"'
+ r' (?P<url>[^ ]+)'
+ r' [A-Z]+/(?P<http_version>\d\.\d)"'
r' (?P<code>[1-9]\d{2})'
r' (?P<bytes_sent>\d+|-)'
r' .*?'
acs_nginx_ext_insert = re.compile(r'(?P<address>[\da-f.:]+)'
r' -.*?"(?P<method>[A-Z]+)'
- r' (?P<url>.*?)"'
+ r' (?P<url>[^ ]+)'
+ r' [A-Z]+/(?P<http_version>\d\.\d)"'
r' (?P<code>[1-9]\d{2})'
r' (?P<bytes_sent>\d+)'
r' (?P<resp_length>\d+)'
- r' (?P<resp_time>\d\.\d+) ')
+ r' (?P<resp_time>\d+\.\d+) ')
acs_nginx_ext_append = re.compile(r'(?P<address>[\da-f.:]+)'
r' -.*?"(?P<method>[A-Z]+)'
- r' (?P<url>.*?)"'
+ r' (?P<url>[^ ]+)'
+ r' [A-Z]+/(?P<http_version>\d\.\d)"'
r' (?P<code>[1-9]\d{2})'
r' (?P<bytes_sent>\d+)'
r' .*?'
r' (?P<resp_length>\d+)'
- r' (?P<resp_time>\d\.\d+)')
+ r' (?P<resp_time>\d+\.\d+)')
def func_usec(time):
return time
break
return find_regex_return(match_dict=match_dict or None,
- log_name='web_access',
msg='Unknown log format. You need to use "custom_log_format" feature.')
def create_access_charts(self, match_dict):
1. 'time_response' chart is removed if there is no 'resp_time' in match_dict.
2. Other stuff is just remove/add chart depending on yes/no in conf
"""
+
def find_job_name(override_name, name):
"""
:param override_name: str: 'name' var from configuration file
self.definitions = deepcopy(CHARTS)
job_name = find_job_name(self.override_name, self.name)
- self.detailed_chart = 'CHART %s.detailed_response_codes ""' \
- ' "Detailed Response Codes" requests/s responses' \
- ' web_log.detailed_response_codes stacked 1 %s\n' % (job_name, self.update_every)
+
self.http_method_chart = 'CHART %s.http_method' \
' "" "Requests Per HTTP Method" requests/s "http methods"' \
- ' web_log.http_method stacked 2 %s\n' \
+ ' web_log.http_method stacked 11 %s\n' \
'DIMENSION GET GET incremental\n' % (job_name, self.update_every)
+ self.http_version_chart = 'CHART %s.http_version' \
+ ' "" "Requests Per HTTP Version" requests/s "http versions"' \
+ ' web_log.http_version stacked 12 %s\n' % (job_name, self.update_every)
# Remove 'request_time' chart from ORDER if resp_time not in match_dict
if 'resp_time' not in match_dict:
self.order.remove('clients_all')
# Add 'detailed_response_codes' chart if specified in the configuration
if self.detailed_response_codes:
- self.order.append('detailed_response_codes')
- self.definitions['detailed_response_codes'] = {'options': [None, 'Detailed Response Codes', 'requests/s',
- 'responses', 'web_log.detailed_response_codes',
- 'stacked'],
- 'lines': []}
+ self.detailed_chart = list()
+ for prio, add_to_dim in enumerate(DET_RESP_AGGR):
+ self.detailed_chart.append('CHART %s.detailed_response_codes%s ""'
+ ' "Detailed Response Codes %s" requests/s responses'
+ ' web_log.detailed_response_codes%s stacked %s %s\n'
+ % (job_name, add_to_dim, add_to_dim[1:], add_to_dim,
+ str(prio), self.update_every))
+
+ codes = DET_RESP_AGGR[:1] if self.detailed_response_aggregate else DET_RESP_AGGR[1:]
+ for code in codes:
+ self.order.append('detailed_response_codes%s' % code)
+ self.definitions['detailed_response_codes%s' % code] = {'options':
+ [None,
+ 'Detailed Response Codes %s' % code[1:],
+ 'requests/s',
+ 'responses',
+ 'web_log.detailed_response_codes%s' % code,
+ 'stacked'],
+ 'lines': []}
# Add 'requests_per_url' chart if specified in the configuration
if self.url_pattern:
self.definitions['requests_per_url'] = {'options': [None, 'Requests Per Url', 'requests/s',
'urls', 'web_log.requests_per_url', 'stacked'],
- 'lines': [['pur_other', 'other', 'incremental']]}
+ 'lines': [['rpu_other', 'other', 'incremental']]}
for elem in self.url_pattern:
self.definitions['requests_per_url']['lines'].append([elem.description, elem.description[4:],
'incremental'])
self.data.update({elem.description: 0})
- self.data.update({'pur_other': 0})
+ self.data.update({'rpu_other': 0})
else:
self.order.remove('requests_per_url')
self._get_data_per_url(match_dict['url'])
# requests per http method
self._get_data_http_method(match_dict['method'])
+ # requests per http version
+ if 'http_version' in match_dict:
+ self._get_data_http_version(match_dict['http_version'])
# bandwidth sent
bytes_sent = match_dict['bytes_sent'] if '-' not in match_dict['bytes_sent'] else 0
self.data['bytes_sent'] += int(bytes_sent)
# unique clients ips
if address_not_in_pool(self.unique_all_time, match_dict['address'],
self.data['unique_tot_ipv4'] + self.data['unique_tot_ipv6']):
- self.data['unique_tot_' + proto] += 1
+ self.data['unique_tot_' + proto] += 1
if address_not_in_pool(unique_current, match_dict['address'], ip_address_counter['unique_cur_ip']):
- self.data['unique_cur_' + proto] += 1
- ip_address_counter['unique_cur_ip'] += 1
+ self.data['unique_cur_' + proto] += 1
+ ip_address_counter['unique_cur_ip'] += 1
else:
self.data['unmatched'] += 1
Calls add_new_dimension method If the value is found for the first time
"""
if code not in self.data:
- chart_string_copy = self.detailed_chart
- self.detailed_chart = self.add_new_dimension(code, [code, code, 'incremental'],
- chart_string_copy, 'detailed_response_codes')
+ if self.detailed_response_aggregate:
+ chart_string_copy = self.detailed_chart[0]
+ self.detailed_chart[0] = self.add_new_dimension(code, [code, code, 'incremental'],
+ chart_string_copy, 'detailed_response_codes')
+ else:
+ code_index = int(code[0]) if int(code[0]) < 6 else 6
+ chart_string_copy = self.detailed_chart[code_index]
+ chart_name = 'detailed_response_codes' + DET_RESP_AGGR[code_index]
+ self.detailed_chart[code_index] = self.add_new_dimension(code, [code, code, 'incremental'],
+ chart_string_copy, chart_name)
self.data[code] += 1
def _get_data_http_method(self, method):
chart_string_copy, 'http_method')
self.data[method] += 1
+ def _get_data_http_version(self, http_version):
+ """
+ :param http_version: str: METHOD from parsed line. Ex.: '1.1', '1.0'
+ :return:
+ Calls add_new_dimension method If the value is found for the first time
+ """
+ http_version_dim_id = http_version.replace('.', '_')
+ if http_version_dim_id not in self.data:
+ chart_string_copy = self.http_version_chart
+ self.http_version_chart = self.add_new_dimension(http_version_dim_id,
+ [http_version_dim_id, http_version, 'incremental'],
+ chart_string_copy, 'http_version')
+ self.data[http_version_dim_id] += 1
+
def _get_data_per_url(self, url):
"""
:param url: str: URL from parsed line
match = True
break
if not match:
- self.data['pur_other'] += 1
+ self.data['rpu_other'] += 1
def _get_data_statuses(self, code):
"""
return True
-def find_regex_return(match_dict=None, log_name=None, msg='Generic error message'):
+def find_regex_return(match_dict=None, msg='Generic error message'):
"""
:param match_dict: dict: re.search.groupdict() or None
- :param log_name: str: log name
:param msg: str: error description
:return: tuple:
"""
- return match_dict, log_name, msg
+ return match_dict, msg
-def check_req_per_url_pattern(url_pattern):
+def check_req_per_url_pattern(string, url_pattern):
"""
+ :param string: str:
:param url_pattern: dict: ex. {'dim1': 'pattern1>', 'dim2': '<pattern2>'}
:return: list of named tuples or None:
We need to make sure all patterns are valid regular expressions
"""
- if not is_dict(url_pattern):
+ if not hasattr(url_pattern, 'keys'):
return None
result = list()
for dimension, regex in url_pattern.items():
valid_pattern = is_valid_pattern(regex)
if isinstance(dimension, str) and valid_pattern:
- result.append(NAMED_URL_PATTERN(description='_'.join(['pur', dimension]), pattern=valid_pattern))
+ result.append(NAMED_URL_PATTERN(description='_'.join([string, dimension]), pattern=valid_pattern))
return result or None
-
-
-def is_dict(obj):
- """
- :param obj: dict:
- :return: True or False
- obj can be <dict> or <OrderedDict>
- """
- try:
- obj.keys()
- except AttributeError:
- return False
- else:
- return True
projects / netdata.git / blobdiff