Skip to content

Feature for troubleshooting purpose#4225

Merged
renecannao merged 2 commits intov2.xfrom
v2.x_troubleshooting-feature
May 27, 2023
Merged

Feature for troubleshooting purpose#4225
renecannao merged 2 commits intov2.xfrom
v2.x_troubleshooting-feature

Conversation

@rahim-kanji
Copy link
Collaborator

@rahim-kanji rahim-kanji commented May 19, 2023

Feature for troubleshooting purposes. It allows capturing and storing data packet history for easier debugging and analysis.

The history queue will aid in troubleshooting frontend and backend communication issues by providing a record of the packets exchanged.

By default this feature is disabled. To activate this feature, you need to configure the 'mysql-data_packets_history_size' variable to the desired maximum size for storing data packets. When the number of incoming or outgoing packets exceeds this limit, oldest packets are removed from the queue to make room for the new ones.


Implemented the functionality to generate a coredump upon reaching a specific source file and line number.

To enable coredump feature, specify the filename and line number in the coredump_filters table.

Example:

INSERT INTO coredump_filters (filename,line) VALUES ('mysql_data_stream.cpp', 498);
LOAD COREDUMP TO RUNTIME;

Note:

  • Coredump filters cannot be persisted on disk and will always be empty when a new instance is created.

  • Filenames are case-sensitive

  • 'admin-coredump_generation_threshold', has been introduced to specify the maximum number of core files that can be generated.

  • 'admin-coredump_generation_interval_ms', has been implemented to define the time gap between the generation of core files.

@mirostauder
Copy link
Contributor

retest this please

1 similar comment
@mirostauder
Copy link
Contributor

retest this please

@rahim-kanji rahim-kanji force-pushed the v2.x_troubleshooting-feature branch 2 times, most recently from 14123ff to 9900691 Compare May 25, 2023 07:27
…specific source file and line number.

To enable coredump feature, specify the filename and line number in the coredump_filters table.

Example:
INSERT INTO coredump_filters (filename,line) VALUES ('mysql_data_stream.cpp', 498);
LOAD COREDUMP TO RUNTIME;

Note:
* It is important to note that coredump filters cannot be persisted on disk and will always be empty when a new instance is created.
* Filenames are case-sensitive

* 'admin-coredump_generation_threshold', has been introduced to specify the maximum number of core files that can be generated.
* 'admin-coredump_generation_interval_ms', has been implemented to define the time gap between the generation of core files.
@rahim-kanji rahim-kanji force-pushed the v2.x_troubleshooting-feature branch from 9900691 to c4dae72 Compare May 25, 2023 09:23
@renecannao renecannao marked this pull request as ready for review May 27, 2023 06:49
@renecannao renecannao merged commit 204cb40 into v2.x May 27, 2023
renecannao added a commit that referenced this pull request Dec 19, 2025
Add comprehensive documentation for the on‑demand core dump generation
feature introduced in PR #4225. The documentation covers:

- coredump_filters and runtime_coredump_filters table definitions
- LOAD COREDUMP TO RUNTIME admin command and its aliases
- Configuration variables admin‑coredump_generation_threshold and
  admin‑coredump_generation_interval_ms
- Usage examples with INSERT and LOAD commands
- Important notes about case‑sensitive filenames, runtime‑only behavior,
  rate limiting, and platform support
- Troubleshooting guidance and best practices

The documentation addresses the missing documentation reported in
GitHub issue #5213.
@renecannao renecannao deleted the v2.x_troubleshooting-feature branch March 7, 2026 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants