Normalise more of the API stats calls

We currently have keys like "ComputePostOs-volumes_boot" for providers
using boot-from-volume and other various "os-" keys depending on the
provider.  Normalise all these to regular CamelCase.  A basic
test-case is added.

Additionally add some documentation on the API call stats, pointing
out they reflect internal details so are subject to change.  A release
note is added for the updated stats.

Change-Id: If8398906a5a7ad3d96e985263b0c841e5dcaf7b5
This commit is contained in:
Ian Wienand 2018-09-28 11:07:16 +10:00
parent e12640ecfb
commit f18e2e8c76
4 changed files with 44 additions and 3 deletions

View File

@ -385,3 +385,18 @@ Nodepool launcher
duration of the launch.
See :ref:`nodepool.launch <nodepool_launch>` for a list of possible results.
OpenStack API stats
~~~~~~~~~~~~~~~~~~~
Low level details on the timing of OpenStack API calls will be logged
by the API task manager. These calls are logged under
``nodepool.task.<provider>.<api-call>``. The API call name is of the
generic format ``<endpoint><method><operation>`` transformed into a
CamelCase value with no deliminators; for example the
``compute.GET.servers`` call becomes ``ComputeGetServers`` and
``compute.POST.os-volumes_boot`` becomes ``ComputePostOsVolumesBoot``.
Since these calls reflect the internal operations of the
``openstacksdk``, the exact keys logged may vary across providers and
releases.

View File

@ -18,6 +18,7 @@
import threading
import logging
import re
import queue
import time
@ -27,10 +28,14 @@ from nodepool import stats
def _transform_task_name(task_name):
# openstacksdk sets task.name to something like "compute.DELETE.servers"
# We want ComputeDeleteServers
# Transform openstacksdk internal task name to something more
# suitable for sending to statsd for tracking; e.g.
#
# compute.DELETE.servers -> ComputeDeleteServers
# compute.POST.os-volumes_boot -> ComputePostOsVolumesBoot
parts = re.split('[.\-_]', task_name)
return "".join(
[part.lower().capitalize() for part in task_name.split('.')]
[part.lower().capitalize() for part in parts]
)

View File

@ -20,10 +20,23 @@ import yaml
from nodepool import config as nodepool_config
from nodepool import provider_manager
from nodepool import task_manager
from nodepool import tests
class TestShadeIntegration(tests.IntegrationTestCase):
def test_task_name_transformation(self):
t = task_manager._transform_task_name
self.assertEqual(
t('compute.DELETE.servers'),
'ComputeDeleteServers')
self.assertEqual(
t('compute.POST.os-volumes_boot'),
'ComputePostOsVolumesBoot')
self.assertEqual(
t('compute.GET.os-availability-zone'),
'ComputeGetOsAvailabilityZone')
def _cleanup_cloud_config(self):
os.remove(self.clouds_path)

View File

@ -0,0 +1,8 @@
---
fixes:
- |
Task names are now consistently normalised to CamelCase without
deliminators. Some statistics sent to statsd with ``-`` or ``_``
characters will have changed keys, for example
``ComputePostOs-volumes_boot`` is now
``ComputePostOsVolumesBoot``.