fd874652e3
This utilizes the new metrics support in ironic-lib to allow the agent to report timing metrics for agent API methods as configured in ironic-lib. Additionally, this adds developer docs on how to use metrics in IPA, including some caveats specific to ironic-lib.metrics use in IPA. Co-Authored-By: Jay Faulkner <jay@jvf.cc> Co-Authored-By: Alex Weeks <alex.weeks@gmail.com> Change-Id: Ic08d4ff78b6fb614b474b956a32eac352a14262a Partial-bug: #1526219
56 lines
1.9 KiB
Python
56 lines
1.9 KiB
Python
# Copyright 2014 Rackspace, Inc.
|
|
# 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.
|
|
|
|
from ironic_lib import metrics_utils
|
|
import pecan
|
|
from pecan import rest
|
|
from wsme import types
|
|
from wsmeext import pecan as wsme_pecan
|
|
|
|
from ironic_python_agent.api.controllers.v1 import base
|
|
|
|
|
|
class AgentStatus(base.APIBase):
|
|
"""An object representing an agent instance's status."""
|
|
|
|
started_at = base.MultiType(float)
|
|
version = types.text
|
|
|
|
@classmethod
|
|
def from_agent_status(cls, status):
|
|
"""Convert an object representing agent status to an AgentStatus.
|
|
|
|
:param status: An :class:`ironic_python_agent.agent.
|
|
IronicPythonAgentStatus` object.
|
|
:returns: An :class:`ironic_python_agent.api.controllers.v1.status.
|
|
AgentStatus` object.
|
|
"""
|
|
instance = cls()
|
|
for field in ('started_at', 'version'):
|
|
setattr(instance, field, getattr(status, field))
|
|
return instance
|
|
|
|
|
|
class StatusController(rest.RestController):
|
|
"""Controller for getting agent status."""
|
|
|
|
@wsme_pecan.wsexpose(AgentStatus)
|
|
def get_all(self):
|
|
"""Get current status of the running agent."""
|
|
with metrics_utils.get_metrics_logger(__name__).timer('get_all'):
|
|
agent = pecan.request.agent
|
|
status = agent.get_status()
|
|
return AgentStatus.from_agent_status(status)
|