Browse Source
* Add osprofiler wsgi middleware. This middleware is used for 2 things:
1) It checks that person who wants to trace is trusted and knows
secret HMAC key.
2) It starts tracing in case of proper trace headers
and adds first wsgi trace point, with info about HTTP request
* Add initialization of osprofiler at start of service
Currently that includes oslo.messaging notifer instance creation
to send Ceilometer backend notifications.
* Traces HTTP/RPC/DB API calls
Demo: https://hieulq.github.io/cluster-create-false-new-html.html
Co-Authored-By: Hieu LE <hieulq@vn.fujitsu.com>
Implements: blueprint osprofiler-support-in-magnum
Change-Id: I7d68995aab81d365433950aada078ef1fcd5469b
changes/49/421749/12
Tovin Seven
6 years ago
committed by
Hieu LE
23 changed files with 577 additions and 24 deletions
@ -0,0 +1,20 @@
|
||||
# Copyright 2017 Fujitsu Ltd. |
||||
# All Rights Reserved. |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
||||
# not use this file except in compliance with the License. You may obtain |
||||
# a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
||||
# License for the specific language governing permissions and limitations |
||||
# under the License. |
||||
|
||||
# NOTE(hieulq): we monkey patch all eventlet services for easier tracking/debug |
||||
|
||||
import eventlet |
||||
|
||||
eventlet.monkey_patch() |
||||
@ -0,0 +1,86 @@
|
||||
# Copyright 2017 Fujitsu Ltd. |
||||
# All Rights Reserved. |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
||||
# not use this file except in compliance with the License. You may obtain |
||||
# a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
||||
# License for the specific language governing permissions and limitations |
||||
# under the License. |
||||
|
||||
### |
||||
# This code is taken from nova. Goal is minimal modification. |
||||
### |
||||
|
||||
from oslo_log import log as logging |
||||
from oslo_utils import importutils |
||||
import webob.dec |
||||
|
||||
from magnum.common import context |
||||
import magnum.conf |
||||
from magnum.i18n import _LI |
||||
|
||||
profiler = importutils.try_import("osprofiler.profiler") |
||||
profiler_initializer = importutils.try_import("osprofiler.initializer") |
||||
profiler_web = importutils.try_import("osprofiler.web") |
||||
|
||||
|
||||
CONF = magnum.conf.CONF |
||||
|
||||
LOG = logging.getLogger(__name__) |
||||
|
||||
|
||||
class WsgiMiddleware(object): |
||||
|
||||
def __init__(self, application, **kwargs): |
||||
self.application = application |
||||
|
||||
@classmethod |
||||
def factory(cls, global_conf, **local_conf): |
||||
if profiler_web: |
||||
return profiler_web.WsgiMiddleware.factory(global_conf, |
||||
**local_conf) |
||||
|
||||
def filter_(app): |
||||
return cls(app, **local_conf) |
||||
|
||||
return filter_ |
||||
|
||||
@webob.dec.wsgify |
||||
def __call__(self, request): |
||||
return request.get_response(self.application) |
||||
|
||||
|
||||
def setup(binary, host): |
||||
if CONF.profiler.enabled: |
||||
profiler_initializer.init_from_conf( |
||||
conf=CONF, |
||||
context=context.get_admin_context().to_dict(), |
||||
project="magnum", |
||||
service=binary, |
||||
host=host) |
||||
LOG.info(_LI("OSprofiler is enabled.")) |
||||
|
||||
|
||||
def trace_cls(name, **kwargs): |
||||
"""Wrap the OSprofiler trace_cls. |
||||
|
||||
Wrap the OSprofiler trace_cls decorator so that it will not try to |
||||
patch the class unless OSprofiler is present. |
||||
|
||||
:param name: The name of action. For example, wsgi, rpc, db, ... |
||||
:param kwargs: Any other keyword args used by profiler.trace_cls |
||||
""" |
||||
|
||||
def decorator(cls): |
||||
if profiler and 'profiler' in CONF: |
||||
trace_decorator = profiler.trace_cls(name, kwargs) |
||||
return trace_decorator(cls) |
||||
return cls |
||||
|
||||
return decorator |
||||
@ -0,0 +1,27 @@
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may not |
||||
# use this file except in compliance with the License. You may obtain a copy |
||||
# of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, |
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
# See the License for the specific language governing permissions and |
||||
# limitations under the License. |
||||
|
||||
from oslo_utils import importutils |
||||
|
||||
|
||||
profiler_opts = importutils.try_import('osprofiler.opts') |
||||
|
||||
|
||||
def register_opts(conf): |
||||
if profiler_opts: |
||||
profiler_opts.set_defaults(conf) |
||||
|
||||
|
||||
def list_opts(): |
||||
return { |
||||
profiler_opts._profiler_opt_group: profiler_opts._PROFILER_OPTS |
||||
} |
||||
@ -0,0 +1,75 @@
|
||||
# Copyright 2017 OpenStack Foundation |
||||
# All Rights Reserved. |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
||||
# not use this file except in compliance with the License. You may obtain |
||||
# a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
||||
# License for the specific language governing permissions and limitations |
||||
# under the License. |
||||
|
||||
import inspect |
||||
import mock |
||||
|
||||
from oslo_utils import importutils |
||||
from osprofiler import initializer as profiler_init |
||||
from osprofiler import opts as profiler_opts |
||||
import six.moves as six |
||||
|
||||
from magnum.common import profiler |
||||
from magnum import conf |
||||
from magnum.tests import base |
||||
|
||||
|
||||
class TestProfiler(base.TestCase): |
||||
def test_all_public_methods_are_traced(self): |
||||
profiler_opts.set_defaults(conf.CONF) |
||||
self.config(enabled=True, |
||||
group='profiler') |
||||
|
||||
classes = [ |
||||
'magnum.conductor.api.API', |
||||
'magnum.conductor.api.ListenerAPI', |
||||
'magnum.conductor.handlers.ca_conductor.Handler', |
||||
'magnum.conductor.handlers.cluster_conductor.Handler', |
||||
'magnum.conductor.handlers.conductor_listener.Handler', |
||||
'magnum.conductor.handlers.indirection_api.Handler', |
||||
'magnum.service.periodic.MagnumPeriodicTasks', |
||||
] |
||||
for clsname in classes: |
||||
# give the metaclass and trace_cls() decorator a chance to patch |
||||
# methods of the classes above |
||||
six.reload_module( |
||||
importutils.import_module(clsname.rsplit('.', 1)[0])) |
||||
cls = importutils.import_class(clsname) |
||||
|
||||
for attr, obj in cls.__dict__.items(): |
||||
# only public methods are traced |
||||
if attr.startswith('_'): |
||||
continue |
||||
# only checks callables |
||||
if not (inspect.ismethod(obj) or inspect.isfunction(obj)): |
||||
continue |
||||
# osprofiler skips static methods |
||||
if isinstance(obj, staticmethod): |
||||
continue |
||||
|
||||
self.assertTrue(getattr(obj, '__traced__', False), obj) |
||||
|
||||
@mock.patch.object(profiler_init, 'init_from_conf') |
||||
def test_setup_profiler(self, mock_init): |
||||
self.config(enabled=True, |
||||
group='profiler') |
||||
|
||||
profiler.setup('foo', 'localhost') |
||||
|
||||
mock_init.assert_called_once_with(conf=conf.CONF, |
||||
context=mock.ANY, |
||||
project="magnum", |
||||
service='foo', |
||||
host='localhost') |
||||
@ -0,0 +1,252 @@
|
||||
# Copyright 2017 OpenStack Foundation |
||||
# All Rights Reserved. |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
||||
# not use this file except in compliance with the License. You may obtain |
||||
# a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
||||
# License for the specific language governing permissions and limitations |
||||
# under the License. |
||||
|
||||
import mock |
||||
import oslo_messaging as messaging |
||||
from oslo_serialization import jsonutils |
||||
|
||||
from magnum.common import context |
||||
from magnum.common import rpc |
||||
from magnum.tests import base |
||||
|
||||
|
||||
class TestRpc(base.TestCase): |
||||
@mock.patch.object(rpc, 'profiler', None) |
||||
@mock.patch.object(rpc, 'RequestContextSerializer') |
||||
@mock.patch.object(messaging, 'RPCClient') |
||||
def test_get_client(self, mock_client, mock_ser): |
||||
rpc.TRANSPORT = mock.Mock() |
||||
tgt = mock.Mock() |
||||
ser = mock.Mock() |
||||
mock_client.return_value = 'client' |
||||
mock_ser.return_value = ser |
||||
|
||||
client = rpc.get_client(tgt, version_cap='1.0', serializer='foo', |
||||
timeout=6969) |
||||
|
||||
mock_ser.assert_called_once_with('foo') |
||||
mock_client.assert_called_once_with(rpc.TRANSPORT, |
||||
tgt, version_cap='1.0', |
||||
serializer=ser, timeout=6969) |
||||
self.assertEqual('client', client) |
||||
|
||||
@mock.patch.object(rpc, 'profiler', mock.Mock()) |
||||
@mock.patch.object(rpc, 'ProfilerRequestContextSerializer') |
||||
@mock.patch.object(messaging, 'RPCClient') |
||||
def test_get_client_profiler_enabled(self, mock_client, mock_ser): |
||||
rpc.TRANSPORT = mock.Mock() |
||||
tgt = mock.Mock() |
||||
ser = mock.Mock() |
||||
mock_client.return_value = 'client' |
||||
mock_ser.return_value = ser |
||||
|
||||
client = rpc.get_client(tgt, version_cap='1.0', serializer='foo', |
||||
timeout=6969) |
||||
|
||||
mock_ser.assert_called_once_with('foo') |
||||
mock_client.assert_called_once_with(rpc.TRANSPORT, |
||||
tgt, version_cap='1.0', |
||||
serializer=ser, timeout=6969) |
||||
self.assertEqual('client', client) |
||||
|
||||
@mock.patch.object(rpc, 'profiler', None) |
||||
@mock.patch.object(rpc, 'RequestContextSerializer') |
||||
@mock.patch.object(messaging, 'get_rpc_server') |
||||
def test_get_server(self, mock_get, mock_ser): |
||||
rpc.TRANSPORT = mock.Mock() |
||||
ser = mock.Mock() |
||||
tgt = mock.Mock() |
||||
ends = mock.Mock() |
||||
mock_ser.return_value = ser |
||||
mock_get.return_value = 'server' |
||||
|
||||
server = rpc.get_server(tgt, ends, serializer='foo') |
||||
|
||||
mock_ser.assert_called_once_with('foo') |
||||
mock_get.assert_called_once_with(rpc.TRANSPORT, tgt, ends, |
||||
executor='eventlet', serializer=ser) |
||||
self.assertEqual('server', server) |
||||
|
||||
@mock.patch.object(rpc, 'profiler', mock.Mock()) |
||||
@mock.patch.object(rpc, 'ProfilerRequestContextSerializer') |
||||
@mock.patch.object(messaging, 'get_rpc_server') |
||||
def test_get_server_profiler_enabled(self, mock_get, mock_ser): |
||||
rpc.TRANSPORT = mock.Mock() |
||||
ser = mock.Mock() |
||||
tgt = mock.Mock() |
||||
ends = mock.Mock() |
||||
mock_ser.return_value = ser |
||||
mock_get.return_value = 'server' |
||||
|
||||
server = rpc.get_server(tgt, ends, serializer='foo') |
||||
|
||||
mock_ser.assert_called_once_with('foo') |
||||
mock_get.assert_called_once_with(rpc.TRANSPORT, tgt, ends, |
||||
executor='eventlet', serializer=ser) |
||||
self.assertEqual('server', server) |
||||
|
||||
@mock.patch.object(messaging, 'TransportURL') |
||||
def test_get_transport_url(self, mock_url): |
||||
conf = mock.Mock() |
||||
rpc.CONF = conf |
||||
mock_url.parse.return_value = 'foo' |
||||
|
||||
url = rpc.get_transport_url(url_str='bar') |
||||
|
||||
self.assertEqual('foo', url) |
||||
mock_url.parse.assert_called_once_with(conf, 'bar', |
||||
rpc.TRANSPORT_ALIASES) |
||||
|
||||
@mock.patch.object(messaging, 'TransportURL') |
||||
def test_get_transport_url_null(self, mock_url): |
||||
conf = mock.Mock() |
||||
rpc.CONF = conf |
||||
mock_url.parse.return_value = 'foo' |
||||
|
||||
url = rpc.get_transport_url() |
||||
|
||||
self.assertEqual('foo', url) |
||||
mock_url.parse.assert_called_once_with(conf, None, |
||||
rpc.TRANSPORT_ALIASES) |
||||
|
||||
def test_cleanup_transport_null(self): |
||||
rpc.TRANSPORT = None |
||||
rpc.NOTIFIER = mock.Mock() |
||||
self.assertRaises(AssertionError, rpc.cleanup) |
||||
|
||||
def test_cleanup_notifier_null(self): |
||||
rpc.TRANSPORT = mock.Mock() |
||||
rpc.NOTIFIER = None |
||||
self.assertRaises(AssertionError, rpc.cleanup) |
||||
|
||||
def test_cleanup(self): |
||||
rpc.NOTIFIER = mock.Mock() |
||||
rpc.TRANSPORT = mock.Mock() |
||||
trans_cleanup = mock.Mock() |
||||
rpc.TRANSPORT.cleanup = trans_cleanup |
||||
|
||||
rpc.cleanup() |
||||
|
||||
trans_cleanup.assert_called_once_with() |
||||
self.assertIsNone(rpc.TRANSPORT) |
||||
self.assertIsNone(rpc.NOTIFIER) |
||||
|
||||
def test_add_extra_exmods(self): |
||||
rpc.EXTRA_EXMODS = [] |
||||
|
||||
rpc.add_extra_exmods('foo', 'bar') |
||||
|
||||
self.assertEqual(['foo', 'bar'], rpc.EXTRA_EXMODS) |
||||
|
||||
def test_clear_extra_exmods(self): |
||||
rpc.EXTRA_EXMODS = ['foo', 'bar'] |
||||
|
||||
rpc.clear_extra_exmods() |
||||
|
||||
self.assertEqual(0, len(rpc.EXTRA_EXMODS)) |
||||
|
||||
def test_serialize_entity(self): |
||||
with mock.patch.object(jsonutils, 'to_primitive') as mock_prim: |
||||
rpc.JsonPayloadSerializer.serialize_entity('context', 'entity') |
||||
|
||||
mock_prim.assert_called_once_with('entity', convert_instances=True) |
||||
|
||||
|
||||
class TestRequestContextSerializer(base.TestCase): |
||||
def setUp(self): |
||||
super(TestRequestContextSerializer, self).setUp() |
||||
self.mock_base = mock.Mock() |
||||
self.ser = rpc.RequestContextSerializer(self.mock_base) |
||||
self.ser_null = rpc.RequestContextSerializer(None) |
||||
|
||||
def test_serialize_entity(self): |
||||
self.mock_base.serialize_entity.return_value = 'foo' |
||||
|
||||
ser_ent = self.ser.serialize_entity('context', 'entity') |
||||
|
||||
self.mock_base.serialize_entity.assert_called_once_with('context', |
||||
'entity') |
||||
self.assertEqual('foo', ser_ent) |
||||
|
||||
def test_serialize_entity_null_base(self): |
||||
ser_ent = self.ser_null.serialize_entity('context', 'entity') |
||||
|
||||
self.assertEqual('entity', ser_ent) |
||||
|
||||
def test_deserialize_entity(self): |
||||
self.mock_base.deserialize_entity.return_value = 'foo' |
||||
|
||||
deser_ent = self.ser.deserialize_entity('context', 'entity') |
||||
|
||||
self.mock_base.deserialize_entity.assert_called_once_with('context', |
||||
'entity') |
||||
self.assertEqual('foo', deser_ent) |
||||
|
||||
def test_deserialize_entity_null_base(self): |
||||
deser_ent = self.ser_null.deserialize_entity('context', 'entity') |
||||
|
||||
self.assertEqual('entity', deser_ent) |
||||
|
||||
def test_serialize_context(self): |
||||
context = mock.Mock() |
||||
|
||||
self.ser.serialize_context(context) |
||||
|
||||
context.to_dict.assert_called_once_with() |
||||
|
||||
@mock.patch.object(context, 'RequestContext') |
||||
def test_deserialize_context(self, mock_req): |
||||
self.ser.deserialize_context('context') |
||||
|
||||
mock_req.from_dict.assert_called_once_with('context') |
||||
|
||||
|
||||
class TestProfilerRequestContextSerializer(base.TestCase): |
||||
def setUp(self): |
||||
super(TestProfilerRequestContextSerializer, self).setUp() |
||||
self.ser = rpc.ProfilerRequestContextSerializer(mock.Mock()) |
||||
|
||||
@mock.patch('magnum.common.rpc.profiler') |
||||
def test_serialize_context(self, mock_profiler): |
||||
prof = mock_profiler.get.return_value |
||||
prof.hmac_key = 'swordfish' |
||||
prof.get_base_id.return_value = 'baseid' |
||||
prof.get_id.return_value = 'parentid' |
||||
|
||||
context = mock.Mock() |
||||
context.to_dict.return_value = {'project_id': 'test'} |
||||
|
||||
self.assertEqual({ |
||||
'project_id': 'test', |
||||
'trace_info': { |
||||
'hmac_key': 'swordfish', |
||||
'base_id': 'baseid', |
||||
'parent_id': 'parentid' |
||||
} |
||||
}, self.ser.serialize_context(context)) |
||||
|
||||
@mock.patch('magnum.common.rpc.profiler') |
||||
def test_deserialize_context(self, mock_profiler): |
||||
serialized = {'project_id': 'test', |
||||
'trace_info': { |
||||
'hmac_key': 'swordfish', |
||||
'base_id': 'baseid', |
||||
'parent_id': 'parentid'}} |
||||
|
||||
context = self.ser.deserialize_context(serialized) |
||||
|
||||
self.assertEqual('test', context.project_id) |
||||
mock_profiler.init.assert_called_once_with( |
||||
hmac_key='swordfish', base_id='baseid', parent_id='parentid') |
||||
Loading…
Reference in new issue