├── conf └── es-open-falcon.yml.default ├── bin ├── es-falcon.py └── esmetrics.py ├── README.md ├── .gitignore └── LICENSE /conf/es-open-falcon.yml.default: -------------------------------------------------------------------------------- 1 | falcon: 2 | push_url: http://127.0.0.1:6071/v1/push 3 | step: 60 4 | 5 | # Elasticsearch clusters 6 | es-clusters: 7 | - {endpoint: "127.0.0.1", url: "http://127.0.0.1:9200"} 8 | -------------------------------------------------------------------------------- /bin/es-falcon.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import yaml 4 | 5 | import esmetrics 6 | 7 | with open('conf/es-open-falcon.yml', 'r') as ymlfile: 8 | config = yaml.load(ymlfile) 9 | 10 | threads = [] 11 | 12 | for es_cluster in config['es-clusters']: 13 | metric_thread = esmetrics.EsMetrics(config['falcon'], es_cluster) 14 | metric_thread.start() 15 | threads.append(metric_thread) 16 | 17 | for thread in threads: 18 | thread.join(5) 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # es-open-falcon 2 | 3 | ElasticSearch Monitor Script for Open Falcon 4 | 5 | ### Step 1: Edit conf 6 | 7 | Rename `es-open-falcon.yml.default` to `es-open-falcon.yml`, then edit the file, and add your es servers. 8 | 9 | ```yml 10 | falcon: 11 | push_url: http://127.0.0.1:6071/v1/push 12 | step: 60 13 | 14 | # Elasticsearch clusters 15 | es-clusters: 16 | - {endpoint: "localhost", url: "http://127.0.0.1:9200"} 17 | 18 | ``` 19 | 20 | ### Step 2: Add the monitor script to crontab 21 | 22 | ``` 23 | $ crontab -l 24 | */1 * * * * cd /path/to/es-open-falcon && python -u ./bin/es-falcon.py >> es-open-falcon.log 2>&1 25 | ``` 26 | 27 | # es-open-falcon 28 | 29 | 用于 Open Falcon 的 ElasticSearch 监控采集脚本 30 | 31 | ### 第一步：编辑配置文件 32 | 33 | 将 `es-open-falcon.yml.default` 重命名为 `es-open-falcon.yml`，然后编辑这个文件，添加你要监控的 ElasticSearch 服务器信息。 34 | 35 | ```yml 36 | falcon: 37 | push_url: http://127.0.0.1:6071/v1/push 38 | step: 60 39 | 40 | # Elasticsearch clusters 41 | es-clusters: 42 | - {endpoint: "localhost", url: "http://127.0.0.1:9200"} 43 | 44 | ``` 45 | 46 | ### 第二步：将监控脚本添加到 crontab 中定时执行 47 | 48 | ``` 49 | $ crontab -l 50 | */1 * * * * cd /path/to/es-open-falcon && python -u ./bin/es-falcon.py >> es-open-falcon.log 2>&1 51 | ``` 52 | 53 | ## 好用就给个 Star 呗！ -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | es-open-falcon.yml 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .coverage 43 | .coverage.* 44 | .cache 45 | nosetests.xml 46 | coverage.xml 47 | *.cover 48 | .hypothesis/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | 58 | # Flask stuff: 59 | instance/ 60 | .webassets-cache 61 | 62 | # Scrapy stuff: 63 | .scrapy 64 | 65 | # Sphinx documentation 66 | docs/_build/ 67 | 68 | # PyBuilder 69 | target/ 70 | 71 | # Jupyter Notebook 72 | .ipynb_checkpoints 73 | 74 | # pyenv 75 | .python-version 76 | 77 | # celery beat schedule file 78 | celerybeat-schedule 79 | 80 | # SageMath parsed files 81 | *.sage.py 82 | 83 | # dotenv 84 | .env 85 | 86 | # virtualenv 87 | .venv 88 | venv/ 89 | ENV/ 90 | 91 | # Spyder project settings 92 | .spyderproject 93 | .spyproject 94 | 95 | # Rope project settings 96 | .ropeproject 97 | 98 | # mkdocs documentation 99 | /site 100 | 101 | # mypy 102 | .mypy_cache/ 103 | -------------------------------------------------------------------------------- /bin/esmetrics.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import threading 4 | import elasticsearch 5 | import json 6 | import time 7 | from datetime import datetime 8 | import requests 9 | 10 | 11 | class EsMetrics(threading.Thread): 12 | status_map = { 13 | 'green': 0, 14 | 'yellow': 1, 15 | 'red': 2 16 | } 17 | 18 | def __init__(self, falcon_conf, es_conf): 19 | self.falcon_conf = falcon_conf 20 | self.es_conf = es_conf 21 | # Assign default conf 22 | if 'test_run' not in self.falcon_conf: 23 | self.falcon_conf['test_run'] = False 24 | if 'step' not in self.falcon_conf: 25 | self.falcon_conf['step'] = 60 26 | 27 | self.index_metrics = { 28 | 'search': ['query_total', 'query_time_in_millis', 'query_current', 'fetch_total', 'fetch_time_in_millis', 'fetch_current'], 29 | 'indexing': ['index_total', 'index_current', 'index_time_in_millis', 'delete_total', 'delete_current', 'delete_time_in_millis'], 30 | 'docs': ['count', 'deleted'], 31 | 'store': ['size_in_bytes', 'throttle_time_in_millis'] 32 | } 33 | self.cluster_metrics = ['status', 'number_of_nodes', 'number_of_data_nodes', 'active_primary_shards', 'active_shards', 'unassigned_shards'] 34 | self.counter_keywords = ['query_total', 'query_time_in_millis', 35 | 'fetch_total', 'fetch_time_in_millis', 36 | 'index_total', 'index_time_in_millis', 37 | 'delete_total', 'delete_time_in_millis'] 38 | super(EsMetrics, self).__init__(None, name=self.es_conf['endpoint']) 39 | self.setDaemon(False) 40 | 41 | def run(self): 42 | try: 43 | self.es = elasticsearch.Elasticsearch([self.es_conf['url']]) 44 | falcon_metrics = [] 45 | # Statistics 46 | timestamp = int(time.time()) 47 | nodes_stats = self.es.nodes.stats() 48 | cluster_health = self.es.cluster.health() 49 | keyword_metric = {} 50 | for node in nodes_stats['nodes']: 51 | index_stats = nodes_stats['nodes'][node]['indices'] 52 | for type in self.index_metrics: 53 | for keyword in self.index_metrics[type]: 54 | if keyword not in keyword_metric: 55 | keyword_metric[keyword] = 0 56 | keyword_metric[keyword] += index_stats[type][keyword] 57 | for keyword in self.cluster_metrics: 58 | if keyword == 'status': 59 | keyword_metric[keyword] = self.status_map[cluster_health[keyword]] 60 | else: 61 | keyword_metric[keyword] = cluster_health[keyword] 62 | for keyword in keyword_metric: 63 | falcon_metric = { 64 | 'counterType': 'COUNTER' if keyword in self.counter_keywords else 'GAUGE', 65 | 'metric': "es." + keyword, 66 | 'endpoint': self.es_conf['endpoint'], 67 | 'timestamp': timestamp, 68 | 'step': self.falcon_conf['step'], 69 | 'tags': 'n=' + nodes_stats['cluster_name'], 70 | 'value': keyword_metric[keyword] 71 | } 72 | falcon_metrics.append(falcon_metric) 73 | if self.falcon_conf['test_run']: 74 | print json.dumps(falcon_metrics) 75 | else: 76 | req = requests.post(self.falcon_conf['push_url'], data=json.dumps(falcon_metrics)) 77 | print datetime.now(), "INFO: [%s]" % self.es_conf['endpoint'], "[%s]" % self.falcon_conf['push_url'], req.text 78 | except Exception as e: 79 | if self.falcon_conf['test_run']: 80 | raise 81 | else: 82 | print datetime.now(), "ERROR: [%s]" % self.es_conf['endpoint'], e 83 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------