9a43f58f4d
* 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.
Neutron client change: Ic11796889075b2a0e589b70398fc4d4ed6f3ef7c
Co-authored-by: Ryan Moats <rmoats@us.ibm.com>
Depends-On: I5102eb46a7a377eca31375a0d64951ba1fdd035d
Closes-Bug: #1335640
DocImpact Add devref and operator documentation on how to use this
APIImpact
Change-Id: I7fa2ad57dc5763ce72cba6945ebcadef2188e8bd
49 lines
2.0 KiB
Python
49 lines
2.0 KiB
Python
# 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_config import cfg
|
|
from oslo_log import log as logging
|
|
import oslo_messaging
|
|
import osprofiler.notifier
|
|
from osprofiler import opts as profiler_opts
|
|
import osprofiler.web
|
|
|
|
from neutron._i18n import _LI
|
|
|
|
CONF = cfg.CONF
|
|
profiler_opts.set_defaults(CONF)
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def setup(name, host='0.0.0.0'): # nosec
|
|
"""Setup OSprofiler notifier and enable profiling.
|
|
|
|
:param name: name of the service, that will be profiled
|
|
:param host: host (either host name or host address) the service will be
|
|
running on. By default host will be set to 0.0.0.0, but more
|
|
specified host name / address usage is highly recommended.
|
|
"""
|
|
if CONF.profiler.enabled:
|
|
_notifier = osprofiler.notifier.create(
|
|
"Messaging", oslo_messaging, {},
|
|
oslo_messaging.get_transport(CONF), "neutron", name, host)
|
|
osprofiler.notifier.set(_notifier)
|
|
osprofiler.web.enable(CONF.profiler.hmac_keys)
|
|
LOG.info(_LI("OSProfiler is enabled.\n"
|
|
"Traces provided from the profiler "
|
|
"can only be subscribed to using the same HMAC keys that "
|
|
"are configured in Neutron's configuration file "
|
|
"under the [profiler] section.\n To disable OSprofiler "
|
|
"set in /etc/neutron/neutron.conf:\n"
|
|
"[profiler]\n"
|
|
"enabled=false"))
|