├── requirements.txt ├── search-elasticsearch ├── other │ └── README.md ├── metadata │ └── default.meta ├── bin │ ├── config.template │ ├── search.py │ └── essearch.py └── default │ ├── app.conf │ ├── commands.conf │ ├── searchbnf.conf │ └── logging.conf ├── .gitignore ├── README.md ├── tests └── test_essearch.py └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | pytest 2 | -------------------------------------------------------------------------------- /search-elasticsearch/other/README.md: -------------------------------------------------------------------------------- 1 | Need Python ElasticSearch installed 2 | -------------------------------------------------------------------------------- /search-elasticsearch/metadata/default.meta: -------------------------------------------------------------------------------- 1 | [commands] 2 | access = read : [ * ], write : [ admin ] 3 | export = system 4 | 5 | [searchbnf] 6 | access = read : [ * ], write : [ admin ] 7 | export = system 8 | -------------------------------------------------------------------------------- /search-elasticsearch/bin/config.template: -------------------------------------------------------------------------------- 1 | { 2 | "consumer-key": "PUT CONSUMER KEY HERE", 3 | "consumer-secret": "PUT CONSUMER SECRET HERE", 4 | "token": "PUT TOKEN HERE", 5 | "token-secret": "PUT TOKEN_SECRET HERE" 6 | } -------------------------------------------------------------------------------- /search-elasticsearch/default/app.conf: -------------------------------------------------------------------------------- 1 | # 2 | # Splunk app configuration file 3 | # 4 | 5 | [ui] 6 | is_visible = 1 7 | label = Seach for ElasticSearch 8 | 9 | [launcher] 10 | author = Henri van den Bulk 11 | description = Splunk Search for ElasticSearch 12 | version = 1.0 13 | 14 | [package] 15 | id = splunk-elasticsearch 16 | 17 | [install] 18 | is_configured = 0 -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | config.json 2 | *.pyc 3 | *.swp 4 | *.idea 5 | *.DS_Store* 6 | *coverage_html_report* 7 | .coverage 8 | .coverage.* 9 | __stdout__ 10 | docs/_build 11 | build/ 12 | proxypid 13 | proxy.log 14 | MANIFEST 15 | coverage_report 16 | test.log 17 | examples/*/local 18 | examples/*/metadata 19 | tests/searchcommands_data/log/ 20 | tests/searchcommands_data/output/ 21 | *.dist-info 22 | __pycache__ -------------------------------------------------------------------------------- /search-elasticsearch/default/commands.conf: -------------------------------------------------------------------------------- 1 | # [commands.conf]($SPLUNK_HOME/etc/system/README/commands.conf.spec) 2 | [defaults] 3 | 4 | [es] 5 | filename = essearch.py 6 | 7 | supports_getinfo = true 8 | supports_rawargs = true 9 | outputheader = true 10 | 11 | 12 | #overrides_timeorder = true 13 | #supports_getinfo = true 14 | #supports_rawargs = true 15 | #outputheader = true 16 | #streaming = false 17 | #generating = true 18 | 19 | #enableheader = true 20 | #retainsevents = false 21 | #changecolorder = false 22 | 23 | #run_in_preview = true 24 | #maxinputs = 10000 -------------------------------------------------------------------------------- /search-elasticsearch/default/searchbnf.conf: -------------------------------------------------------------------------------- 1 | [es-command] 2 | syntax = es ()* 3 | shortdesc = Performs a query against ElasticSearch 4 | description = Performs a query against ElasticSearch and returns the results to Splunk without indexing. 5 | usage = public app 6 | maintainer = hvandenb 7 | 8 | comment1 = Search for the text hello 9 | example1 = | es q="hello" 10 | 11 | tags = search 12 | category = search 13 | related = search 14 | 15 | [es-options] 16 | syntax = index= | q= | fields= | oldest= | earl= | limit= 17 | description = The es search command performs a search against ElasticSearch and then returns events that matches the query.\ 18 | 'index' is a comma seperated list of indicies against which the query specified with 'q' will run. 19 | -------------------------------------------------------------------------------- /search-elasticsearch/default/logging.conf: -------------------------------------------------------------------------------- 1 | [loggers] 2 | keys = root, EsCommand 3 | 4 | [logger_root] 5 | level = DEBUG ; Default: WARNING 6 | handlers = stderr ; Default: stderr 7 | 8 | [logger_EsCommand] 9 | qualname = EsCommand 10 | level = NOTSET ; Default: WARNING 11 | handlers = file ; Default: stderr 12 | 13 | [handlers] 14 | keys=file, stderr 15 | 16 | [handler_stderr] 17 | class = logging.StreamHandler 18 | level = NOTSET 19 | args = (sys.stderr,) 20 | formatter = search_command 21 | 22 | [handler_file] 23 | # Select this handler to log events to $SPLUNK_HOME/etc/apps/esearch/esearch.log 24 | class = logging.FileHandler 25 | level = NOTSET 26 | args = ('esearch.log', 'a', 'utf-8', True) 27 | formatter = search_command 28 | 29 | [formatters] 30 | keys = search_command 31 | 32 | [formatter_search_command] 33 | format=%(levelname)s:%(module)s: %(message)s -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Splunk Search Command for Elasticsearch 2 | 3 | This is a Splunk search command that allows you to query an Elasticsearch index and view the results within the Splunk GUI. 4 | 5 | ## Requirements 6 | 7 | * Splunk Enterprise 8.x or later. 8 | * Python 3.7 or later. 9 | * Access to an Elasticsearch cluster. 10 | 11 | ## Installation 12 | 13 | 1. **Install Python Dependencies:** 14 | 15 | This command needs the `elasticsearch` and `splunk-sdk` Python libraries. You can install them using pip: 16 | ```bash 17 | pip install elasticsearch splunk-sdk 18 | ``` 19 | 20 | 2. **Install the Splunk App:** 21 | 22 | Copy the `search-elasticsearch` directory to your Splunk apps folder: 23 | ```bash 24 | cp -r search-elasticsearch $SPLUNK_HOME/etc/apps/ 25 | ``` 26 | Alternatively, you can package the `search-elasticsearch` directory as a `.spl` file and install it through the Splunk UI. 27 | 28 | 3. **Restart Splunk:** 29 | 30 | After installing the app, you will need to restart your Splunk instance. 31 | 32 | ## Usage 33 | 34 | You can now use the `esearch` command in your Splunk search bar. 35 | 36 | **Basic Example:** 37 | ``` 38 | | esearch q="some text" 39 | ``` 40 | This will search for "some text" in the `message` field of all indices. 41 | 42 | **Advanced Example:** 43 | ``` 44 | | esearch oldest=now-100d earliest=now q="some text" index=nagios* limit=1000 field=message 45 | ``` 46 | 47 | ### Command Reference 48 | 49 | * `q`: The query string to send to Elasticsearch. (Required) 50 | * `index`: The Elasticsearch index to search. (Default: `*`) 51 | * `limit`: The maximum number of records to return. (Default: 100) 52 | * `fields`: The field to query in Elasticsearch. (Default: `message`) 53 | * `oldest`: The oldest time for the search range (e.g., `now-1d`). (Default: `now`) 54 | * `earliest`: The earliest time for the search range. (Default: `now-1d`) 55 | -------------------------------------------------------------------------------- /search-elasticsearch/bin/search.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | from datetime import datetime 3 | from elasticsearch import Elasticsearch 4 | import pprint 5 | import time 6 | import sys 7 | import json 8 | 9 | total = len(sys.argv) 10 | cmdargs = str(sys.argv) 11 | index="*" 12 | limit=100 13 | oldestDate="now-1d" 14 | earliestDate="now" 15 | defaultField="message" 16 | query="*" 17 | for i in xrange(total): 18 | opt = str (sys.argv[i]) 19 | if ( opt.startswith("index") ): 20 | index= str (sys.argv[i]).split("=")[1] 21 | elif ( opt.startswith("query") ): 22 | query= str (sys.argv[i]).split("=")[1] 23 | elif ( opt.startswith("field") ): 24 | defaultField= str (sys.argv[i]).split("=")[1] 25 | elif ( opt.startswith("oldest") ): 26 | oldestDate= str (sys.argv[i]).split("=")[1] 27 | elif ( opt.startswith("earl") ): 28 | earliestDate= str (sys.argv[i]).split("=")[1] 29 | elif ( opt.startswith("limit") ): 30 | limit= str (sys.argv[i]).split("=")[1] 31 | 32 | pp = pprint.PrettyPrinter(indent=4) 33 | # to query an external server: Elasticsearch(['http://1.2.3.4:9200']) 34 | es = Elasticsearch() 35 | body = { 36 | "size": limit, 37 | "from": 0, 38 | "query": { 39 | "bool" : { 40 | "must": [{ 41 | "query_string" : { 42 | "default_field" : defaultField, 43 | "query" : query 44 | }}, 45 | {"range" : { 46 | "@timestamp": { 47 | "lt" : earliestDate, 48 | "gt" : oldestDate 49 | } 50 | } 51 | }], 52 | "must_not":[], 53 | "should":[] 54 | } 55 | } 56 | } 57 | #pp.pprint(body) 58 | res = es.search(size=limit, index=index, body=body) 59 | print("\"_time\",\"_raw\",\"index\",\"type\"") 60 | #pp.pprint(res) 61 | #date_time = '2014-12-21T16:11:18.419Z' 62 | pattern = '%Y-%m-%dT%H:%M:%S.%fZ' 63 | 64 | for hit in res['hits']['hits']: 65 | epochTimestamp = hit['_source']['@timestamp'] 66 | hit['_source']['_epoch'] = int(time.mktime(time.strptime(epochTimestamp, pattern))) 67 | hit['_source']["_raw"]=json.dumps(hit['_source'][defaultField]).replace('"',' ') 68 | print("%(_epoch)s,\"%(_raw)s\"," % hit["_source"] + 69 | "\"%(_index)s\",\"%(_type)s\"" % hit 70 | ) 71 | #test development branch 72 | -------------------------------------------------------------------------------- /tests/test_essearch.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import os 3 | import json 4 | from unittest.mock import patch, MagicMock 5 | 6 | # Add the script's directory to the Python path 7 | sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', 'search-elasticsearch', 'bin'))) 8 | 9 | from essearch import EsCommand 10 | 11 | def test_es_command_success(): 12 | """Test a successful search query.""" 13 | # Mock Elasticsearch client 14 | mock_es_client = MagicMock() 15 | mock_es_client.search.return_value = { 16 | 'hits': { 17 | 'hits': [ 18 | { 19 | '_index': 'test_index', 20 | '_type': 'test_type', 21 | '_id': '1', 22 | '_score': 1.0, 23 | '_source': {'message': 'hello world'} 24 | } 25 | ] 26 | } 27 | } 28 | 29 | with patch('essearch.Elasticsearch', return_value=mock_es_client): 30 | # Instantiate the command 31 | cmd = EsCommand() 32 | cmd.q = "test query" 33 | cmd.index = "test_index" 34 | cmd.limit = 10 35 | 36 | # Run the generator 37 | results = list(cmd.generate()) 38 | 39 | # Assertions 40 | assert len(results) == 1 41 | event = results[0] 42 | assert event['_id'] == '1' 43 | assert event['_index'] == 'test_index' 44 | # Check that the raw event is a JSON string of the original hit 45 | raw_event = json.loads(event['_raw']) 46 | assert raw_event['_source']['message'] == 'hello world' 47 | 48 | # Check that the search method was called with the correct arguments 49 | mock_es_client.search.assert_called_once_with( 50 | index='test_index', 51 | query={'query_string': {'query': 'test query'}}, 52 | size=10 53 | ) 54 | 55 | def test_es_command_exception(): 56 | """Test the command when Elasticsearch raises an exception.""" 57 | # Mock Elasticsearch client to raise an exception 58 | mock_es_client = MagicMock() 59 | mock_es_client.search.side_effect = Exception("Connection error") 60 | 61 | with patch('essearch.Elasticsearch', return_value=mock_es_client): 62 | # Instantiate the command 63 | cmd = EsCommand() 64 | cmd.q = "error query" 65 | cmd.index = "error_index" 66 | cmd.limit = 10 67 | 68 | # Run the generator 69 | results = list(cmd.generate()) 70 | 71 | # Assertions 72 | assert len(results) == 1 73 | error_event = results[0] 74 | assert "Error during Elasticsearch search: Connection error" in error_event['_raw'] 75 | -------------------------------------------------------------------------------- /search-elasticsearch/bin/essearch.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # 3 | # Copyright 2011-2014 Splunk, Inc. 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"): you may 6 | # not use this file except in compliance with the License. You may obtain 7 | # a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 13 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 14 | # License for the specific language governing permissions and limitations 15 | # under the License. 16 | 17 | import sys 18 | import time 19 | import json 20 | from elasticsearch import Elasticsearch 21 | 22 | from splunklib.searchcommands import \ 23 | dispatch, GeneratingCommand, Configuration, Option, validators 24 | 25 | @Configuration() 26 | class EsCommand(GeneratingCommand): 27 | """ Generates events that are the result of a query against Elasticsearch 28 | 29 | ##Syntax 30 | 31 | .. code-block:: 32 | es index= | q= | fields= | oldest= | earl= | limit= 33 | 34 | ##Description 35 | 36 | The :code:`es` issue a query to ElasticSearch, where the 37 | query is specified in :code:`q`. 38 | 39 | ##Example 40 | 41 | .. code-block:: 42 | | es oldest=now-100d earliest=now query="some text" index=nagios* limit=1000 field=message 43 | 44 | This example generates events drawn from the result of the query 45 | 46 | """ 47 | 48 | index = Option(doc='', require=False, default="*") 49 | q = Option(doc='', require=True) 50 | fields = Option(doc='', require=False, default="message") 51 | oldest = Option(doc='', require=False, default="now") 52 | earl = Option(doc='', require=False, default="now-1d") 53 | limit = Option(doc='', require=False, validate=validators.Integer(), default=100) 54 | 55 | def generate(self): 56 | self.logger.debug('Starting ES search command.') 57 | 58 | es = Elasticsearch() 59 | 60 | query = { 61 | "query_string": { 62 | "query": self.q 63 | } 64 | } 65 | 66 | try: 67 | res = es.search( 68 | index=self.index, 69 | query=query, 70 | size=self.limit 71 | ) 72 | 73 | for hit in res['hits']['hits']: 74 | yield self.get_event(hit) 75 | 76 | except Exception as e: 77 | self.logger.error("Error during Elasticsearch search: %s", e) 78 | # You might want to yield an error event to Splunk 79 | yield {'_raw': f"Error during Elasticsearch search: {e}"} 80 | 81 | def get_event(self, result): 82 | event = { 83 | '_time': time.time(), 84 | '_index': result['_index'], 85 | '_type': result.get('_type', ''), # _type is deprecated 86 | '_id': result['_id'], 87 | '_score': result['_score'], 88 | '_raw': json.dumps(result) 89 | } 90 | return event 91 | 92 | if __name__ == "__main__": 93 | dispatch(EsCommand, sys.argv, sys.stdin, sys.stdout, __name__) -------------------------------------------------------------------------------- /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 | Copyright {yyyy} {name of copyright owner} 189 | Licensed under the Apache License, Version 2.0 (the "License"); 190 | you may not use this file except in compliance with the License. 191 | You may obtain a copy of the License at 192 | http://www.apache.org/licenses/LICENSE-2.0 193 | Unless required by applicable law or agreed to in writing, software 194 | distributed under the License is distributed on an "AS IS" BASIS, 195 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 196 | See the License for the specific language governing permissions and 197 | limitations under the License. --------------------------------------------------------------------------------