Created gh-pages branch via GitHub

mcos · Apr 12, 2012 · b08cc5e · b08cc5e
commit b08cc5e
Show file tree

Hide file tree

Showing 9 changed files with 657 additions and 0 deletions.
diff --git a/images/bg_hr.png b/images/bg_hr.png
diff --git a/images/blacktocat.png b/images/blacktocat.png
diff --git a/images/icon_download.png b/images/icon_download.png
diff --git a/images/sprite_download.png b/images/sprite_download.png
diff --git a/index.html b/index.html
@@ -0,0 +1,154 @@
+<!DOCTYPE html>
+<html>
+
+  <head>
+    <meta charset='utf-8' />
+    <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+    <meta name="description" content="Redis RDB Tools : Parse Redis dump.rdb files, Analyze Memory, and Export Data" />
+
+    <link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
+
+    <title>Redis RDB Tools</title>
+  </head>
+
+  <body>
+
+    <!-- HEADER -->
+    <div id="header_wrap" class="outer">
+        <header class="inner">
+          <a id="forkme_banner" href="https://github.com/sripathikrishnan/redis-rdb-tools">Fork Me on GitHub</a>
+
+          <h1 id="project_title">Redis RDB Tools</h1>
+          <h2 id="project_tagline">Parse Redis dump.rdb files, Analyze Memory, and Export Data</h2>
+
+          <section id="downloads">
+            <a class="zip_download_link" href="https://github.com/sripathikrishnan/redis-rdb-tools/zipball/master">Download this project as a .zip file</a>
+            <a class="tar_download_link" href="https://github.com/sripathikrishnan/redis-rdb-tools/tarball/master">Download this project as a tar.gz file</a>
+          </section>
+        </header>
+    </div>
+
+    <!-- MAIN CONTENT -->
+    <div id="main_content_wrap" class="outer">
+      <section id="main_content" class="inner">
+        <h1>Tools to inspect Redis's dump.rdb file</h1>
+
+<p>RDB Tools is a set of tools to work with Redis dump files</p>
+
+<p>rdb-tools lets you : </p>
+
+<ol>
+<li> Convert dump files into JSON</li>
+<li> Generate a Memory Report of your data across all databases and keys</li>
+<li> Compare two dump files using standard diff tools</li>
+<li> Efficiently parse and process rdb files</li>
+</ol><p>RDB Tools is implemented in Python. </p>
+
+<h2>Installing rdbtools</h2>
+
+<pre><code>git checkout git@github.com:sripathikrishnan/redis-rdb-tools.git
+cd redis-rdb-tools
+sudo python setup.py install
+</code></pre>
+
+<h2>Converting dump files to JSON</h2>
+
+<p>Parse the dump file and print the JSON on standard output</p>
+
+<pre><code>./rdb --command json /var/redis/6379/dump.rdb
+</code></pre>
+
+<p>Only process keys that match the regex</p>
+
+<pre><code>./rdb --command json --key "user.*" /var/redis/6379/dump.rdb
+</code></pre>
+
+<p>Only process hashes starting with "a", in database 2 </p>
+
+<pre><code>./rdb --command json --db 2 --type hash --key "a.*" /var/redis/6379/dump.rdb
+</code></pre>
+
+<h2>Generate Memory Report</h2>
+
+<p>Running with the  <code>-c memory</code> generates a CSV report with the approximate memory used by that key.</p>
+
+<pre><code>./rdb -c memory /var/redis/6379/dump.rdb &gt; memory.csv
+</code></pre>
+
+<p>The generated CSV has the following columns - Database Number, Data Type, Key, Memory Used in bytes and Encoding. 
+Memory usage includes the key, the value and any other overheads.</p>
+
+<p>Note that the memory usage is approximate. In general, the actual memory used will be slightly higher than what is reported.</p>
+
+<p>You can filter the report on keys or database number or data type.</p>
+
+<h2>Comparing RDB files</h2>
+
+<p>First, use the --command diff option, and pipe the output to standard sort utility</p>
+
+<pre><code>./rdb --command diff /var/redis/6379/dump1.rdb | sort &gt; dump1.txt
+./rdb --command diff /var/redis/6379/dump2.rdb | sort &gt; dump2.txt
+</code></pre>
+
+<p>Then, run your favourite diff program</p>
+
+<pre><code>kdiff3 dump1.txt dump2.txt
+</code></pre>
+
+<p>To limit the size of the files, you can filter on keys using the --key=regex option</p>
+
+<h2>Using the Parser</h2>
+
+<pre><code>import sys
+from rdbtools import RdbParser, RdbCallback
+
+class MyCallback(RdbCallback) :
+    ''' Simple example to show how callback works. 
+        See RdbCallback for all available callback methods.
+        See JsonCallback for a concrete example
+    ''' 
+    def set(self, key, value, expiry):
+        print('%s = %s' % (str(key), str(value)))
+
+    def hset(self, key, field, value):
+        print('%s.%s = %s' % (str(key), str(field), str(value)))
+
+    def sadd(self, key, member):
+        print('%s has {%s}' % (str(key), str(member)))
+
+    def rpush(self, key, value) :
+        print('%s has [%s]' % (str(key), str(value)))
+
+    def zadd(self, key, score, member):
+        print('%s has {%s : %s}' % (str(key), str(member), str(score)))
+
+callback = MyCallback()
+parser = RdbParser(callback)
+parser.parse('/var/redis/6379/dump.rdb')
+</code></pre>
+
+<h2>What can I do with this parser?</h2>
+
+<p>Several things </p>
+
+<ol>
+<li> Export redis into a relational database like MySQL</li>
+<li> Export redis into a full text search engine like lucene/solr, so that you can do (almost) real time searches</li>
+<li> Merge or split dump files. This is useful if you using several instances of Redis and shard your data</li>
+<li> Build a UI/Explorer for the data in Redis</li>
+</ol>
+      </section>
+    </div>
+
+    <!-- FOOTER  -->
+    <div id="footer_wrap" class="outer">
+      <footer class="inner">
+        <p class="copyright">Redis RDB Tools maintained by <a href="https://github.com/sripathikrishnan">sripathikrishnan</a></p>
+        <p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
+      </footer>
+    </div>
+
+
+
+  </body>
+</html>
diff --git a/javascripts/main.js b/javascripts/main.js
@@ -0,0 +1 @@
+console.log('This would be the main JS file.');
diff --git a/params.json b/params.json
@@ -0,0 +1 @@
+{"name":"Redis RDB Tools","body":"# Tools to inspect Redis's dump.rdb file #\r\n\r\nRDB Tools is a set of tools to work with Redis dump files\r\n\r\nrdb-tools lets you : \r\n \r\n 1.  Convert dump files into JSON\r\n 2.  Generate a Memory Report of your data across all databases and keys\r\n 3.  Compare two dump files using standard diff tools\r\n 4.  Efficiently parse and process rdb files\r\n\r\nRDB Tools is implemented in Python. \r\n\r\n## Installing rdbtools ##\r\n\r\n    git checkout git@github.com:sripathikrishnan/redis-rdb-tools.git\r\n    cd redis-rdb-tools\r\n    sudo python setup.py install\r\n\r\n## Converting dump files to JSON ##\r\n\r\nParse the dump file and print the JSON on standard output\r\n\r\n    ./rdb --command json /var/redis/6379/dump.rdb\r\n    \r\nOnly process keys that match the regex\r\n\r\n    ./rdb --command json --key \"user.*\" /var/redis/6379/dump.rdb\r\n    \r\nOnly process hashes starting with \"a\", in database 2 \r\n\r\n    ./rdb --command json --db 2 --type hash --key \"a.*\" /var/redis/6379/dump.rdb\r\n\r\n\r\n## Generate Memory Report ##\r\nRunning with the  `-c memory` generates a CSV report with the approximate memory used by that key.\r\n\r\n    ./rdb -c memory /var/redis/6379/dump.rdb > memory.csv\r\n\r\n\r\nThe generated CSV has the following columns - Database Number, Data Type, Key, Memory Used in bytes and Encoding. \r\nMemory usage includes the key, the value and any other overheads.\r\n\r\nNote that the memory usage is approximate. In general, the actual memory used will be slightly higher than what is reported.\r\n\r\nYou can filter the report on keys or database number or data type.\r\n\r\n## Comparing RDB files ##\r\n\r\nFirst, use the --command diff option, and pipe the output to standard sort utility\r\n\r\n    ./rdb --command diff /var/redis/6379/dump1.rdb | sort > dump1.txt\r\n    ./rdb --command diff /var/redis/6379/dump2.rdb | sort > dump2.txt\r\n    \r\nThen, run your favourite diff program\r\n\r\n    kdiff3 dump1.txt dump2.txt\r\n\r\nTo limit the size of the files, you can filter on keys using the --key=regex option\r\n\r\n## Using the Parser ##\r\n\r\n    import sys\r\n    from rdbtools import RdbParser, RdbCallback\r\n\r\n    class MyCallback(RdbCallback) :\r\n        ''' Simple example to show how callback works. \r\n            See RdbCallback for all available callback methods.\r\n            See JsonCallback for a concrete example\r\n        ''' \r\n        def set(self, key, value, expiry):\r\n            print('%s = %s' % (str(key), str(value)))\r\n        \r\n        def hset(self, key, field, value):\r\n            print('%s.%s = %s' % (str(key), str(field), str(value)))\r\n        \r\n        def sadd(self, key, member):\r\n            print('%s has {%s}' % (str(key), str(member)))\r\n        \r\n        def rpush(self, key, value) :\r\n            print('%s has [%s]' % (str(key), str(value)))\r\n        \r\n        def zadd(self, key, score, member):\r\n            print('%s has {%s : %s}' % (str(key), str(member), str(score)))\r\n\r\n    callback = MyCallback()\r\n    parser = RdbParser(callback)\r\n    parser.parse('/var/redis/6379/dump.rdb')\r\n\r\n## What can I do with this parser?\r\nSeveral things \r\n\r\n 1.  Export redis into a relational database like MySQL\r\n 2.  Export redis into a full text search engine like lucene/solr, so that you can do (almost) real time searches\r\n 3.  Merge or split dump files. This is useful if you using several instances of Redis and shard your data\r\n 4.  Build a UI/Explorer for the data in Redis\r\n\r\n","tagline":"Parse Redis dump.rdb files, Analyze Memory, and Export Data","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
diff --git a/stylesheets/pygment_trac.css b/stylesheets/pygment_trac.css
@@ -0,0 +1,70 @@
+.highlight .hll { background-color: #ffffcc }
+.highlight  { background: #f0f3f3; }
+.highlight .c { color: #0099FF; font-style: italic } /* Comment */
+.highlight .err { color: #AA0000; background-color: #FFAAAA } /* Error */
+.highlight .k { color: #006699; font-weight: bold } /* Keyword */
+.highlight .o { color: #555555 } /* Operator */
+.highlight .cm { color: #0099FF; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #009999 } /* Comment.Preproc */
+.highlight .c1 { color: #0099FF; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #0099FF; font-weight: bold; font-style: italic } /* Comment.Special */
+.highlight .gd { background-color: #FFCCCC; border: 1px solid #CC0000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #FF0000 } /* Generic.Error */
+.highlight .gh { color: #003300; font-weight: bold } /* Generic.Heading */
+.highlight .gi { background-color: #CCFFCC; border: 1px solid #00CC00 } /* Generic.Inserted */
+.highlight .go { color: #AAAAAA } /* Generic.Output */
+.highlight .gp { color: #000099; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #003300; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #99CC66 } /* Generic.Traceback */
+.highlight .kc { color: #006699; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #006699; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #006699; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #006699 } /* Keyword.Pseudo */
+.highlight .kr { color: #006699; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #007788; font-weight: bold } /* Keyword.Type */
+.highlight .m { color: #FF6600 } /* Literal.Number */
+.highlight .s { color: #CC3300 } /* Literal.String */
+.highlight .na { color: #330099 } /* Name.Attribute */
+.highlight .nb { color: #336666 } /* Name.Builtin */
+.highlight .nc { color: #00AA88; font-weight: bold } /* Name.Class */
+.highlight .no { color: #336600 } /* Name.Constant */
+.highlight .nd { color: #9999FF } /* Name.Decorator */
+.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #CC0000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #CC00FF } /* Name.Function */
+.highlight .nl { color: #9999FF } /* Name.Label */
+.highlight .nn { color: #00CCFF; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #330099; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #003333 } /* Name.Variable */
+.highlight .ow { color: #000000; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #FF6600 } /* Literal.Number.Float */
+.highlight .mh { color: #FF6600 } /* Literal.Number.Hex */
+.highlight .mi { color: #FF6600 } /* Literal.Number.Integer */
+.highlight .mo { color: #FF6600 } /* Literal.Number.Oct */
+.highlight .sb { color: #CC3300 } /* Literal.String.Backtick */
+.highlight .sc { color: #CC3300 } /* Literal.String.Char */
+.highlight .sd { color: #CC3300; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #CC3300 } /* Literal.String.Double */
+.highlight .se { color: #CC3300; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #CC3300 } /* Literal.String.Heredoc */
+.highlight .si { color: #AA0000 } /* Literal.String.Interpol */
+.highlight .sx { color: #CC3300 } /* Literal.String.Other */
+.highlight .sr { color: #33AAAA } /* Literal.String.Regex */
+.highlight .s1 { color: #CC3300 } /* Literal.String.Single */
+.highlight .ss { color: #FFCC33 } /* Literal.String.Symbol */
+.highlight .bp { color: #336666 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #003333 } /* Name.Variable.Class */
+.highlight .vg { color: #003333 } /* Name.Variable.Global */
+.highlight .vi { color: #003333 } /* Name.Variable.Instance */
+.highlight .il { color: #FF6600 } /* Literal.Number.Integer.Long */
+
+.type-csharp .highlight .k { color: #0000FF }
+.type-csharp .highlight .kt { color: #0000FF }
+.type-csharp .highlight .nf { color: #000000; font-weight: normal }
+.type-csharp .highlight .nc { color: #2B91AF }
+.type-csharp .highlight .nn { color: #000000 }
+.type-csharp .highlight .s { color: #A31515 }
+.type-csharp .highlight .sc { color: #A31515 }