MySQL 9.0.0
Source Code Documentation
psi_metric.h
Go to the documentation of this file.
1/* Copyright (c) 2023, 2024, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is designed to work with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have either included with
13 the program or referenced in the documentation.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
23
24#ifndef MYSQL_PSI_METRIC_H
25#define MYSQL_PSI_METRIC_H
26
27/**
28 @file include/mysql/psi/psi_metric.h
29 Performance schema instrumentation interface.
30
31 @defgroup psi_abi_metric Metric Instrumentation (ABI)
32 @ingroup psi_abi
33 @{
34*/
35
36#include "my_inttypes.h"
37#include "my_macros.h"
38
39/* HAVE_PSI_*_INTERFACE */
40#include "my_psi_config.h" // IWYU pragma: keep
41
42#include "my_sharedlib.h"
44
45/** Entry point for the performance schema interface. */
47 /**
48 ABI interface finder.
49 Calling this method with an interface version number returns either
50 an instance of the ABI for this version, or NULL.
51 @sa PSI_METRIC_VERSION_1
52 @sa PSI_CURRENT_METRIC_VERSION
53 */
54 void *(*get_interface)(int version);
55};
56
57#ifdef HAVE_PSI_METRICS_INTERFACE
58
59/**
60 Performance Schema Stage Interface, version 1.
61 @since PSI_STAGE_VERSION_1
62*/
64 /** @sa register_meters_v1_t. */
66 /** @sa unregister_meters_v1_t. */
68 /** @sa register_change_notification_v1_t. */
70 /** @sa unregister_change_notification_v1_t. */
72 /** @sa send_change_notification_v1_t. */
74};
75
77
79
80#endif /* HAVE_PSI_METRICS_INTERFACE */
81
82/** @} (end of group psi_abi_metric) */
83
84#endif /* MYSQL_PSI_METRIC_H */
MYSQL_PLUGIN_IMPORT PSI_metric_service_t * psi_metric_service
Definition: psi_noop.cc:1033
Some integer typedefs for easier portability.
Some common macros.
Defines various enable/disable and HAVE_ macros related to the performance schema instrumentation sys...
Functions related to handling of plugins and other dynamically loaded libraries.
#define MYSQL_PLUGIN_IMPORT
Definition: my_sharedlib.h:71
void(* unregister_meters_v1_t)(PSI_meter_info_v1 *info, size_t count)
Unregister a batch of meters and their telemetry metric sources.
Definition: psi_metric_bits.h:170
void(* register_meters_v1_t)(PSI_meter_info_v1 *info, size_t count)
Register a batch of telemetry meters (metric groups), each with its metrics.
Definition: psi_metric_bits.h:162
void(* unregister_change_notification_v1_t)(meter_registration_changes_v1_t callback)
Unregister a notification callback to track changes in the set of registered meters.
Definition: psi_metric_bits.h:196
void(* register_change_notification_v1_t)(meter_registration_changes_v1_t callback)
Register a notification callback to track changes in the set of registered meters.
Definition: psi_metric_bits.h:187
void(* send_change_notification_v1_t)(const char *meter, MeterNotifyType change)
Send a notification of changes in the set of registered meters.
Definition: psi_metric_bits.h:205
required uint64 version
Definition: replication_group_member_actions.proto:41
Entry point for the performance schema interface.
Definition: psi_metric.h:46
Performance Schema Stage Interface, version 1.
Definition: psi_metric.h:63
unregister_meters_v1_t unregister_meters
Definition: psi_metric.h:67
register_change_notification_v1_t register_change_notification
Definition: psi_metric.h:69
unregister_change_notification_v1_t unregister_change_notification
Definition: psi_metric.h:71
send_change_notification_v1_t send_change_notification
Definition: psi_metric.h:73
register_meters_v1_t register_meters
Definition: psi_metric.h:65