1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
# -*- coding: utf-8 -*-
# Description: tomcat netdata python.d module
# Author: Pawel Krupa (paulfantom)
# Author: Wei He (Wing924)
# SPDX-License-Identifier: GPL-3.0-or-later
import xml.etree.ElementTree as ET
import re
from bases.FrameworkServices.UrlService import UrlService
MiB = 1 << 20
# Regex fix for Tomcat single quote XML attributes
# affecting Tomcat < 8.5.24 & 9.0.2 running with Java > 9
# cf. https://bz.apache.org/bugzilla/show_bug.cgi?id=61603
single_quote_regex = re.compile(r"='([^']+)'([^']+)''")
ORDER = [
'accesses',
'bandwidth',
'processing_time',
'threads',
'jvm',
'jvm_eden',
'jvm_survivor',
'jvm_tenured',
]
CHARTS = {
'accesses': {
'options': [None, 'Requests', 'requests/s', 'statistics', 'tomcat.accesses', 'area'],
'lines': [
['requestCount', 'accesses', 'incremental'],
['errorCount', 'errors', 'incremental'],
]
},
'bandwidth': {
'options': [None, 'Bandwidth', 'KiB/s', 'statistics', 'tomcat.bandwidth', 'area'],
'lines': [
['bytesSent', 'sent', 'incremental', 1, 1024],
['bytesReceived', 'received', 'incremental', 1, 1024],
]
},
'processing_time': {
'options': [None, 'processing time', 'seconds', 'statistics', 'tomcat.processing_time', 'area'],
'lines': [
['processingTime', 'processing time', 'incremental', 1, 1000]
]
},
'threads': {
'options': [None, 'Threads', 'current threads', 'statistics', 'tomcat.threads', 'area'],
'lines': [
['currentThreadCount', 'current', 'absolute'],
['currentThreadsBusy', 'busy', 'absolute']
]
},
'jvm': {
'options': [None, 'JVM Memory Pool Usage', 'MiB', 'memory', 'tomcat.jvm', 'stacked'],
'lines': [
['free', 'free', 'absolute', 1, MiB],
['eden_used', 'eden', 'absolute', 1, MiB],
['survivor_used', 'survivor', 'absolute', 1, MiB],
['tenured_used', 'tenured', 'absolute', 1, MiB],
['code_cache_used', 'code cache', 'absolute', 1, MiB],
['compressed_used', 'compressed', 'absolute', 1, MiB],
['metaspace_used', 'metaspace', 'absolute', 1, MiB],
]
},
'jvm_eden': {
'options': [None, 'Eden Memory Usage', 'MiB', 'memory', 'tomcat.jvm_eden', 'area'],
'lines': [
['eden_used', 'used', 'absolute', 1, MiB],
['eden_committed', 'committed', 'absolute', 1, MiB],
['eden_max', 'max', 'absolute', 1, MiB]
]
},
'jvm_survivor': {
'options': [None, 'Survivor Memory Usage', 'MiB', 'memory', 'tomcat.jvm_survivor', 'area'],
'lines': [
['survivor_used', 'used', 'absolute', 1, MiB],
['survivor_committed', 'committed', 'absolute', 1, MiB],
['survivor_max', 'max', 'absolute', 1, MiB],
]
},
'jvm_tenured': {
'options': [None, 'Tenured Memory Usage', 'MiB', 'memory', 'tomcat.jvm_tenured', 'area'],
'lines': [
['tenured_used', 'used', 'absolute', 1, MiB],
['tenured_committed', 'committed', 'absolute', 1, MiB],
['tenured_max', 'max', 'absolute', 1, MiB]
]
}
}
class Service(UrlService):
def __init__(self, configuration=None, name=None):
UrlService.__init__(self, configuration=configuration, name=name)
self.order = ORDER
self.definitions = CHARTS
self.url = self.configuration.get('url', 'http://127.0.0.1:8080/manager/status?XML=true')
self.connector_name = self.configuration.get('connector_name', None)
self.parse = self.xml_parse
def xml_parse(self, data):
try:
return ET.fromstring(data)
except ET.ParseError:
self.debug('%s is not a valid XML page. Please add "?XML=true" to tomcat status page.' % self.url)
return None
def xml_single_quote_fix_parse(self, data):
data = single_quote_regex.sub(r"='\g<1>\g<2>'", data)
return self.xml_parse(data)
def check(self):
self._manager = self._build_manager()
raw_data = self._get_raw_data()
if not raw_data:
return False
if single_quote_regex.search(raw_data):
self.warning('Tomcat status page is returning invalid single quote XML, please consider upgrading '
'your Tomcat installation. See https://bz.apache.org/bugzilla/show_bug.cgi?id=61603')
self.parse = self.xml_single_quote_fix_parse
return self.parse(raw_data) is not None
def _get_data(self):
"""
Format data received from http request
:return: dict
"""
data = None
raw_data = self._get_raw_data()
if raw_data:
xml = self.parse(raw_data)
if xml is None:
return None
data = {}
jvm = xml.find('jvm')
connector = None
if self.connector_name:
for conn in xml.findall('connector'):
if self.connector_name in conn.get('name'):
connector = conn
break
else:
connector = xml.find('connector')
memory = jvm.find('memory')
data['free'] = memory.get('free')
data['total'] = memory.get('total')
for pool in jvm.findall('memorypool'):
name = pool.get('name')
if 'Eden Space' in name:
data['eden_used'] = pool.get('usageUsed')
data['eden_committed'] = pool.get('usageCommitted')
data['eden_max'] = pool.get('usageMax')
elif 'Survivor Space' in name:
data['survivor_used'] = pool.get('usageUsed')
data['survivor_committed'] = pool.get('usageCommitted')
data['survivor_max'] = pool.get('usageMax')
elif 'Tenured Gen' in name or 'Old Gen' in name:
data['tenured_used'] = pool.get('usageUsed')
data['tenured_committed'] = pool.get('usageCommitted')
data['tenured_max'] = pool.get('usageMax')
elif name == 'Code Cache':
data['code_cache_used'] = pool.get('usageUsed')
data['code_cache_committed'] = pool.get('usageCommitted')
data['code_cache_max'] = pool.get('usageMax')
elif name == 'Compressed':
data['compressed_used'] = pool.get('usageUsed')
data['compressed_committed'] = pool.get('usageCommitted')
data['compressed_max'] = pool.get('usageMax')
elif name == 'Metaspace':
data['metaspace_used'] = pool.get('usageUsed')
data['metaspace_committed'] = pool.get('usageCommitted')
data['metaspace_max'] = pool.get('usageMax')
if connector is not None:
thread_info = connector.find('threadInfo')
data['currentThreadsBusy'] = thread_info.get('currentThreadsBusy')
data['currentThreadCount'] = thread_info.get('currentThreadCount')
request_info = connector.find('requestInfo')
data['processingTime'] = request_info.get('processingTime')
data['requestCount'] = request_info.get('requestCount')
data['errorCount'] = request_info.get('errorCount')
data['bytesReceived'] = request_info.get('bytesReceived')
data['bytesSent'] = request_info.get('bytesSent')
return data or None
|
