[DOC] Manual for pt-query-digest --type binlog is ambiguous

[Przemek]

The manual suggests that the pt-query-digest is able to parse a raw binary log file, while it can only parse a file which was decoded with mysqlbinlog tool before.
http://www.percona.com/doc/percona-toolkit/2.2/pt-query-digest.html#cmdoption-pt-query-digest--type

Moreover, the tool does not write any errors when we try to parse raw binlog:

pt-query-digest --type binlog master/data/mysql-bin.000003

# 290ms user time, 10ms system time, 33.70M rss, 228.73M vsz
# Current date: Mon Oct 6 13:17:59 2014
# Hostname: pmlap
# Files: master/data/mysql-bin.000003
# Overall: 0 total, 1 unique, 0 QPS, 0x concurrency ______________________
# Time range: unknown
# Attribute total min max avg 95% stddev median
# ============ ======= ======= ======= ======= ======= ======= =======
# Query size 1.12k 1.12k 1.12k 1.12k 1.12k 0 1.12k

# Profile
# Rank Query ID Response time Calls R/Call V/M Item
# =========== =========== =========== =========== =========== ===== ======

In PTDEBUG=1 we can see:

# Pipeline:11527 28350 Pipeline process BinaryLogParser
\ogParser:9635 28350 �bin�s2T
tx5.6.21-log�s2T8
# BinaryLogParser:9687 28350 Got the query/arg line at pos 109
# BinaryLogParser:9708 28350 It's not a query/arg, it's just some SQL fluff
# BinaryLogParser:9743 28350 Properties of event: $VAR1 = [
# 'pos_in_log',
# 0,
# 'cmd',
# 'Query',
# 'ts',
# undef,
# 'arg',
\s2T
tx5.6.21-log�s2T8
#
#
# 
�
      -/�s2T
v�!
@std!!
                           
testDROP TABLE `test`.`t1` /* generated by server */��n��s2T
~l

!
@std!!
                                                                                                         
testcreate table test.t1 (id int auto_increment primary key)��[��s2T
D�
@std!BEGIN��+t�s2T
-�
F
testt1
*�!^�s2T

(F

��O��s2T

(uF

��
%���s2T
�
�e�v2T
D�
@std!BEGIN�lY?�v2T
-F
testt1
�����v2T

(-F

��95�J�v2T
L)�N��w2T
/{mysql-bin.000004O��U',1

# 'bytes',
# 1147
# ];

No clear errors though.

[Frank Cizmich (frank-cizmich)]

Changed the docs, and now the tool also checks if the file is binary, providing a relevant error message.

[Shahriyar Rzayev (rzayev-sehriyar)]

Percona now uses JIRA for bug reports so this bug report is migrated to: https://jira.percona.com/browse/PT-660