MySQL 8.0.29
Source Code Documentation
table_error_log.h
Go to the documentation of this file.
1/* Copyright (c) 2020, 2022, 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 also distributed 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 included with MySQL.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License, version 2.0, for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22
23#ifndef TABLE_ERROR_LOG_H
24#define TABLE_ERROR_LOG_H
25
26/**
27 @file storage/perfschema/table_error_log.h
28 TABLE ERROR_LOG (declarations for table,
29 indices, and keys).
30*/
31
32#include <sys/types.h>
33#include <time.h>
34
35#include "my_inttypes.h"
41
42/**
43 @addtogroup performance_schema_error_log
44 @{
45*/
46
47/*
48 These values have a fixed relationship with
49 (SYSTEM|ERROR|WARNING|INFORMATION)_LEVEL
50 from <my_loglevel.h> and must not be changed
51 except in response to changes in that header.
52*/
58};
59
60/**
61 Key for the LOGGED (timestamp/primary key) column.
62
63 We process these values as ulongongs, so inherit from PFS_key_ulonglong.
64 The keys are stored as TIMESTAMP(6) however, so we use a custom reader
65 that reads that format and returns a ulonglong.
66*/
68 public:
69 explicit PFS_key_error_log_logged(const char *name)
71
72 ~PFS_key_error_log_logged() override = default;
73
74 virtual void read(PFS_key_reader &reader,
75 enum ha_rkey_function find_flag) override {
76 m_find_flag = reader.read_timestamp(find_flag, m_is_null, &m_key_value, 6);
77 }
78
79 bool match(const log_sink_pfs_event *row);
80
81 private:
82 ulonglong m_key_value; // TIMESTAMP(6) (microsecond precision) as ulonglong
83};
84
85/// index on the LOGGED (timestamp/primary key) column
87 public:
89 : PFS_index_error_log(&m_key), m_key("LOGGED") {}
90
91 ~PFS_index_error_log_by_logged() override = default;
92
93 virtual bool match(log_sink_pfs_event *row) override;
94
95 private:
97};
98
99/// key for the THREAD_ID column
101 public:
102 explicit PFS_key_error_log_thread_id(const char *name)
104
106
107 bool match(const log_sink_pfs_event *row);
108};
109
110/// index on the THREAD_ID column
112 public:
114 : PFS_index_error_log(&m_key), m_key("THREAD_ID") {}
115
117
118 virtual bool match(log_sink_pfs_event *row) override;
119
120 private:
122};
123
124/// key for the PRIO column
126 public:
127 explicit PFS_key_error_log_prio(const char *name)
129
130 ~PFS_key_error_log_prio() override = default;
131
132 void read(PFS_key_reader &reader, enum ha_rkey_function find_flag) override;
133
134 bool match(const log_sink_pfs_event *row);
135
136 private:
138};
139
140/// index on the PRIO column
142 public:
144
145 ~PFS_index_error_log_by_prio() override = default;
146
147 virtual bool match(log_sink_pfs_event *row) override;
148
149 private:
151};
152
153/// key for the ERROR_CODE column
155 public:
157 : PFS_index_error_log(&m_key), m_key("ERROR_CODE") {}
158
160
161 virtual bool match(log_sink_pfs_event *row) override;
162
163 private:
165};
166
167/// index on the ERROR_CODE column
169 public:
171 : PFS_index_error_log(&m_key), m_key("SUBSYSTEM") {}
172
173 ~PFS_index_error_log_by_subsys() override = default;
174
175 virtual bool match(log_sink_pfs_event *row) override;
176
177 private:
179};
180
181/** Table PERFORMANCE_SCHEMA.ERROR_LOG. */
183 public:
184 /** Table share */
186 /** Table builder */
188
189 protected:
190 /** Fill in a row's fields from this class's buffer. */
191 virtual int read_row_values(TABLE *table, unsigned char *buf, Field **fields,
192 bool read_all) override;
193
194 protected:
196 /** Create an index for the column with the ordinal idx. */
197 virtual int index_init(uint idx, bool sorted) override;
198
199 public:
200 ~table_error_log() override = default;
201
202 private:
203 /** Copy an event from the ring-buffer into this class's buffer. */
204 virtual int make_row(log_sink_pfs_event *row) override;
205
206 /** Table share lock. */
208 /** Table definition. */
210
211 /** Current row. */
212 log_sink_pfs_event m_header; ///< event-header copied from ring-buffer
213 char m_message[LOG_BUFF_MAX]; ///< message (DATA column) from ring-buffer
214};
215
216/** @} */
217
218#endif
Definition: field.h:573
bool m_is_null
Definition: pfs_engine_table.h:280
enum ha_rkey_function m_find_flag
Definition: pfs_engine_table.h:279
An abstract PERFORMANCE_SCHEMA table.
Definition: pfs_engine_table.h:69
key for the ERROR_CODE column
Definition: table_error_log.h:154
PFS_key_name m_key
Definition: table_error_log.h:164
virtual bool match(log_sink_pfs_event *row) override
Match function for the index on the ERROR_CODE column.
Definition: table_error_log.cc:200
~PFS_index_error_log_by_error_code() override=default
PFS_index_error_log_by_error_code()
Definition: table_error_log.h:156
index on the LOGGED (timestamp/primary key) column
Definition: table_error_log.h:86
~PFS_index_error_log_by_logged() override=default
PFS_index_error_log_by_logged()
Definition: table_error_log.h:88
virtual bool match(log_sink_pfs_event *row) override
Match function for the index on the LOGGED column.
Definition: table_error_log.cc:116
PFS_key_error_log_logged m_key
Definition: table_error_log.h:96
index on the PRIO column
Definition: table_error_log.h:141
PFS_index_error_log_by_prio()
Definition: table_error_log.h:143
virtual bool match(log_sink_pfs_event *row) override
Match function for the index on the PRIO column.
Definition: table_error_log.cc:190
PFS_key_error_log_prio m_key
Definition: table_error_log.h:150
~PFS_index_error_log_by_prio() override=default
index on the ERROR_CODE column
Definition: table_error_log.h:168
virtual bool match(log_sink_pfs_event *row) override
Match function for the index on the SUBSYSTEM column.
Definition: table_error_log.cc:210
PFS_index_error_log_by_subsys()
Definition: table_error_log.h:170
PFS_key_name m_key
Definition: table_error_log.h:178
~PFS_index_error_log_by_subsys() override=default
index on the THREAD_ID column
Definition: table_error_log.h:111
~PFS_index_error_log_by_thread_id() override=default
PFS_key_error_log_thread_id m_key
Definition: table_error_log.h:121
PFS_index_error_log_by_thread_id()
Definition: table_error_log.h:113
virtual bool match(log_sink_pfs_event *row) override
Match function for the index on the THREAD_ID column.
Definition: table_error_log.cc:131
Generic index for error_log table.
Definition: cursor_by_error_log.h:240
Key for the LOGGED (timestamp/primary key) column.
Definition: table_error_log.h:67
ulonglong m_key_value
Definition: table_error_log.h:82
PFS_key_error_log_logged(const char *name)
Definition: table_error_log.h:69
virtual void read(PFS_key_reader &reader, enum ha_rkey_function find_flag) override
Definition: table_error_log.h:74
~PFS_key_error_log_logged() override=default
bool match(const log_sink_pfs_event *row)
Match function / comparator for the key on the LOGGED column.
Definition: table_error_log.cc:110
key for the PRIO column
Definition: table_error_log.h:125
void read(PFS_key_reader &reader, enum ha_rkey_function find_flag) override
Read function for the key on the PRIO column.
Definition: table_error_log.cc:176
enum enum_prio m_prio
Definition: table_error_log.h:137
PFS_key_error_log_prio(const char *name)
Definition: table_error_log.h:127
~PFS_key_error_log_prio() override=default
bool match(const log_sink_pfs_event *row)
Match function / comparator for the key on the PRIO column.
Definition: table_error_log.cc:141
key for the THREAD_ID column
Definition: table_error_log.h:100
bool match(const log_sink_pfs_event *row)
Match function / comparator for the key on the THREAD_ID column.
Definition: table_error_log.cc:126
~PFS_key_error_log_thread_id()=default
PFS_key_error_log_thread_id(const char *name)
Definition: table_error_log.h:102
Definition: table_helper.h:1508
Definition: table_helper.h:1654
Definition: table_helper.h:1228
Class to hold information regarding a table to be created on behalf of a plugin.
Definition: plugin_table.h:39
Cursor CURSOR_BY_ERROR_LOG for error_log table.
Definition: cursor_by_error_log.h:250
Table PERFORMANCE_SCHEMA.ERROR_LOG.
Definition: table_error_log.h:182
static THR_LOCK m_table_lock
Table share lock.
Definition: table_error_log.h:207
static PFS_engine_table_share m_share
Table share.
Definition: table_error_log.h:185
table_error_log()
Definition: table_error_log.cc:107
static Plugin_table m_table_def
Table definition.
Definition: table_error_log.h:209
log_sink_pfs_event m_header
Current row.
Definition: table_error_log.h:212
static PFS_engine_table * create(PFS_engine_table_share *)
Table builder.
Definition: table_error_log.cc:102
virtual int index_init(uint idx, bool sorted) override
Create an index for the column with the ordinal idx.
Definition: table_error_log.cc:227
virtual int make_row(log_sink_pfs_event *row) override
Copy an event from the ring-buffer into this class's buffer.
Definition: table_error_log.cc:266
virtual int read_row_values(TABLE *table, unsigned char *buf, Field **fields, bool read_all) override
Fill in a row's fields from this class's buffer.
Definition: table_error_log.cc:286
char m_message[LOG_BUFF_MAX]
message (DATA column) from ring-buffer
Definition: table_error_log.h:213
~table_error_log() override=default
Cursor CURSOR_BY_ERROR_LOG (declarations); PFS_ringbuffer_index, PFS_index_error_log.
enum ha_rkey_function read_timestamp(enum ha_rkey_function find_flag, bool &isnull, ulonglong *value, uint dec)
Definition: pfs_engine_table.cc:1273
enum_prio
Definition: table_error_log.h:53
@ PS_ERROR_LOG_PRIO_NOTE
Definition: table_error_log.h:57
@ PS_ERROR_LOG_PRIO_WARNING
Definition: table_error_log.h:56
@ PS_ERROR_LOG_PRIO_SYSTEM
Definition: table_error_log.h:54
@ PS_ERROR_LOG_PRIO_ERROR
Definition: table_error_log.h:55
#define LOG_BUFF_MAX
advisory.
Definition: log_shared.h:224
ha_rkey_function
Definition: my_base.h:77
Some integer typedefs for easier portability.
unsigned long long int ulonglong
Definition: my_inttypes.h:55
Definition: buf0block_hint.cc:29
Data types for columns used in the performance schema tables (declarations)
This file contains.
case opt name
Definition: sslopt-case.h:32
A PERFORMANCE_SCHEMA table share.
Definition: pfs_engine_table.h:357
PFS_key_reader: Convert key into internal format.
Definition: pfs_engine_table.h:195
Definition: table.h:1394
Definition: thr_lock.h:138
Definition: log_sink_perfschema.h:58
Helpers to implement a performance schema table.
Include file for Sun RPC to compile out of the box.
unsigned int uint
Definition: uca-dump.cc:29