Skip to content

Document coredump_filters feature and LOAD/SAVE COREDUMP commands #5213

@renecannao

Description

@renecannao

Problem

The coredump generation feature was implemented in PR #4225 but is not documented in the ProxySQL documentation. Users don't know how to use this debugging functionality.

Missing Documentation

The following features need to be documented:

  1. coredump_filters table:
    - How to insert filename/line combinations
    - Case-sensitive filename requirements
    - Runtime-only behavior (not persisted to disk)
  2. Admin commands:
    - LOAD COREDUMP TO RUNTIME
    - other LOAD/SAVE COREDUMP commands
  3. Configuration variables:
    - admin-coredump_generation_threshold - maximum core files limit
    - admin-coredump_generation_interval_ms - time interval between core dumps
  4. Usage examples:
    INSERT INTO coredump_filters (filename,line) VALUES ('mysql_data_stream.cpp', 498);
    LOAD COREDUMP TO RUNTIME;
  5. Important notes:
    - Filters are instance-specific and reset on restart
    - Filenames are case-sensitive
    - Rate limiting prevents excessive core dump generation

Documentation Location

This should be added to:

  • ProxySQL Configuration documentation section
  • Debugging and Troubleshooting guide
  • Admin commands reference

Priority

Medium - Important for users who need advanced debugging capabilities but may not discover the feature through code inspection.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions