initial version

Satoshi Mitani · Satoshi Mitani · commit 4f20f6488bf8 · 2020-05-01T21:15:41.000+09:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,203 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Datadog, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/README.md b/README.md
@@ -0,0 +1,47 @@
+# mysql-slow-query-datadog-lambda
+
+AWS Lambda function to relay fingerprint-ed / normalized MySQL Slow Query logs to Datadog.
+
+This function normalizes SQL like below to aggregate metrics on Datadog.
+
+```
+SELECT id, name FROM tbl WHERE id = "1000"` => `SELECT id, name FROM tbl WHERE id = ?
+SELECT id, name FROM tbl WHERE id IN (10, 20, 30)` => `SELECT id, name FROM tbl WHERE id IN (?+)
+```
+
+# How to use
+ 
+1. Generate function.zip file.
+
+```
+$ git clone https://github.com/samitani/mysql-slow-query-datadog-lambda.git
+$ cd mysql-slow-query-datadog-lambda
+$ mkzip.sh
+$ ls -l function.zip
+-rw-r--r--. 1 root root 17024 Apr 29 22:09 function.zip
+```
+
+2. Create Lambda function with generated function.zip
+
+Specify Python3 as Runtime, `main.lambda_handler` as Handler
+
+3. Configure Lambda Environments below
+
+| Key                   | Value         |
+|:----------------------|:--------------|
+| DD_API_KEY_SECRET_ARN	| AWS Secret Manager ARN of Datadog API KEY.<br>eg) `arn:aws:secretsmanager:ap-northeast-1:XXXXXXXXX:secret:DdApiKeySecret-XXXXXXXX` |
+| DD_ENHANCED_METRICS   | false         | 
+| DD_SITE               | datadoghq.com |
+
+4. Create Lambda Subscription filter against your Slow Query log CloudWatch Log groups
+
+## Datadog
+Generate Metrics with below Grok parser.
+
+```
+SlowLogRule ^(\# Time: (%{date("yyMMdd  H:mm:ss"):date}|%{date("yyMMdd HH:mm:ss"):date})\n+)?\# User@Host: %{notSpace: user1}\[%{notSpace: user2}\] @ (%{notSpace: host}| ) *\[%{regex("[0-9.]*"): ip}\]  Id:[\x20\t]+%{number: id}\n+\# Query_time: %{number: query_time} *Lock_time: %{number: lock_time} *Rows_sent: %{number: rows_sent} *Rows_examined: %{number: rows_examined}\n(SET timestamp=%{number: timestamp};\n+)?%{regex("[a-zA-Z].*"):query}.
+```
+## Note
+`enhanced_lambda_metrics.py` and `lambda_function.py` were borrowed from below Datadog repository.
+
+https://github.com/DataDog/datadog-serverless-functions
diff --git a/mkzip.sh b/mkzip.sh
@@ -0,0 +1,4 @@
+pushd src
+pip3 install requests -t .
+zip -r ../function.zip *
+popd
diff --git a/src/fingerprint.py b/src/fingerprint.py
@@ -0,0 +1,19 @@
+import re
+
+def fingerprint(query):
+    query = query.strip().lower()
+
+    query = re.sub(r'\\["\']', '', query)
+    query = re.sub(r'[ \n\t\r\f]+', ' ', query)
+    query = re.sub(r'\bnull\b', '?', query)
+    query = re.sub(r'\b\d+\b', '?', query)
+
+    # "str" => ?
+    query = re.sub(r'".*?"', '?', query)
+    # 'str' => ?
+    query = re.sub(r"'.*?'", '?', query)
+
+    query = re.sub(r'\b(in|values)([\s,]*\([\s?,]*\))+', '\\1(?+)', query)
+    query = re.sub(r'\blimit \?(, ?\?| offset \?)?', 'limit ?', query)
+
+    return query
diff --git a/src/main.py b/src/main.py
@@ -0,0 +1,31 @@
+import lambda_function
+import fingerprint
+
+def my_enrich_slow_logs(events):
+    for event in events:
+        messages = []
+        sql = ''
+        
+        for line in event['message'].split("\n"):
+            if line.startswith("#"):
+                messages.append(line)
+            elif line.startswith("SET timestamp="):
+                pass
+            elif line.startswith("use "):
+                pass
+            else:
+                sql = sql + line
+        
+        messages.append(fingerprint.fingerprint(sql))
+
+        event['message'] = "\n".join(messages)
+
+        lambda_function.add_metadata_to_lambda_log(event)
+    return events
+
+def lambda_handler(event, context):
+    lambda_function.enrich = my_enrich_slow_logs
+
+    return lambda_function.lambda_handler(event, context)
+
+
diff --git a/tests/test_fingerprint.py b/tests/test_fingerprint.py
@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+
+import sys
+sys.path.append('src/')
+
+import unittest
+from fingerprint import fingerprint
+
+
+class TestFinterprint(unittest.TestCase):
+
+
+    def test_sql_simple(self):
+        self.assertEqual(fingerprint('SELECT * FROM tbl WHERE col1 = "abc"'),
+                         "select * from tbl where col1 = ?")
+
+    def test_sql_simple2(self):
+        self.assertEqual(fingerprint('SELECT * FROM tbl WHERE col1 = 123'),
+                         "select * from tbl where col1 = ?")
+
+    def test_sql_wherein(self):
+        self.assertEqual(fingerprint('SELECT * FROM tbl WHERE id IN ("a", "b", 123)'),
+                         "select * from tbl where id in(?+)")
+
+    def test_sql_japanese(self):
+        self.assertEqual(fingerprint('SELECT * FROM tbl WHERE col1 LIKE "%ソ%"'),
+                         "select * from tbl where col1 like ?")
+
+    def test_sql_multiline(self):
+        self.assertEqual(fingerprint("SELECT col1, created_at FROM tbl\nWHERE col1 like 'abc%'"),
+                         "select col1, created_at from tbl where col1 like ?")
+
+    def test_sql_limit(self):
+        self.assertEqual(fingerprint('SELECT * FROM tbl WHERE col1 = "abc" LIMIT 10'),
+                         "select * from tbl where col1 = ? limit ?")
+
+    def test_sql_call(self):
+        self.assertEqual(fingerprint("CALL MYFUNCTION(123)"),
+                         "call myfunction(?)")
+
+    def test_sql_long(self):
+        self.assertEqual(fingerprint("SELECT *, sleep(1) from tbl where pk = 1 or pk = 2 or pk = 3 or pk = 4 or pk = 5 or pk = 6 or pk = 7 or pk = 8 or pk = 9 or pk = 10 or pk = 11"),
+                         "select *, sleep(?) from tbl where pk = ? or pk = ? or pk = ? or pk = ? or pk = ? or pk = ? or pk = ? or pk = ? or pk = ? or pk = ? or pk = ?")
