├── .gitignore ├── LICENSE ├── README.md ├── config_chekcer.py ├── create_virtaulenv.sh ├── key_analysis.py ├── requirements.txt └── show_redis_clients.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # redis-tools 2 | redis tools 3 | 4 | ## Usage 5 | ### key_analysis.py 6 | ```python key_analysis.py --host 127.0.0.1 --port``` 7 | 8 | ### config_checker.py 9 | ```python redis-checker.py --host 127.0.0.1 --port``` 10 | -------------------------------------------------------------------------------- /config_chekcer.py: -------------------------------------------------------------------------------- 1 | import redis 2 | import sys 3 | import argparse 4 | import time 5 | 6 | 7 | class Checker(object): 8 | def __init__(self): 9 | self.funcs = [] 10 | 11 | def register(self, **options): 12 | def decorator(f): 13 | name = options.pop("name", f.__name__) 14 | self.add_checker(name, f, **options) 15 | return f 16 | return decorator 17 | 18 | def add_checker(self, name, f, **options): 19 | self.funcs.append((f, options)) 20 | 21 | def call(self, r, info, reportFunc): 22 | for func in self.funcs: 23 | t = func 24 | f = t[0] 25 | if "title" in t[1]: 26 | title = t[1]["title"] 27 | else: 28 | title = f.__name__ 29 | 30 | reasons = f(r, info) 31 | if len(reasons) > 0: 32 | reportFunc(title, reasons) 33 | 34 | 35 | checker = Checker() 36 | 37 | KEYS_GAP = 0 38 | CONN_GAP = 100 39 | MAXCLIENTS = 10000 40 | 41 | INFO = 0 42 | CHECK = 1 43 | WARNING = 2 44 | DANGER = 3 45 | 46 | LEVELS = [ 47 | "INFO", 48 | "CHECK", 49 | "WARNING", 50 | "DANGER" 51 | ] 52 | 53 | def toStr(i): 54 | return LEVELS[i] 55 | 56 | def fail(msg): 57 | print >> sys.stderr, msg 58 | exit(1) 59 | 60 | def redisHost(r): 61 | return r.connection_pool.connection_kwargs['host'] 62 | 63 | def redisPort(r): 64 | return r.connection_pool.connection_kwargs['port'] 65 | 66 | def redisPassword(r): 67 | return r.connection_pool.connection_kwargs['password'] 68 | 69 | def compareVersion(va, vb): 70 | for vaPart,vbPart in zip([int(x) for x in va.split('.')], [int(x) for x in vb.split('.')]): 71 | if vaPart > vbPart: 72 | return 1 73 | elif vaPart < vbPart: 74 | return -1 75 | return 0 76 | 77 | def valOrNA(x): 78 | return x if x != None else 'N/A' 79 | 80 | def bytesToStr(bytes): 81 | if bytes < 1024: 82 | return '%dB'%bytes 83 | if bytes < 1024*1024: 84 | return '%dKB'%(bytes/1024) 85 | if bytes < 1024*1024*1024: 86 | return '%dMB'%(bytes/(1024*1024)) 87 | return '%dGB'%(bytes/(1024*1024*1024)) 88 | 89 | def fragmentation_str(v): 90 | if v <= 1.2: 91 | return "Normal" 92 | if v >= 1.3 and v <= 1.5: 93 | return "Caution" 94 | if v >= 1.5: 95 | return "Bad" 96 | 97 | return "" 98 | 99 | 100 | def getRedisConn(host, port): 101 | r = redis.Redis(host=host, port=port) 102 | try: 103 | ver = r.info()['redis_version'] 104 | r.ver = ver 105 | except redis.ConnectionError as e: 106 | fail('Failed connecting (%s) to %s, aborting'%(e,url)) 107 | 108 | return r 109 | 110 | @checker.register(title="Memory Status") 111 | def checkMemory(r, info): 112 | mem = bytesToStr(int(info['used_memory'])) 113 | rss = bytesToStr(int(info['used_memory_rss'])) 114 | maxmemory = bytesToStr(int(info['maxmemory'])) 115 | ratio = info['mem_fragmentation_ratio'] 116 | if compareVersion(r.ver, "3.2") in [0, 1]: 117 | total = bytesToStr(int(info['total_system_memory'])) 118 | used = round(int(info['used_memory'])/int(info['total_system_memory']) * 100, 2) 119 | else: 120 | total = "N/A" 121 | used = "unknown" 122 | 123 | reasons = [] 124 | reasons.append((INFO, "Total Memory in Instance: %s"%(total))) 125 | reasons.append((INFO, "Used Memory in Redis: %s(%s%%)"%(mem, used))) 126 | reasons.append((INFO, "Real Memory in Redis RSS: %s"%(rss))) 127 | reasons.append((INFO, "MaxMemory Settings: %s"%(maxmemory))) 128 | reasons.append((INFO, "Fragmentation Ratio : %s(%s)"%(ratio, fragmentation_str(ratio)))) 129 | 130 | return reasons 131 | 132 | @checker.register(title="RDB Status") 133 | def checkRDB(r, info): 134 | reasons = [] 135 | default = ['3600', '1', '300', '100', '60', '10000'] 136 | save = r.config_get("save")["save"] 137 | parts = save.split() 138 | if default == parts: 139 | reasons.append((DANGER, "save option is set by default: %s"%(save))) 140 | 141 | if len(parts) > 0: 142 | if info["rdb_last_bgsave_status"] != "ok": 143 | reasons.append((DANGER, "rdb_last_bgsave_status is bad")) 144 | 145 | bgsave = r.config_get("stop-writes-on-bgsave-error")["stop-writes-on-bgsave-error"] 146 | if bgsave == "yes": 147 | reasons.append((WARNING, "stop-writes-on-bgsave-error is yes")) 148 | 149 | return reasons 150 | 151 | @checker.register(title="AOF Status") 152 | def checkAOF(r, info): 153 | #"auto-aof-rewrite-percentage" 154 | #"100" 155 | #"auto-aof-rewrite-min-size" 156 | #"67108864" 157 | 158 | reasons = [] 159 | appendonly = r.config_get("appendonly")["appendonly"] 160 | if appendonly == 'no': 161 | return reasons 162 | 163 | appendfsync = r.config_get("appendfsync")["appendfsync"] 164 | if appendfsync == "always": 165 | reasons.append((CHECK, "appendfsync is always. It can cause performance issue")) 166 | 167 | per = int(r.config_get("auto-aof-rewrite-percentage")["auto-aof-rewrite-percentage"]) 168 | size = bytesToStr(int(r.config_get("auto-aof-rewrite-min-size")["auto-aof-rewrite-min-size"])) 169 | 170 | if per != 0: 171 | reasons.append((WARNING, "AOF can be auto generated. per: %s, size: %s"%(per, size))) 172 | 173 | return reasons 174 | 175 | def checkClients(r, info): 176 | reasons = [] 177 | reasons.extend(checkMaxClients(r, info)) 178 | reasons.extend(checkOutputBufferLimites(r, info)) 179 | return reasons 180 | 181 | 182 | @checker.register(title="MAX Clients Status") 183 | def checkMaxClients(r, info): 184 | reasons = [] 185 | maxclients = int(r.config_get("maxclients")["maxclients"]) 186 | if maxclients < MAXCLIENTS: 187 | reasons.append((CHECK, "MaxClients is too small. current %s, recommend: 50000"%(maxclients))) 188 | 189 | return reasons 190 | 191 | @checker.register(title="Replication outputBufferLimits Status") 192 | def checkOutputBufferLimites(r, info): 193 | ''' 194 | normal 0 0 0 slave 268435456 67108864 60 pubsub 33554432 8388608 60 195 | ''' 196 | 197 | mem = int(info['used_memory']) 198 | rss = int(info['used_memory_rss']) 199 | 200 | reasons = [] 201 | ret = r.config_get("client-output-buffer-limit")["client-output-buffer-limit"] 202 | parts = ret.split() 203 | if parts[3] == 'slave': 204 | hard = int(parts[4]) 205 | soft = int(parts[5]) 206 | 207 | if mem > (9 * 1024 * 1024 * 1024): 208 | if hard < (512 * 1024 * 1024): 209 | reasons.append(CHECK, "client-output-buffer-limit is small for slave. up it to least 512MB") 210 | 211 | return reasons 212 | 213 | 214 | def checkDangerCommands(r, info): 215 | #cmdstat_setex:calls=1486470,usec=3265266,usec_per_call=2.20 216 | ret = 0 217 | if "cmdstat_keys" in info: 218 | ret = int(info['cmdstat_keys']['calls']) 219 | 220 | return ret 221 | 222 | def checkConnectedClients(r, info): 223 | return (int(info['connected_clients'])) 224 | 225 | def checkCommands(r, info): 226 | return (int(info['total_commands_processed'])) 227 | 228 | def arrayGap(t): 229 | return [t[i+1]-t[i] for i in range(len(t)-1)] 230 | 231 | 232 | def reportFunc(title, reasons): 233 | print("===================================================") 234 | print(title) 235 | for t in reasons: 236 | print("%s: %s"%(toStr(t[0]), t[1])) 237 | 238 | 239 | if __name__ == '__main__': 240 | parser = argparse.ArgumentParser(description="Redis Key Length/Size") 241 | parser.add_argument("--host", default="localhost", help="Redis Host") 242 | parser.add_argument("--port", type=int, default=6379, help="Redis Port") 243 | args = parser.parse_args() 244 | 245 | args = parser.parse_args() 246 | r = getRedisConn(args.host, args.port) 247 | info = r.info() 248 | checker.call(r, info, reportFunc) 249 | -------------------------------------------------------------------------------- /create_virtaulenv.sh: -------------------------------------------------------------------------------- 1 | python3 -m venv env 2 | -------------------------------------------------------------------------------- /key_analysis.py: -------------------------------------------------------------------------------- 1 | from collections import defaultdict 2 | import redis 3 | import argparse 4 | import heapq 5 | 6 | 7 | def extract_prefix(key, delim): 8 | if delim in key: 9 | return key.split(delim)[0] 10 | return "(no-prefix)" 11 | 12 | 13 | def get_key_size_safe(r, key, ktype): 14 | try: 15 | if ktype == b'string': 16 | return r.strlen(key) 17 | elif ktype == b'list': 18 | return r.llen(key) 19 | elif ktype == b'set': 20 | return r.scard(key) 21 | elif ktype == b'zset': 22 | return r.zcard(key) 23 | elif ktype == b'hash': 24 | return r.hlen(key) 25 | else: 26 | return -1 27 | except Exception: 28 | return -1 29 | 30 | 31 | def main(): 32 | parser = argparse.ArgumentParser(description="Redis Key Length/Size") 33 | parser.add_argument("--host", default="localhost", help="Redis Host") 34 | parser.add_argument("--port", type=int, default=6379, help="Redis Port") 35 | parser.add_argument("--pattern", default="*", help="Key Pattern") 36 | parser.add_argument("--top", type=int, default=0, help="Top N") 37 | parser.add_argument("--db", type=int, default=0, help="Key DB") 38 | parser.add_argument("--prefix", default=":", help="Prefix Delimiter(ex: ':', '_')") 39 | args = parser.parse_args() 40 | 41 | r = redis.Redis(host=args.host, port=args.port) 42 | r.select(args.db) 43 | cursor = 0 44 | total_keys = 0 45 | 46 | print(f"{'Key':40} {'Type':10} {'Size (len/num)':>15}") 47 | print("-" * 70) 48 | 49 | top_keys = defaultdict(list) 50 | prefix_counts = defaultdict(int) 51 | 52 | while True: 53 | cursor, keys = r.scan(cursor=cursor, match=args.pattern, count=100) 54 | for key in keys: 55 | try: 56 | ktype = r.type(key) 57 | size = get_key_size_safe(r, key, ktype) 58 | 59 | ktype_str = ktype.decode() 60 | 61 | key_str = key.decode() 62 | prefix = extract_prefix(key_str, args.prefix) 63 | prefix_counts[prefix] += 1 64 | 65 | heap = top_keys[ktype_str] 66 | heapq.heappush(heap, (size, key_str)) 67 | if len(heap) > args.top: 68 | heapq.heappop(heap) 69 | 70 | if args.top == 0: 71 | print(f"{key.decode():40} {ktype.decode():10} {size:>15}") 72 | except Exception as e: 73 | print(e) 74 | continue 75 | total_keys += 1 76 | if cursor == 0: 77 | break 78 | 79 | print("-" * 70) 80 | print(f"🔍 Total Keys: {total_keys}") 81 | 82 | if args.top > 0: 83 | for dtype, heap in top_keys.items(): 84 | print(f"📦 Collection : {dtype.upper()} (Top {args.top})") 85 | print(f"{'Key':40} {'Size':>10}") 86 | print("-" * 60) 87 | 88 | for size, key in sorted(heap, key=lambda x: -x[0]): 89 | print(f"{key:40} {size:>10}") 90 | 91 | print() 92 | 93 | print(f"{'Prefix':20} {'Count':>10}") 94 | print("-" * 50) 95 | 96 | for prefix, count in sorted(prefix_counts.items(), key=lambda x: -x[1])[:args.top]: 97 | print(f"{prefix:20} {count:>10}") 98 | 99 | if __name__ == "__main__": 100 | main() 101 | 102 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | redis 2 | jinja2 3 | fastapi 4 | uvicorn 5 | -------------------------------------------------------------------------------- /show_redis_clients.py: -------------------------------------------------------------------------------- 1 | import redis 2 | import sys 3 | import json 4 | 5 | def get_client_lists(host, port): 6 | conn = redis.StrictRedis(host, port) 7 | return conn.client_list() 8 | 9 | def get_client_ips(clients): 10 | ips = {} 11 | for client in clients: 12 | addr = client['addr'] 13 | ip = addr.split(':')[0] 14 | if ip in ips: 15 | ips[ip] += 1 16 | else: 17 | ips[ip] = 1 18 | 19 | return ips 20 | 21 | 22 | HOST = '127.0.0.1' 23 | PORT = 6379 24 | 25 | if len(sys.argv) > 1: 26 | HOST = sys.argv[1] 27 | 28 | if len(sys.argv) > 2: 29 | PORT = int(sys.argv[2]) 30 | 31 | if __name__ == '__main__': 32 | clients = get_client_lists(HOST, PORT) 33 | ips = get_client_ips(clients) 34 | for ip in ips: 35 | print("IP : %s(count: %s)"%(ip, ips[ip])) 36 | --------------------------------------------------------------------------------