percona/percona-toolkit
1
0
Fork 0
mirror of https://github.com/percona/percona-toolkit.git synced 2025-09-23 12:47:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge ~percona-toolkit-dev/percona-toolkit/pt-stalk-2.0-docs r159.

Browse Source
This commit is contained in:
Daniel Nichter
2012-01-31 10:14:30 -07:00
parent afd0bf8982 37df5da4d6
commit 9bf345f88a
1 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
bin/pt-stalk
View File

@@ -1257,7 +1257,8 @@ whether known or unknown, of using this tool. The two main categories of risks
are those created by the nature of the tool (e.g. read-only tools vs. read-write are those created by the nature of the tool (e.g. read-only tools vs. read-write
tools) and those created by bugs. tools) and those created by bugs.
pt-stalk is a read-only tool. It should be very low-risk. Some of the options pt-stalk is a read-write tool; it collects data from the system and writes it
into a series of files. It should be very low-risk. Some of the options
can cause intrusive data collection to be performed, however, so if you enable can cause intrusive data collection to be performed, however, so if you enable
any non-default options, you should read their documentation carefully. any non-default options, you should read their documentation carefully.
@@ -1326,7 +1327,10 @@ resulting samples of data.
Although this sounds simple enough, in practice there are a number of Although this sounds simple enough, in practice there are a number of
subtleties, such as detecting when the disk is beginning to fill up so that the subtleties, such as detecting when the disk is beginning to fill up so that the
tool doesn't cause the server to run out of disk space. tool doesn't cause the server to run out of disk space. This tool handles these
types of potential problems, so it's a good idea to use this tool instead of
writing something from scratch and possibly experiencing some of the hazards
this tool is designed to prevent.
=head1 CONFIGURING =head1 CONFIGURING
@@ -1402,8 +1406,8 @@ first option on the command line.
type: int; default: 5 type: int; default: 5
The number of times the trigger condition must be true before collecting data. The number of times the trigger condition must be true before collecting data.
This helps prevent false positives and make the trigger condition less This helps prevent false positives, and makes the trigger condition less likely
susceptible to firing when the condition recovers quickly. to fire when the problem recovers quickly.
=item --daemonize =item --daemonize
@@ -1473,7 +1477,8 @@ L<"--variable"> column matches the L<"--match"> option. For example, to trigger
when more than 10 processes are in the "statistics" state, use the following when more than 10 processes are in the "statistics" state, use the following
options: options:
--trigger processlist --variable State --match statistics --threshold 10 --trigger processlist --variable State \
--match statistics --threshold 10
=back =back
@@ -1489,7 +1494,8 @@ simply sources the file and executes the function. For example, the function
might look like the following: might look like the following:
trg_plugin() { trg_plugin() {
mysql $EXT_ARGV -e "SHOW ENGINE INNODB STATUS" | grep -c "has waited at" mysql $EXT_ARGV -e "SHOW ENGINE INNODB STATUS" \
| grep -c "has waited at"
} }
This snippet will count the number of mutex waits inside of InnoDB. It This snippet will count the number of mutex waits inside of InnoDB. It
@@ -1597,7 +1603,7 @@ Print tool's version and exit.
=head1 ENVIRONMENT =head1 ENVIRONMENT
No env vars used. This tool does not use any environment variables for configuration.
=head1 SYSTEM REQUIREMENTS =head1 SYSTEM REQUIREMENTS