doc/developer-guide/plugins/plugin-management/settings-and-statistics.en.rst

.. Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you 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.

.. include:: ../../../common.defs
.. default-domain:: cpp

.. _developer-plugins-management-settings-and-statistics:

Settings and Statistics
***********************

Your plugin might need to know information about Traffic Server's
current configuration and performance. The functions described in this
section read this information from the Traffic Server :file:`records.yaml`
file. Configuration settings are stored in ``CONFIG`` variables and
statistics are stored in ``PROCESS`` variables.

.. caution::

   Not all ``CONFIG`` and ``PROCESS`` variables in :file:`records.yaml` are
   relevant to Traffic Server's configuration and statistics. Therefore,
   retrieve only the :file:`records.yaml` variables that are documented in
   the :ref:`admin-guide`.

To retrieve a variable, you need to know its type (``int``, ``counter``,
``float``, or ``string``). Plugins store the :file:`records.yaml` values
as an ``TSMgmtInt``, ``TSMgmtCounter``, ``TSMgmtFloat``, or
``TSMgmtString``. You can look up :file:`records.yaml` variable types in
the :ref:`admin-guide`.

Depending on the result type, you'll use ``TSMgmtIntGet``,
``TSMgmtCounterGet``, ``TSMgmtFloatGet``, or ``TSMgmtStringGet`` to
obtain the variable value (see the example for
:func:`TSMgmtIntGet`.

The ``TSMgmt*Get`` functions are:

-  :func:`TSMgmtCounterGet`

-  :func:`TSMgmtFloatGet`

-  :func:`TSMgmtIntGet`

-  :func:`TSMgmtStringGet`