pt-fk-error-logger

NAME

pt-fk-error-logger - Log MySQL foreign key errors.

SYNOPSIS

Usage

pt-fk-error-logger [OPTIONS] [DSN]

pt-fk-error-logger logs information about foreign key errors on the given DSN. Information is printed to STDOUT, and it can also be saved to a table by specifying --dest. The tool runs for forever unless --run-time or --iterations is specified.

Print foreign key errors on host1:

pt-fk-error-logger h=host1

Print foreign key errors on host1 once then exit:

pt-fk-error-logger h=host1 --iterations 1

Save foreign key errors on host1 to percona_schema.fke on host2:

pt-fk-error-logger h=host1 --dest h=host2,D=percona_schema,t=fke

RISKS

Percona Toolkit is mature, proven in the real world, and well tested, but all database tools can pose a risk to the system and the database server. Before using this tool, please:

  • Read the tool’s documentation
  • Review the tool’s known “BUGS”
  • Test the tool on a non-production server
  • Backup your production server and verify the backups

DESCRIPTION

pt-fk-error-logger prints or saves the foreign key errors text from SHOW INNODB STATUS. The errors are not parsed or interpreted in any way. Foreign key errors are uniquely identified by their timestamp. Only new (more recent) errors are printed or saved.

By default the tool runs forever, checking every --interval seconds for new foreign key errors. Specify --run-time and/or --iterations to limit how long the tool runs.

OUTPUT

The foreign key error text from SHOW ENGINE INNODB STATUS is printed to STDOUT, unless --quiet is specified. Errors and warnings are printed to STDERR.

OPTIONS

This tool accepts additional command-line arguments. Refer to the “SYNOPSIS” and usage information for details.

--ask-pass

Prompt for a password when connecting to MySQL.

--charset

short form: -A; type: string

Default character set. If the value is utf8, sets Perl’s binmode on STDOUT to utf8, passes the mysql_enable_utf8 option to DBD::mysql, and runs SET NAMES UTF8 after connecting to MySQL. Any other value sets binmode on STDOUT without the utf8 layer, and runs SET NAMES after connecting to MySQL.

--config

type: Array

Read this comma-separated list of config files; if specified, this must be the first option on the command line.

--daemonize

Fork to the background and detach from the shell. POSIX operating systems only.

--database

short form: -D; type: string

Connect to this database.

--defaults-file

short form: -F; type: string

Only read mysql options from the given file. You must give an absolute pathname.

--dest

type: DSN

Save foreign key errors in this table. The DSN must specify a database (D) and table (t).

Missing DSN values are inherited from the DSN being monitored, so you can omit most values if you’re saving foreign key errors on the same host.

The following table is suggested:

CREATE TABLE foreign_key_errors (
  ts datetime NOT NULL,
  error text NOT NULL,
  PRIMARY KEY (ts)
)

The only information saved is the timestamp and the foreign key error text.

--help

Show help and exit.

--host

short form: -h; type: string

Connect to host.

--interval

type: time; default: 30

How often to check for foreign key errors.

--iterations

type: int

How many times to check for foreign key errors. By default, this option is undefined which means an infinite number of iterations. The tool always exits for --run-time, regardless of the value specified for this option. For example, the tool will exit after 1 minute with --run-time 1m --iterations 4 --interval 30 because 4 iterations at 30 second intervals would take 2 minutes, longer than the 1 mintue run-time.

--log

type: string

Print all output to this file when daemonized.

--password

short form: -p; type: string

Password to use when connecting.

--pid

type: string

Create the given PID file. The tool won’t start if the PID file already exists and the PID it contains is different than the current PID. However, if the PID file exists and the PID it contains is no longer running, the tool will overwrite the PID file with the current PID. The PID file is removed automatically when the tool exits.

--port

short form: -P; type: int

Port number to use for connection.

--quiet

Do not print foreign key errors; only print errors and warnings to STDERR.

--run-time

type: time

How long to run before exiting. By default, the tool runs forever.

--set-vars

type: Array

Set the MySQL variables in this comma-separated list of variable=value pairs.

By default, the tool sets:

wait_timeout=10000

Variables specified on the command line override these defaults. For example, specifying --set-vars wait_timeout=500 overrides the defaultvalue of 10000.

The tool prints a warning and continues if a variable cannot be set.

--socket

short form: -S; type: string

Socket file to use for connection.

--user

short form: -u; type: string

User for login if not current user.

--version

Show version and exit.

--[no]version-check

default: yes

Check for the latest version of Percona Toolkit, MySQL, and other programs.

This is a standard “check for updates automatically” feature, with two additional features. First, the tool checks the version of other programs on the local system in addition to its own version. For example, it checks the version of every MySQL server it connects to, Perl, and the Perl module DBD::mysql. Second, it checks for and warns about versions with known problems. For example, MySQL 5.5.25 had a critical bug and was re-released as 5.5.25a.

Any updates or known problems are printed to STDOUT before the tool’s normal output. This feature should never interfere with the normal operation of the tool.

For more information, visit https://www.percona.com/version-check.

DSN OPTIONS

These DSN options are used to create a DSN. Each option is given like option=value. The options are case-sensitive, so P and p are not the same option. There cannot be whitespace before or after the = and if the value contains whitespace it must be quoted. DSN options are comma-separated. See the percona-toolkit manpage for full details.

  • A

dsn: charset; copy: yes

Default character set.

  • D

dsn: database; copy: yes

Default database.

  • F

dsn: mysql_read_default_file; copy: yes

Only read default options from the given file

  • h

dsn: host; copy: yes

Connect to host.

  • p

dsn: password; copy: yes

Password to use when connecting.

  • P

dsn: port; copy: yes

Port number to use for connection.

  • S

dsn: mysql_socket; copy: yes

Socket file to use for connection.

  • t
Table in which to store foreign key errors.
  • u

dsn: user; copy: yes

User for login if not current user.

ENVIRONMENT

The environment variable PTDEBUG enables verbose debugging output to STDERR. To enable debugging and capture all output to a file, run the tool like:

PTDEBUG=1 pt-fk-error-logger ... > FILE 2>&1

Be careful: debugging output is voluminous and can generate several megabytes of output.

SYSTEM REQUIREMENTS

You need Perl, DBI, DBD::mysql, and some core packages that ought to be installed in any reasonably new version of Perl.

BUGS

For a list of known bugs, see http://www.percona.com/bugs/pt-fk-error-logger.

Please report bugs at https://bugs.launchpad.net/percona-toolkit. Include the following information in your bug report:

  • Complete command-line used to run the tool
  • Tool --version
  • MySQL version of all servers involved
  • Output from the tool including STDERR
  • Input files (log/dump/config files, etc.)

If possible, include debugging output by running the tool with PTDEBUG; see “ENVIRONMENT”.

DOWNLOADING

Visit http://www.percona.com/software/percona-toolkit/ to download the latest release of Percona Toolkit. Or, get the latest release from the command line:

wget percona.com/get/percona-toolkit.tar.gz

wget percona.com/get/percona-toolkit.rpm

wget percona.com/get/percona-toolkit.deb

You can also get individual tools from the latest release:

wget percona.com/get/TOOL

Replace TOOL with the name of any tool.

AUTHORS

Daniel Nichter

ABOUT PERCONA TOOLKIT

This tool is part of Percona Toolkit, a collection of advanced command-line tools for MySQL developed by Percona. Percona Toolkit was forked from two projects in June, 2011: Maatkit and Aspersa. Those projects were created by Baron Schwartz and primarily developed by him and Daniel Nichter. Visit http://www.percona.com/software/ to learn about other free, open-source software from Percona.

VERSION

pt-fk-error-logger 2.2.10

Call Us
+1-888-316-9775 (USA - Sales)
+1-208-473-2904 (USA - Sales)
+44-208-133-0309 (UK - Sales)
0-800-051-8984 (UK - Sales)
0-800-181-0665 (GER - Sales)
+1-877-862-4316 (Emergency)
+1-855-55TRAIN (Training)
+1-925-271-5054 (Training)

Table Of Contents

Previous topic

pt-fingerprint

Next topic

pt-heartbeat

This Page



© Copyright 2013, Percona LLC and/or its affiliates.
Except where otherwise noted, this documentation is licensed under the following license:
CC Attribution-ShareAlike 2.0 Generic
Created using Sphinx 1.2.2.
This documentation is developed in Launchpad as part of the Percona Toolkit source code.
If you spotted innacuracies, errors, don't understood it or you think something is missing or should be improved, please file a bug.
]]>
{"cc_re__cc_re__cc_by_sa_2_0": ["are</span></a></li>\n\t\t\t\t\t<li><a href=\"http://www.percona.com/subscribe/\" title=\"Register For Newsletters\" class=\"newsletters\"><span>Register For Newsletters</span></a></li>\n\t\t\t\t</ul>\n\t\t\t</div>\n\n        </div>\n      </div>\n\n      <div class=\"clearer\"></div>\n     \n     \n    \n    \n    <div class=\"license\">\n      &copy; Copyright 2013, Percona LLC and/or its affiliates.\n\n      <br />\n        Except where otherwise noted, this documentation is licensed under the following license:\n      <br />\n      <a class=\"urlextern\" rel=\"license\" href=\"http://creativecommons.org/licenses/by-sa/2.0/\">\n        CC Attribution-ShareAlike 2.0 Generic</a><br />\n      Created using <a href=\"http://sphinx.pocoo.org/\">Sphinx</a> 1.2.2.    \n\n     </div>\n\n    </div>\n\n    \n\n    \n    <div class=\"file-bugs\">\n      \tThis documentation is developed in Launchpad as part of the <a  rel=\"nofollow\" href=\"https://code.launchpad.net/percona-toolkit\">Percona Toolkit source code</a>.<br/>\n\t\tIf you spotted innacuracies, errors, don't understood it or you think something is missing or should be improved, please <a r"], "copyright__copyright__copyright": ["ous topic\n\npt-fingerprint\n\nNext topic\n\npt-heartbeat\n\nThis Page\n\n\n\n\u00a9 Copyright 2013, Percona LLC and/or its affiliates.\nExcept where otherwise noted, this documentation is licensed under the following license:\nCC Attribution-ShareAlike 2.0 Generic\nCreated using Sphinx 1.2.2.\nThis documentation is developed in Launchpad as part of the Percona Toolkit source code.\nIf you spotted innacuracies, errors, don't understood it or you think something is missing or should be improved, please file a bug.\n]]>", "ous topic\n\npt-fingerprint\n\nNext topic\n\npt-heartbeat\n\nThis Page\n\n\n\n\u00a9 Copyright 2013, Percona LLC and/or its affiliates.\nExcept where otherwise noted, this documentation is licensed under the following license:\nCC Attribution-ShareAlike 2.0 Generic\nCreated using Sphinx 1.2.2.\nThis documentation is developed in Launchpad as part of the Percona Toolkit source code.\nIf you spotted innacuracies, errors, don't understood it or you think something is missing or should be improved, please file a bug.\n]]>", "ous topic\n\npt-fingerprint\n\nNext topic\n\npt-heartbeat\n\nThis Page\n\n\n\n\u00a9 Copyright 2013, Percona LLC and/or its affiliates.\nExcept where otherwise noted, this documentation is licensed under the following license:\nCC Attribution-ShareAlike 2.0 Generic\nCreated using Sphinx 1.2.2.\nThis documentation is developed in Launchpad as part of the Percona Toolkit source code.\nIf you spotted innacuracies, errors, don't understood it or you think something is missing or should be improved, please file a bug.\n]]>", "ous topic\n\npt-fingerprint\n\nNext topic\n\npt-heartbeat\n\nThis Page\n\n\n\n\u00a9 Copyright 2013, Percona LLC and/or its affiliates.\nExcept where otherwise noted, this documentation is licensed under the following license:\nCC Attribution-ShareAlike 2.0 Generic\nCreated using Sphinx 1.2.2.\nThis documentation is developed in Launchpad as part of the Percona Toolkit source code.\nIf you spotted innacuracies, errors, don't understood it or you think something is missing or should be improved, please file a bug.\n]]>", "ous topic\n\npt-fingerprint\n\nNext topic\n\npt-heartbeat\n\nThis Page\n\n\n\n\u00a9 Copyright 2013, Percona LLC and/or its affiliates.\nExcept where otherwise noted, this documentation is licensed under the following license:\nCC Attribution-ShareAlike 2.0 Generic\nCreated using Sphinx 1.2.2.\nThis documentation is developed in Launchpad as part of the Percona Toolkit source code.\nIf you spotted innacuracies, errors, don't understood it or you think something is missing or should be improved, please file a bug.\n]]>", "ous topic\n\npt-fingerprint\n\nNext topic\n\npt-heartbeat\n\nThis Page\n\n\n\n\u00a9 Copyright 2013, Percona LLC and/or its affiliates.\nExcept where otherwise noted, this documentation is licensed under the following license:\nCC Attribution-ShareAlike 2.0 Generic\nCreated using Sphinx 1.2.2.\nThis documentation is developed in Launchpad as part of the Percona Toolkit source code.\nIf you spotted innacuracies, errors, don't understood it or you think something is missing or should be improved, please file a bug.\n]]>", "ous topic\n\npt-fingerprint\n\nNext topic\n\npt-heartbeat\n\nThis Page\n\n\n\n\u00a9 Copyright 2013, Percona LLC and/or its affiliates.\nExcept where otherwise noted, this documentation is licensed under the following license:\nCC Attribution-ShareAlike 2.0 Generic\nCreated using Sphinx 1.2.2.\nThis documentation is developed in Launchpad as part of the Percona Toolkit source code.\nIf you spotted innacuracies, errors, don't understood it or you think something is missing or should be improved, please file a bug.\n]]>"]}