28a24b0c4 · cryptotaxi247/netdata-1

@@ -44,13 +44,13 @@ CHARTS = {

44 ['resp_time_avg', 'avg', 'absolute', 1, 1]

45 ]},

46 'clients': {

47 - 'options': [None, 'Current Poll Unique Client IPs', 'unique ips', 'unique clients', 'web_log.clients', 'line'],

47 + 'options': [None, 'Current Poll Unique Client IPs', 'unique ips', 'unique clients', 'web_log.clients', 'stacked'],

48 'lines': [

49 ['unique_cur_ipv4', 'ipv4', 'absolute', 1, 1],

50 ['unique_cur_ipv6', 'ipv6', 'absolute', 1, 1]

51 ]},

52 'clients_all': {

53 - 'options': [None, 'All Time Unique Client IPs', 'unique ips', 'unique clients', 'web_log.clients_all', 'line'],

53 + 'options': [None, 'All Time Unique Client IPs', 'unique ips', 'unique clients', 'web_log.clients_all', 'stacked'],

54 'lines': [

55 ['unique_tot_ipv4', 'ipv4', 'absolute', 1, 1],

56 ['unique_tot_ipv6', 'ipv6', 'absolute', 1, 1]

@@ -67,7 +67,7 @@ NAMED_URL_PATTERN = namedtuple('URL_PATTERN', ['description', 'pattern'])

67 class Service(LogService):

68 def __init__(self, configuration=None, name=None):

69 LogService.__init__(self, configuration=configuration, name=name)

70 - # Vars from module configuration file

70 + # Variables from module configuration file

71 self.log_path = self.configuration.get('path')

72 self.detailed_response_codes = self.configuration.get('detailed_response_codes', True)

73 self.all_time = self.configuration.get('all_time', True)

@@ -119,6 +119,14 @@ class Service(LogService):

119 return True

120

121 def find_regex(self, last_line):

122 + """

123 + :param last_line: str: literally last line from log file

124 + :return: parsed line, regex name (the one that matches) OR None, None

125 + It's sad but different web servers has different logs formats

126 + We need to find appropriate regex for current log file

127 + All logic is do a regex search through the string for all patterns

128 + until we find something or fail.

129 + """

130 # REGEX: 1.IPv4 address 2.HTTP method 3. URL 4. Response code

131 # 5. Bytes sent 6. Response length 7. Response process time

132 default = re.compile(r'([\da-f.:]+)'

@@ -160,13 +168,31 @@ class Service(LogService):

168 return None, None

169

170 def create_charts(self, parsed_line, regex_name):

171 + """

172 + :param parsed_line: list: re.findall result.

173 + :param regex_name: str: regex name from 'find_regex' method. Ex.: 'apache_extended', 'nginx_extended'

174 + :return:

175 + Create additional charts depending on the 'find_regex' result (parsed_line) and configuration file

176 + 1. 'time_response' chart is removed if there is no 'time_response' in logs.

177 + 2. We need to change divisor for 'response_time' chart for apache (time in microseconds in logs)

178 + 3. Other stuff is just remove/add chart depending on yes/no in conf

179 + """

180 def find_job_name(override_name, name):

181 + """

182 + :param override_name: str: 'name' var from configuration file

183 + :param name: str: 'job_name' from configuration file

184 + :return: str: new job name

185 + We need this for dynamic charts. Actually same logic as in python.d.plugin.

186 + """

187 add_to_name = override_name or name

188 if add_to_name:

189 return '_'.join(['web_log', add_to_name])

190 else:

191 return 'web_log'

192

193 + self.order = ORDER[:]

194 + self.definitions = deepcopy(CHARTS)

195 +

196 job_name = find_job_name(self.override_name, self.name)

197 self.detailed_chart = 'CHART %s.detailed_response_codes ""' \

198 ' "Response Codes" requests/s responses' \

@@ -174,8 +200,7 @@ class Service(LogService):

200 self.http_method_chart = 'CHART %s.http_method' \

201 ' "" "HTTP Methods" requests/s requests' \

202 ' web_log.http_method stacked 2 %s\n' % (job_name, self.update_every)

177 - self.order = ORDER[:]

178 - self.definitions = deepcopy(CHARTS)

203 +

204 if 'apache' in regex_name:

205 self.definitions['response_time']['lines'][0][4] = 1000

206 self.definitions['response_time']['lines'][1][4] = 1000

@@ -208,6 +233,13 @@ class Service(LogService):

233 self.order.remove('requests_per_url')

234

235 def add_new_dimension(self, dimension, line_list, chart_string, key):

236 + """

237 + :param dimension: str: response status code. Ex.: '202', '499'

238 + :param line_list: list: Ex.: ['202', '202', 'Absolute']

239 + :param chart_string: Current string we need to pass to netdata to rebuild the chart

240 + :param key: str: CHARTS dict key (chart name). Ex.: 'response_time'

241 + :return: str: new chart string = previous + new dimensions

242 + """

243 self.storage.update({dimension: 0})

244 # SET method check if dim in _dimensions

245 self._dimensions.append(dimension)

@@ -221,7 +253,9 @@ class Service(LogService):

253 def _get_data(self):

254 """

255 Parse new log lines

224 - :return: dict

256 + :return: dict OR None

257 + None if _get_raw_data method fails.

258 + In all other cases - dict.

259 """

260 raw = self._get_raw_data()

261 if raw is None:

@@ -279,11 +313,18 @@ class Service(LogService):

313 to_netdata['resp_time_min'] = request_time[0]

314 to_netdata['resp_time_avg'] = float(request_counter['sum']) / request_counter['count']

315 to_netdata['resp_time_max'] = request_time[-1]

316 +

317 to_netdata.update(self.storage)

318 to_netdata.update(default_dict)

319 return to_netdata

320

321 def _get_data_detailed_response_codes(self, code, default_dict):

322 + """

323 + :param code: str: CODE from parsed line. Ex.: '202, '499'

324 + :param default_dict: defaultdict

325 + :return:

326 + Calls add_new_dimension method If the value is found for the first time

327 + """

328 if code not in self.storage:

329 chart_string_copy = self.detailed_chart

330 self.detailed_chart = self.add_new_dimension(code, [code, code, 'absolute'],

@@ -291,6 +332,12 @@ class Service(LogService):

332 default_dict[code] += 1

333

334 def _get_data_http_method(self, method, default_dict):

335 + """

336 + :param method: str: METHOD from parsed line. Ex.: 'GET', 'POST'

337 + :param default_dict: defaultdict

338 + :return:

339 + Calls add_new_dimension method If the value is found for the first time

340 + """

341 if method not in self.storage:

342 chart_string_copy = self.http_method_chart

343 self.http_method_chart = self.add_new_dimension(method, [method, method, 'absolute'],

@@ -298,6 +345,13 @@ class Service(LogService):

345 default_dict[method] += 1

346

347 def _get_data_per_url(self, url, default_dict):

348 + """

349 + :param url: str: URL from parsed line

350 + :param default_dict: defaultdict

351 + :return:

352 + Scan through string looking for the first location where patterns produce a match for all user

353 + defined patterns

354 + """

355 match = None

356 for elem in self.url_pattern:

357 if elem.pattern.search(url):

@@ -309,6 +363,13 @@ class Service(LogService):

363

364

365 def address_not_in_pool(pool, address, pool_size):

366 + """

367 + :param pool: list of ip addresses

368 + :param address: ip address

369 + :param pool_size: current size of pool

370 + :return: True if address not pool and False address in pool

371 + If address not in pool function add address to pool.

372 + """

373 index = bisect.bisect_left(pool, address)

374 if index < pool_size:

375 if pool[index] == address:

web_log plugin: minor fixes plus some documentation