![]()  | 
  
    MySQL 8.4.7
    
   Source Code Documentation 
   | 
 
#include <cstddef>#include <cstdint>#include <mysql/components/service.h>#include <mysql/components/services/mysql_string.h>#include "psi_metric_bits.h"Go to the source code of this file.
Typedefs | |
| typedef struct telemetry_meters_iterator_imp * | telemetry_meters_iterator | 
| typedef struct telemetry_metrics_iterator_imp * | telemetry_metrics_iterator | 
| typedef bool(* | metrics_iterator_create_t) (const char *meter, telemetry_metrics_iterator *iterator) | 
| Initialize Telemetry Metric iterator object to enumerate metrics and read measurement values, pointing to 1st matching metric.  More... | |
| typedef bool(* | metrics_iterator_destroy_t) (telemetry_metrics_iterator iterator) | 
| Uninitialize Telemetry Metric iterator.  More... | |
| typedef bool(* | metrics_iterator_advance_t) (telemetry_metrics_iterator iterator) | 
| Advance Telemetry Metric iterator to next element.  More... | |
| typedef bool(* | metrics_iterator_get_group_t) (telemetry_metrics_iterator iterator, my_h_string *out_group_handle) | 
| Return group name for the element pointed by Telemetry Metric iterator.  More... | |
| typedef bool(* | metrics_iterator_get_name_t) (telemetry_metrics_iterator iterator, my_h_string *out_name_handle) | 
| Return metric name for the element pointed by Telemetry Metric iterator.  More... | |
| typedef bool(* | metrics_iterator_get_value_t) (telemetry_metrics_iterator iterator, measurement_delivery_callback_t delivery, void *delivery_context) | 
| Return metric name for the element pointed by Telemetry Metric iterator.  More... | |
| typedef bool(* | metrics_iterator_get_description_t) (telemetry_metrics_iterator iterator, my_h_string *out_desc_handle) | 
| Return metric description for the element pointed by Telemetry Metric iterator.  More... | |
| typedef bool(* | metrics_iterator_get_unit_t) (telemetry_metrics_iterator iterator, my_h_string *out_unit_handle) | 
| Return metric unit for the element pointed by Telemetry Metric iterator.  More... | |
| typedef bool(* | metrics_iterator_get_numeric_type_t) (telemetry_metrics_iterator iterator, MetricNumType &numeric) | 
| Return metric numeric type for the element pointed by Telemetry Metric iterator.  More... | |
| typedef bool(* | metrics_iterator_get_metric_type_t) (telemetry_metrics_iterator iterator, MetricOTELType &metric_type) | 
| Return metric OTEL type for the element pointed by Telemetry Metric iterator.  More... | |
| typedef bool(* | metrics_iterator_get_callback_t) (telemetry_metrics_iterator iterator, measurement_callback_t &callback, void *&measurement_context) | 
| Return metric measurement callback function for the element pointed by Telemetry Metric iterator.  More... | |
| typedef bool(* | meters_iterator_create_t) (telemetry_meters_iterator *iterator) | 
| Initialize Telemetry Meter (Metric Group) iterator object to enumerate metrics groups, pointing to 1st matching metric.  More... | |
| typedef bool(* | meters_iterator_destroy_t) (telemetry_meters_iterator iterator) | 
| Uninitialize Telemetry Meter (Metric Group) iterator.  More... | |
| typedef bool(* | meters_iterator_advance_t) (telemetry_meters_iterator iterator) | 
| Advance Telemetry Meter (Metric Group) iterator to next element.  More... | |
| typedef bool(* | meters_iterator_get_name_t) (telemetry_meters_iterator iterator, my_h_string *out_name_handle) | 
| Return meter name for the element pointed by Telemetry Meter (Metric Group) iterator.  More... | |
| typedef bool(* | meters_iterator_get_frequency_t) (telemetry_meters_iterator iterator, unsigned int &value) | 
| Return meter update frequency for the element pointed by Telemetry Meter iterator.  More... | |
| typedef bool(* | meters_iterator_get_enabled_t) (telemetry_meters_iterator iterator, bool &enabled) | 
| Return meter enabled status for the element pointed by Telemetry Meter iterator.  More... | |
| typedef bool(* | meters_iterator_get_description_t) (telemetry_meters_iterator iterator, my_h_string *out_desc_handle) | 
| Return meter description for the element pointed by Telemetry Meter iterator.  More... | |
| typedef bool(* | measurement_reading_start_t) () | 
| Take the lock(s) needed to read system variables.  More... | |
| typedef bool(* | measurement_reading_end_t) () | 
| Release the lock(s) needed to read system variables.  More... | |
| typedef bool(* measurement_reading_end_t) () | 
Release the lock(s) needed to read system variables.
For performance reasons, lock is taken once per metric export instead of once per each variable read.
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* measurement_reading_start_t) () | 
Take the lock(s) needed to read system variables.
For performance reasons, lock is taken once per metric export instead of once per each variable read.
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* meters_iterator_advance_t) (telemetry_meters_iterator iterator) | 
Advance Telemetry Meter (Metric Group) iterator to next element.
| iterator | iterator object | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* meters_iterator_create_t) (telemetry_meters_iterator *iterator) | 
Initialize Telemetry Meter (Metric Group) iterator object to enumerate metrics groups, pointing to 1st matching metric.
| [out] | iterator | iterator object | 
| false | Success | 
| true | Failure | 
| typedef bool(* meters_iterator_destroy_t) (telemetry_meters_iterator iterator) | 
Uninitialize Telemetry Meter (Metric Group) iterator.
| iterator | iterator object | 
| false | Success | 
| true | Failure | 
| typedef bool(* meters_iterator_get_description_t) (telemetry_meters_iterator iterator, my_h_string *out_desc_handle) | 
Return meter description for the element pointed by Telemetry Meter iterator.
| iterator | iterator object | |
| [out] | out_desc_handle | pointer to receive string value | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* meters_iterator_get_enabled_t) (telemetry_meters_iterator iterator, bool &enabled) | 
Return meter enabled status for the element pointed by Telemetry Meter iterator.
| iterator | iterator object | |
| [out] | enabled | reference to enabled result | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* meters_iterator_get_frequency_t) (telemetry_meters_iterator iterator, unsigned int &value) | 
Return meter update frequency for the element pointed by Telemetry Meter iterator.
| iterator | iterator object | |
| [out] | value | reference to result variable | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* meters_iterator_get_name_t) (telemetry_meters_iterator iterator, my_h_string *out_name_handle) | 
Return meter name for the element pointed by Telemetry Meter (Metric Group) iterator.
| iterator | iterator object | |
| [out] | out_name_handle | pointer to receive string value | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* metrics_iterator_advance_t) (telemetry_metrics_iterator iterator) | 
Advance Telemetry Metric iterator to next element.
| iterator | iterator object | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* metrics_iterator_create_t) (const char *meter, telemetry_metrics_iterator *iterator) | 
Initialize Telemetry Metric iterator object to enumerate metrics and read measurement values, pointing to 1st matching metric.
| meter | define meter (metric group) scope | |
| [out] | iterator | iterator object | 
| false | Success | 
| true | Failure | 
| typedef bool(* metrics_iterator_destroy_t) (telemetry_metrics_iterator iterator) | 
Uninitialize Telemetry Metric iterator.
| iterator | iterator object | 
| false | Success | 
| true | Failure | 
| typedef bool(* metrics_iterator_get_callback_t) (telemetry_metrics_iterator iterator, measurement_callback_t &callback, void *&measurement_context) | 
Return metric measurement callback function for the element pointed by Telemetry Metric iterator.
| iterator | iterator object | |
| [out] | callback | reference to metric callback | 
| [out] | measurement_context | reference to metric context pointer | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* metrics_iterator_get_description_t) (telemetry_metrics_iterator iterator, my_h_string *out_desc_handle) | 
Return metric description for the element pointed by Telemetry Metric iterator.
| iterator | iterator object | |
| [out] | out_desc_handle | pointer to receive string value | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* metrics_iterator_get_group_t) (telemetry_metrics_iterator iterator, my_h_string *out_group_handle) | 
Return group name for the element pointed by Telemetry Metric iterator.
| iterator | iterator object | |
| [out] | out_group_handle | pointer to receive string value | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* metrics_iterator_get_metric_type_t) (telemetry_metrics_iterator iterator, MetricOTELType &metric_type) | 
Return metric OTEL type for the element pointed by Telemetry Metric iterator.
| iterator | iterator object | |
| [out] | metric_type | reference to metric type output | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* metrics_iterator_get_name_t) (telemetry_metrics_iterator iterator, my_h_string *out_name_handle) | 
Return metric name for the element pointed by Telemetry Metric iterator.
| iterator | iterator object | |
| [out] | out_name_handle | pointer to receive string value | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* metrics_iterator_get_numeric_type_t) (telemetry_metrics_iterator iterator, MetricNumType &numeric) | 
Return metric numeric type for the element pointed by Telemetry Metric iterator.
| iterator | iterator object | |
| [out] | numeric | reference to numeric type output | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* metrics_iterator_get_unit_t) (telemetry_metrics_iterator iterator, my_h_string *out_unit_handle) | 
Return metric unit for the element pointed by Telemetry Metric iterator.
| iterator | iterator object | |
| [out] | out_unit_handle | pointer to receive string value | 
| false | Success | 
| true | Failure or no more elements | 
| typedef bool(* metrics_iterator_get_value_t) (telemetry_metrics_iterator iterator, measurement_delivery_callback_t delivery, void *delivery_context) | 
Return metric name for the element pointed by Telemetry Metric iterator.
| iterator | iterator object | 
| delivery | callback to deliver measurements | 
| delivery_context | context pointer, passed back to callback | 
| false | Success | 
| true | Failure or no more elements | 
| typedef struct telemetry_meters_iterator_imp* telemetry_meters_iterator | 
| typedef struct telemetry_metrics_iterator_imp* telemetry_metrics_iterator |