├── .gitignore ├── .travis.yml ├── COPYING ├── COPYING.LESSER ├── README.md ├── pom.xml ├── schemas ├── mapped_and_analyzed │ ├── annotation_map.json │ ├── opentsdb_index.json │ ├── tsmeta_map.json │ └── uidmeta_map.json └── simple │ ├── annotation_map.json │ ├── tsmeta_map.json │ └── uidmeta_map.json └── src ├── main └── java │ └── net │ └── opentsdb │ └── search │ ├── ESPluginConfig.java │ ├── ElasticSearch.java │ └── schemas │ ├── annotation │ ├── AnnotationSchema.java │ └── DefaultAnnotationSchema.java │ ├── tsmeta │ ├── AnalyzedAndMappedTSMetaSchema.java │ ├── DefaultTSMetaSchema.java │ ├── TSMetaAugment.java │ └── TSMetaSchema.java │ └── uidmeta │ ├── DefaultUIDMetaSchema.java │ └── UIDMetaSchema.java └── test └── java └── net └── opentsdb └── search ├── TestESPluginConfig.java ├── TestElasticSearch.java └── schemas ├── annotation └── TestDefaultAnnotationSchema.java ├── tsmeta ├── TestAnalyzedAndMappedTSMetaSchema.java └── TestDefaultTSMetaSchema.java └── uidmeta └── TestDefaultUIDMetaSchema.java /.gitignore: -------------------------------------------------------------------------------- 1 | INSTALL 2 | Makefile 3 | Makefile.in 4 | aclocal.m4 5 | autom4te.cache 6 | build 7 | target 8 | config.log 9 | config.status 10 | configure 11 | *.pyc 12 | .*.swp 13 | *.rrd 14 | *.class 15 | */target/* 16 | *.orig 17 | *.log 18 | 19 | #for Intellij 20 | \.idea 21 | *.iml 22 | 23 | #for guava rpm maker 24 | guava-rpm-maker/\.project 25 | 26 | # for mac finder 27 | .DS_Store 28 | 29 | # for eclipse 30 | .pydevproject 31 | .metadata 32 | .project 33 | .classpath 34 | .settings 35 | 36 | # maven 37 | bin/ 38 | dependency-reduced-pom.xml 39 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | dist: trusty 3 | script: mvn cobertura:cobertura coveralls:report --quiet 4 | addons: 5 | hostname: short-hostname 6 | jdk: 7 | - oraclejdk8 8 | notifications: 9 | email: false 10 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /COPYING.LESSER: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 489 | 490 | Also add information on how to contact you by electronic and paper mail. 491 | 492 | You should also get your employer (if you work as a programmer) or your 493 | school, if any, to sign a "copyright disclaimer" for the library, if 494 | necessary. Here is a sample; alter the names: 495 | 496 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 497 | library `Frob' (a library for tweaking knobs) written by James Random Hacker. 498 | 499 | , 1 April 1990 500 | Ty Coon, President of Vice 501 | 502 | That's all there is to it! 503 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ___ _____ ____ ____ ____ 2 | / _ \ _ __ ___ _ _|_ _/ ___|| _ \| __ ) 3 | | | | | '_ \ / _ \ '_ \| | \___ \| | | | _ \ 4 | | |_| | |_) | __/ | | | | ___) | |_| | |_) | 5 | \___/| .__/ \___|_| |_|_| |____/|____/|____/ 6 | |_| The modern time series database. 7 | 8 | 9 | [![Build Status](https://travis-ci.org/OpenTSDB/opentsdb-elasticsearch.svg?branch=master)](https://travis-ci.org/OpenTSDB/opentsdb-elasticsearch) [![Coverage Status](https://coveralls.io/repos/github/OpenTSDB/opentsdb-elasticsearch/badge.svg?branch=master)](https://coveralls.io/github/OpenTSDB/opentsdb-elasticsearch?branch=master) 10 | 11 | Search plugin for OpenTSDB 12 | 13 | ##Installation 14 | 15 | * Compile the plugin via ``mvn package``. 16 | * Create a plugins directory for your TSD 17 | * Copy the plugin from the ``target`` directory into your TSD's plugin's directory. 18 | * Add the following configs to your ``opentsdb.conf`` file. 19 | * Add ``tsd.core.plugin_path = `` pointing to a valid directory for your plugins. 20 | * Add ``tsd.search.enable = true`` 21 | * Add ``tsd.search.plugin = net.opentsdb.search.ElasticSearch`` 22 | * Add ``tsd.search.elasticsearch.host = `` The HTTP protocol, host and port for an ES host or VIP in the format ``http[s]://[:port]``. 23 | * Add a mapping for each JSON file in the ``./schemas`` sub folder of your choice via: 24 | (NOTE: It's important to do this BEFORE starting a TSD that would index data as you can't modify the mappings for documents that have already been indexed [afaik]) 25 | 26 | ``` 27 | curl -X PUT -d @schemas/simple/opentsdb_index.json http:///opentsdb/ 28 | curl -X PUT -d @schemas/simple/tsmeta_mapping.json http:///opentsdb/tsmeta/_mapping 29 | curl -X PUT -d @schemas/simple/uidmeta_mapping.json http:///opentsdb/uidmeta/_mapping 30 | curl -X PUT -d @schemas/simple/annotation_mapping.json http:///opentsdb/annotation/_mapping 31 | ``` 32 | 33 | * Optionally add ``tsd.core.meta.enable_tracking = true`` to your TSD config if it's processing incoming data 34 | * Turn up the TSD OR... 35 | * ... if you have existing data, run the ``uid metasync`` utility from OpenTSDB 36 | 37 | ## Schemas 38 | 39 | TODO - doc em 40 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | opentsdb-elasticsearch 5 | net.opentsdb 6 | opentsdb-elasticsearch 7 | 1.1.0-SNAPSHOT 8 | A search plugin for OpenTSDB that works with an Elastic 9 | Search cluster. 10 | 11 | jar 12 | 13 | 14 | 15 | Chris Larsen 16 | clarsen@euphoriaaudio.com 17 | 18 | 19 | Scott Reynolds 20 | scott@scottreynolds.us 21 | 22 | 23 | 24 | 25 | 26 | org.apache.httpcomponents 27 | httpclient 28 | 4.5.3 29 | 30 | 31 | org.apache.httpcomponents 32 | httpasyncclient 33 | 4.1.1 34 | 35 | 36 | 37 | org.slf4j 38 | jcl-over-slf4j 39 | 1.7.7 40 | 41 | 42 | 43 | net.opentsdb 44 | opentsdb 45 | 2.2.0 46 | 47 | 48 | 49 | 50 | com.google.guava 51 | guava 52 | 13.0.1 53 | 54 | 55 | 56 | com.fasterxml.jackson.core 57 | jackson-annotations 58 | 2.3.0 59 | 60 | 61 | 62 | com.fasterxml.jackson.core 63 | jackson-core 64 | 2.3.3 65 | 66 | 67 | 68 | com.fasterxml.jackson.core 69 | jackson-databind 70 | 2.3.3 71 | 72 | 73 | 74 | org.javassist 75 | javassist 76 | 3.18.1-GA 77 | test 78 | 79 | 80 | 81 | junit 82 | junit 83 | 4.11 84 | test 85 | 86 | 87 | 88 | org.mockito 89 | mockito-core 90 | 1.10.19 91 | test 92 | 93 | 94 | 95 | org.powermock 96 | powermock-api-mockito 97 | 1.6.5 98 | test 99 | 100 | 101 | 102 | org.powermock 103 | powermock-module-junit4 104 | 1.6.5 105 | test 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | org.apache.maven.plugins 114 | maven-shade-plugin 115 | 1.6 116 | 117 | true 118 | true 119 | 120 | 121 | io.netty:netty 122 | commons-logging:* 123 | net.opentsdb:opentsdb 124 | com.stumbleupon:async 125 | org.apache.zookeeper:zookeeper 126 | org.hbase:asynchbase 127 | com.google.protobuf:protobuf 128 | com.google.gwt:gwt-user 129 | 130 | 131 | 132 | 133 | 134 | *:* 135 | 136 | META-INF/*.SF 137 | META-INF/*.DSA 138 | META-INF/*.RSA 139 | 140 | 141 | 142 | net.opentsdb:opentsdb 143 | 144 | ** 145 | 146 | 147 | 148 | 149 | 151 | reference.conf 152 | 153 | 154 | 155 | 156 | 157 | package 158 | 159 | shade 160 | 161 | 162 | 163 | 164 | 165 | eu.somatik.serviceloader-maven-plugin 166 | serviceloader-maven-plugin 167 | 1.0.2 168 | 169 | 170 | net.opentsdb.search.SearchPlugin 171 | 172 | 173 | 174 | 175 | 176 | generate 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | org.codehaus.mojo 185 | cobertura-maven-plugin 186 | 2.7 187 | 188 | xml 189 | 256m 190 | 191 | true 192 | 193 | 194 | 195 | 196 | org.eluder.coveralls 197 | coveralls-maven-plugin 198 | 4.3.0 199 | 200 | ${repoToken} 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | org.sonatype.oss 209 | oss-parent 210 | 7 211 | 212 | 213 | -------------------------------------------------------------------------------- /schemas/mapped_and_analyzed/annotation_map.json: -------------------------------------------------------------------------------- 1 | { 2 | "annotation": { 3 | "properties": { 4 | "tsuid": { 5 | "type": "string", 6 | "index": "not_analyzed" 7 | } 8 | } 9 | } 10 | } -------------------------------------------------------------------------------- /schemas/mapped_and_analyzed/opentsdb_index.json: -------------------------------------------------------------------------------- 1 | { 2 | "settings":{ 3 | "analysis": { 4 | "analyzer": { 5 | "metricname":{ 6 | "type": "custom", 7 | "tokenizer": "keyword", 8 | "filter": [ "lowercase" ] 9 | } 10 | } 11 | } 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /schemas/mapped_and_analyzed/tsmeta_map.json: -------------------------------------------------------------------------------- 1 | { 2 | "tsmeta": { 3 | "properties": { 4 | "tsuid": { 5 | "type": "string", 6 | "index": "not_analyzed" 7 | }, 8 | "metric": { 9 | "properties": { 10 | "name": { 11 | "type": "string", 12 | "analyzer": "metricname" 13 | } 14 | } 15 | }, 16 | "tags": { 17 | "properties": { 18 | "uid": { 19 | "type": "string", 20 | "index": "not_analyzed" 21 | }, 22 | "name": { 23 | "type": "string", 24 | "analyzer": "metricname" 25 | } 26 | } 27 | }, 28 | "keys": { 29 | "properties": { 30 | "uid": { 31 | "type": "string", 32 | "index": "not_analyzed" 33 | }, 34 | "name": { 35 | "type": "string", 36 | "analyzer": "metricname" 37 | } 38 | } 39 | }, 40 | "values": { 41 | "properties": { 42 | "uid": { 43 | "type": "string", 44 | "index": "not_analyzed" 45 | }, 46 | "name": { 47 | "type": "string", 48 | "analyzer": "metricname" 49 | } 50 | } 51 | }, 52 | "kv_map": { 53 | "type": "string", 54 | "analyzer": "metricname" 55 | }, 56 | "kv_map_name": { 57 | "type": "string", 58 | "analyzer": "metricname" 59 | } 60 | } 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /schemas/mapped_and_analyzed/uidmeta_map.json: -------------------------------------------------------------------------------- 1 | { 2 | "uidmeta": { 3 | "properties": { 4 | "uid": { 5 | "type": "string", 6 | "index": "not_analyzed" 7 | }, 8 | "name": { 9 | "type": "string", 10 | "analyzer": "metricname" 11 | } 12 | } 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /schemas/simple/annotation_map.json: -------------------------------------------------------------------------------- 1 | { 2 | "annotation": { 3 | "properties": { 4 | "tsuid": { 5 | "type": "string", 6 | "index": "not_analyzed" 7 | } 8 | } 9 | } 10 | } -------------------------------------------------------------------------------- /schemas/simple/tsmeta_map.json: -------------------------------------------------------------------------------- 1 | { 2 | "tsmeta": { 3 | "properties": { 4 | "tsuid": { 5 | "type": "string", 6 | "index": "not_analyzed" 7 | }, 8 | "metric": { 9 | "properties": { 10 | "name": { 11 | "type": "string", 12 | "index": "not_analyzed" 13 | } 14 | } 15 | }, 16 | "tags": { 17 | "properties": { 18 | "uid": { 19 | "type": "string", 20 | "index": "not_analyzed" 21 | }, 22 | "name": { 23 | "type": "string", 24 | "index": "not_analyzed" 25 | } 26 | } 27 | } 28 | } 29 | } 30 | } -------------------------------------------------------------------------------- /schemas/simple/uidmeta_map.json: -------------------------------------------------------------------------------- 1 | { 2 | "uidmeta": { 3 | "properties": { 4 | "uid": { 5 | "type": "string", 6 | "index": "not_analyzed" 7 | }, 8 | "name": { 9 | "type": "string", 10 | "index": "not_analyzed" 11 | } 12 | } 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/main/java/net/opentsdb/search/ESPluginConfig.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2013 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search; 14 | 15 | import java.util.Map; 16 | 17 | import net.opentsdb.utils.Config; 18 | 19 | /** 20 | * Overloads the default Config class with defaults for the ElasticSearch plugin 21 | */ 22 | public final class ESPluginConfig extends Config { 23 | 24 | /** 25 | * Default constructor copies settings from the TSD 26 | * @param parent The TSD config to copy 27 | */ 28 | public ESPluginConfig(final Config parent) { 29 | super(parent); 30 | } 31 | 32 | /** 33 | * Loads default entries that were not provided by a file or command line 34 | */ 35 | @Override 36 | protected void setDefaults() { 37 | 38 | default_map.put("tsd.search.elasticsearch.hosts", ""); 39 | default_map.put("tsd.search.elasticsearch.index_threads", "1"); 40 | default_map.put("tsd.search.elasticsearch.index", "opentsdb"); 41 | default_map.put("tsd.search.elasticsearch.tsmeta_type", "tsmeta"); 42 | default_map.put("tsd.search.elasticsearch.uidmeta_type", "uidmeta"); 43 | default_map.put("tsd.search.elasticsearch.annotation_type", "annotation"); 44 | default_map.put("tsd.search.elasticsearch.pool.max_per_route", "25"); 45 | default_map.put("tsd.search.elasticsearch.pool.max_total", "50"); 46 | 47 | default_map.put("tsd.search.elasticsearch.schema.tsmeta", 48 | "net.opentsdb.search.schemas.tsmeta.DefaultTSMetaSchema"); 49 | default_map.put("tsd.search.elasticsearch.schema.uidmeta", 50 | "net.opentsdb.search.schemas.uidmeta.DefaultUIDMetaSchema"); 51 | default_map.put("tsd.search.elasticsearch.schema.annotation", 52 | "net.opentsdb.search.schemas.annotation.DefaultAnnotationSchema"); 53 | 54 | for (Map.Entry entry : default_map.entrySet()) { 55 | if (!properties.containsKey(entry.getKey())) 56 | properties.put(entry.getKey(), entry.getValue()); 57 | } 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /src/main/java/net/opentsdb/search/ElasticSearch.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2013-2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search; 14 | 15 | import java.io.IOException; 16 | import java.lang.reflect.Constructor; 17 | import java.lang.reflect.InvocationTargetException; 18 | import java.util.ArrayList; 19 | import java.util.HashMap; 20 | import java.util.List; 21 | 22 | import org.apache.http.HttpResponse; 23 | import org.apache.http.ParseException; 24 | import org.apache.http.client.config.RequestConfig; 25 | import org.apache.http.client.methods.HttpPost; 26 | import org.apache.http.concurrent.FutureCallback; 27 | import org.apache.http.config.ConnectionConfig; 28 | import org.apache.http.entity.ByteArrayEntity; 29 | import org.apache.http.impl.nio.client.CloseableHttpAsyncClient; 30 | import org.apache.http.impl.nio.client.HttpAsyncClients; 31 | import org.apache.http.impl.nio.conn.PoolingNHttpClientConnectionManager; 32 | import org.apache.http.impl.nio.reactor.DefaultConnectingIOReactor; 33 | import org.apache.http.impl.nio.reactor.IOReactorConfig; 34 | import org.apache.http.nio.reactor.ConnectingIOReactor; 35 | import org.apache.http.nio.reactor.IOReactorException; 36 | import org.apache.http.util.EntityUtils; 37 | import org.slf4j.Logger; 38 | import org.slf4j.LoggerFactory; 39 | 40 | import net.opentsdb.core.TSDB; 41 | import net.opentsdb.stats.StatsCollector; 42 | import net.opentsdb.meta.Annotation; 43 | import net.opentsdb.meta.TSMeta; 44 | import net.opentsdb.meta.UIDMeta; 45 | import net.opentsdb.search.SearchQuery.SearchType; 46 | import net.opentsdb.search.schemas.annotation.AnnotationSchema; 47 | import net.opentsdb.search.schemas.tsmeta.TSMetaSchema; 48 | import net.opentsdb.search.schemas.uidmeta.UIDMetaSchema; 49 | import net.opentsdb.utils.JSON; 50 | 51 | import org.hbase.async.Counter; 52 | 53 | import com.fasterxml.jackson.core.JsonParseException; 54 | import com.fasterxml.jackson.core.JsonParser; 55 | import com.fasterxml.jackson.core.JsonToken; 56 | import com.google.common.base.Strings; 57 | import com.stumbleupon.async.Deferred; 58 | 59 | public final class ElasticSearch extends SearchPlugin { 60 | private static final Logger LOG = LoggerFactory.getLogger(ElasticSearch.class); 61 | 62 | private CloseableHttpAsyncClient http_client; 63 | private String index = "opentsdb"; 64 | private boolean async_replication; 65 | private ESPluginConfig config = null; 66 | private String host; 67 | private TSMetaSchema ts_meta_schema; 68 | private UIDMetaSchema uid_meta_schema; 69 | private AnnotationSchema annotation_schema; 70 | 71 | final Counter queries_executed = new Counter(); 72 | 73 | /** 74 | * Default constructor 75 | */ 76 | public ElasticSearch() { 77 | 78 | } 79 | 80 | /** 81 | * Initializes the search plugin, setting up the HTTP client pool and config 82 | * options. 83 | * @param tsdb The TSDB to which we belong 84 | * @throws IllegalArgumentException if a config value is invalid 85 | * @throws NumberFormatException if a config value is invalid 86 | */ 87 | @Override 88 | public void initialize(final TSDB tsdb) { 89 | config = new ESPluginConfig(tsdb.getConfig()); 90 | 91 | host = config.getString("tsd.search.elasticsearch.host"); 92 | if (Strings.isNullOrEmpty(host)) { 93 | throw new IllegalArgumentException( 94 | "Missing config 'tsd.search.elasticsearch.host'"); 95 | } 96 | if (!host.toLowerCase().startsWith("http")) { 97 | host = "http://" + host; 98 | } 99 | 100 | // set index/types 101 | index = config.getString("tsd.search.elasticsearch.index"); 102 | if (Strings.isNullOrEmpty(index)) { 103 | throw new IllegalArgumentException("Missing config " 104 | + "'tsd.search.elasticsearch.index'"); 105 | } 106 | 107 | // TODO - configs for all these params 108 | final RequestConfig requestConfig = RequestConfig.custom() 109 | .setConnectTimeout(500) 110 | .setConnectionRequestTimeout(1000) 111 | .setSocketTimeout(5000) 112 | .build(); 113 | 114 | final ConnectionConfig connectionConfig = 115 | ConnectionConfig.custom().setBufferSize(8 * 1024) 116 | .setFragmentSizeHint(8 * 1024).build(); 117 | 118 | IOReactorConfig.Builder ioReactorConfigBuilder = IOReactorConfig.custom(); 119 | ioReactorConfigBuilder.setConnectTimeout(1000); 120 | ioReactorConfigBuilder.setInterestOpQueued(false); 121 | ioReactorConfigBuilder.setSelectInterval(100); 122 | ioReactorConfigBuilder.setShutdownGracePeriod(500L); 123 | ioReactorConfigBuilder.setSoKeepAlive(true); 124 | ioReactorConfigBuilder.setSoLinger(-1); 125 | ioReactorConfigBuilder.setSoReuseAddress(false); 126 | ioReactorConfigBuilder.setSoTimeout(1000); 127 | ioReactorConfigBuilder.setTcpNoDelay(false); 128 | 129 | try { 130 | final ConnectingIOReactor reactor = 131 | new DefaultConnectingIOReactor(ioReactorConfigBuilder.build()); 132 | final PoolingNHttpClientConnectionManager connManager = 133 | new PoolingNHttpClientConnectionManager(reactor); 134 | connManager.setMaxTotal( 135 | config.getInt("tsd.search.elasticsearch.pool.max_total")); 136 | connManager.setDefaultMaxPerRoute( 137 | config.getInt("tsd.search.elasticsearch.pool.max_per_route")); 138 | http_client = HttpAsyncClients.custom().setDefaultRequestConfig(requestConfig) 139 | .setDefaultConnectionConfig(connectionConfig) 140 | .setConnectionManager(connManager) 141 | .build(); 142 | 143 | http_client.start(); 144 | } catch (IOReactorException e) { 145 | throw new RuntimeException("Unable to create http client", e); 146 | } 147 | 148 | String schema = config.getString("tsd.search.elasticsearch.schema.tsmeta"); 149 | if (Strings.isNullOrEmpty(schema)) { 150 | LOG.info("Disabling TSMeta schema."); 151 | ts_meta_schema = null; 152 | } else { 153 | try { 154 | final Class clazz = Class.forName(schema); 155 | final Constructor ctor = clazz.getConstructor(ElasticSearch.class); 156 | ts_meta_schema = (TSMetaSchema) ctor.newInstance(this); 157 | } catch (ClassNotFoundException e) { 158 | throw new IllegalArgumentException("No TSMeta schema class found " 159 | + "for: " + schema); 160 | } catch (NoSuchMethodException e) { 161 | throw new IllegalArgumentException("TSMeta schema did not implement " 162 | + "the proper constructor. " + schema); 163 | } catch (SecurityException e) { 164 | throw new IllegalArgumentException("Unexpected security exception " 165 | + "loading TSMeta schema: " + schema, e); 166 | } catch (InstantiationException e) { 167 | throw new IllegalArgumentException("Unexpected exception instantiating " 168 | + "TSMeta schema: " + schema, e); 169 | } catch (IllegalAccessException e) { 170 | throw new IllegalArgumentException("Unexpected exception instantiating " 171 | + "TSMeta schema: " + schema, e); 172 | } catch (IllegalArgumentException e) { 173 | throw e; 174 | } catch (InvocationTargetException e) { 175 | throw new IllegalArgumentException("Unexpected exception instantiating " 176 | + "TSMeta schema: " + schema, e); 177 | } 178 | } 179 | 180 | schema = config.getString("tsd.search.elasticsearch.schema.uidmeta"); 181 | if (Strings.isNullOrEmpty(schema)) { 182 | LOG.info("Disabling UIDMeta schema."); 183 | uid_meta_schema = null; 184 | } else { 185 | try { 186 | final Class clazz = Class.forName(schema); 187 | final Constructor ctor = clazz.getConstructor(ElasticSearch.class); 188 | uid_meta_schema = (UIDMetaSchema) ctor.newInstance(this); 189 | } catch (ClassNotFoundException e) { 190 | throw new IllegalArgumentException("No UIDMeta schema class found " 191 | + "for: " + schema); 192 | } catch (NoSuchMethodException e) { 193 | throw new IllegalArgumentException("UIDMeta schema did not implement " 194 | + "the proper constructor. " + schema); 195 | } catch (SecurityException e) { 196 | throw new IllegalArgumentException("Unexpected security exception " 197 | + "loading UIDMeta schema: " + schema, e); 198 | } catch (InstantiationException e) { 199 | throw new IllegalArgumentException("Unexpected exception instantiating " 200 | + "UIDMeta schema: " + schema, e); 201 | } catch (IllegalAccessException e) { 202 | throw new IllegalArgumentException("Unexpected exception instantiating " 203 | + "UIDMeta schema: " + schema, e); 204 | } catch (IllegalArgumentException e) { 205 | throw e; 206 | } catch (InvocationTargetException e) { 207 | throw new IllegalArgumentException("Unexpected exception instantiating " 208 | + "UIDMeta schema: " + schema, e); 209 | } 210 | } 211 | 212 | schema = config.getString("tsd.search.elasticsearch.schema.annotation"); 213 | if (Strings.isNullOrEmpty(schema)) { 214 | LOG.info("Disabling Annotation schema."); 215 | annotation_schema = null; 216 | } else { 217 | try { 218 | final Class clazz = Class.forName(schema); 219 | final Constructor ctor = clazz.getConstructor(ElasticSearch.class); 220 | annotation_schema = (AnnotationSchema) ctor.newInstance(this); 221 | } catch (ClassNotFoundException e) { 222 | throw new IllegalArgumentException("No Annotation schema class found " 223 | + "for: " + schema); 224 | } catch (NoSuchMethodException e) { 225 | throw new IllegalArgumentException("Annotation schema did not implement " 226 | + "the proper constructor. " + schema); 227 | } catch (SecurityException e) { 228 | throw new IllegalArgumentException("Unexpected security exception " 229 | + "loading Annotation schema: " + schema, e); 230 | } catch (InstantiationException e) { 231 | throw new IllegalArgumentException("Unexpected exception instantiating " 232 | + "Annotation schema: " + schema, e); 233 | } catch (IllegalAccessException e) { 234 | throw new IllegalArgumentException("Unexpected exception instantiating " 235 | + "Annotation schema: " + schema, e); 236 | } catch (IllegalArgumentException e) { 237 | throw e; 238 | } catch (InvocationTargetException e) { 239 | throw new IllegalArgumentException("Unexpected exception instantiating " 240 | + "Annotation schema: " + schema, e); 241 | } 242 | } 243 | } 244 | 245 | @Override 246 | public Deferred indexTSMeta(final TSMeta meta) { 247 | if (ts_meta_schema != null) { 248 | return ts_meta_schema.index(meta); 249 | } 250 | return Deferred.fromResult(false); 251 | } 252 | 253 | public Deferred deleteTSMeta(final String tsuid) { 254 | if (ts_meta_schema != null) { 255 | return ts_meta_schema.delete(tsuid); 256 | } 257 | return Deferred.fromResult(false); 258 | } 259 | 260 | @Override 261 | public Deferred indexUIDMeta(final UIDMeta meta) { 262 | if (uid_meta_schema != null) { 263 | return uid_meta_schema.index(meta); 264 | } 265 | return Deferred.fromResult(false); 266 | } 267 | 268 | @Override 269 | public Deferred deleteUIDMeta(final UIDMeta meta) { 270 | if (uid_meta_schema != null) { 271 | return uid_meta_schema.delete(meta); 272 | } 273 | return Deferred.fromResult(false); 274 | } 275 | 276 | @Override 277 | public Deferred indexAnnotation(final Annotation note) { 278 | if (annotation_schema != null) { 279 | return annotation_schema.index(note); 280 | } 281 | return Deferred.fromResult(false); 282 | } 283 | 284 | @Override 285 | public Deferred deleteAnnotation(final Annotation note) { 286 | if (annotation_schema != null) { 287 | return annotation_schema.delete(note); 288 | } 289 | return Deferred.fromResult(false); 290 | } 291 | 292 | @Override 293 | public Deferred executeQuery(final SearchQuery query) { 294 | final Deferred result = new Deferred(); 295 | 296 | final StringBuilder uri = new StringBuilder(host); 297 | uri.append("/").append(index).append("/"); 298 | switch(query.getType()) { 299 | case TSMETA: 300 | case TSMETA_SUMMARY: 301 | case TSUIDS: 302 | uri.append(ts_meta_schema.docType()); 303 | break; 304 | case UIDMETA: 305 | uri.append(uid_meta_schema.docType()); 306 | break; 307 | case ANNOTATION: 308 | uri.append(annotation_schema.docType()); 309 | break; 310 | default: 311 | return Deferred.fromError(new IllegalArgumentException( 312 | "Unhandled query type: " + query.getType())); 313 | } 314 | uri.append("/_search"); 315 | 316 | // setup the query body 317 | HashMap body = new HashMap(3); 318 | body.put("size", query.getLimit()); 319 | body.put("from", query.getStartIndex()); 320 | 321 | HashMap qs = new HashMap(1); 322 | body.put("query", qs); 323 | HashMap query_string = new HashMap(1); 324 | query_string.put("query", query.getQuery()); 325 | qs.put("query_string", query_string); 326 | 327 | final HttpPost post = new HttpPost(uri.toString()); 328 | post.setEntity(new ByteArrayEntity(JSON.serializeToBytes(body))); 329 | 330 | http_client.execute(post, new SearchCB(query, result)); 331 | queries_executed.increment(); 332 | return result; 333 | } 334 | 335 | /** 336 | * Gracefully closes connections 337 | */ 338 | @Override 339 | public Deferred shutdown() { 340 | try { 341 | if (http_client != null) { 342 | http_client.close(); 343 | } 344 | return Deferred.fromResult(null); 345 | } catch (IOException e) { 346 | return Deferred.fromError(e); 347 | } 348 | } 349 | 350 | /** @return the version of this plugin */ 351 | public String version() { 352 | return "2.0.0"; 353 | } 354 | 355 | @Override 356 | public void collectStats(final StatsCollector collector) { 357 | if (ts_meta_schema != null) { 358 | collector.record("search.tsmeta_added", ts_meta_schema.added()); 359 | collector.record("search.tsmeta_deleted", ts_meta_schema.deleted()); 360 | collector.record("search.tsmeta_errors", ts_meta_schema.errors()); 361 | } 362 | 363 | if (uid_meta_schema != null) { 364 | collector.record("search.uid_added", uid_meta_schema.added()); 365 | collector.record("search.uid_deleted", uid_meta_schema.deleted()); 366 | collector.record("search.uid_errors", uid_meta_schema.errors()); 367 | } 368 | 369 | if (annotation_schema != null) { 370 | collector.record("search.annotation_added", annotation_schema.added()); 371 | collector.record("search.annotation_deleted", annotation_schema.deleted()); 372 | collector.record("search.annotation_errors", annotation_schema.errors()); 373 | } 374 | 375 | collector.record("search.queries_executed", queries_executed.get()); 376 | } 377 | 378 | public class SearchCB implements FutureCallback { 379 | 380 | final SearchQuery query; 381 | final Deferred result; 382 | 383 | public SearchCB(final SearchQuery query, final Deferred result) { 384 | this.query = query; 385 | this.result = result; 386 | } 387 | 388 | @Override 389 | public void cancelled() { 390 | result.callback(null); 391 | } 392 | 393 | @Override 394 | public void completed(final HttpResponse content) { 395 | try { 396 | JsonParser jp = JSON.parseToStream(EntityUtils.toString(content.getEntity())); 397 | if (jp == null) { 398 | LOG.warn("Query response was null or empty"); 399 | result.callback(null); 400 | return; 401 | } 402 | 403 | try { 404 | JsonToken next = jp.nextToken(); 405 | if (next != JsonToken.START_OBJECT) { 406 | LOG.error("Error: root should be object: quiting."); 407 | result.callback(null); 408 | return; 409 | } 410 | 411 | final List objects = new ArrayList(); 412 | 413 | // loop through the JSON structure 414 | String parent = ""; 415 | String last = ""; 416 | 417 | while (jp.nextToken() != null) { 418 | String fieldName = jp.getCurrentName(); 419 | if (fieldName != null) 420 | last = fieldName; 421 | 422 | if (jp.getCurrentToken() == JsonToken.START_ARRAY || 423 | jp.getCurrentToken() == JsonToken.START_OBJECT) 424 | parent = last; 425 | 426 | if (fieldName != null && fieldName.equals("_source")) { 427 | if (jp.nextToken() == JsonToken.START_OBJECT) { 428 | // parse depending on type 429 | switch (query.getType()) { 430 | case TSMETA: 431 | case TSMETA_SUMMARY: 432 | case TSUIDS: 433 | final TSMeta meta = jp.readValueAs(TSMeta.class); 434 | if (query.getType() == SearchType.TSMETA) { 435 | objects.add(meta); 436 | } else if (query.getType() == SearchType.TSUIDS) { 437 | objects.add(meta.getTSUID()); 438 | } else { 439 | final HashMap map = 440 | new HashMap(3); 441 | map.put("tsuid", meta.getTSUID()); 442 | map.put("metric", meta.getMetric().getName()); 443 | final HashMap tags = 444 | new HashMap(meta.getTags().size() / 2); 445 | int idx = 0; 446 | String name = ""; 447 | for (final UIDMeta uid : meta.getTags()) { 448 | if (idx % 2 == 0) { 449 | name = uid.getName(); 450 | } else { 451 | tags.put(name, uid.getName()); 452 | } 453 | idx++; 454 | } 455 | map.put("tags", tags); 456 | objects.add(map); 457 | } 458 | break; 459 | case UIDMETA: 460 | final UIDMeta uid = jp.readValueAs(UIDMeta.class); 461 | objects.add(uid); 462 | break; 463 | case ANNOTATION: 464 | final Annotation note = jp.readValueAs(Annotation.class); 465 | objects.add(note); 466 | break; 467 | } 468 | }else 469 | LOG.warn("Invalid _source value from ES, should have been a START_OBJECT"); 470 | } else if (fieldName != null && jp.getCurrentToken() != JsonToken.FIELD_NAME && 471 | parent.equals("hits") && fieldName.equals("total")){ 472 | LOG.trace("Total hits: [" + jp.getValueAsInt() + "]"); 473 | query.setTotalResults(jp.getValueAsInt()); 474 | } else if (fieldName != null && jp.getCurrentToken() != JsonToken.FIELD_NAME && 475 | fieldName.equals("took")){ 476 | LOG.trace("Time taken: [" + jp.getValueAsInt() + "]"); 477 | query.setTime(jp.getValueAsInt()); 478 | } 479 | 480 | query.setResults(objects); 481 | } 482 | 483 | result.callback(query); 484 | 485 | } catch (JsonParseException e) { 486 | LOG.error("Query failed", e); 487 | throw new RuntimeException(e); 488 | } catch (IOException e) { 489 | LOG.error("Query failed", e); 490 | throw new RuntimeException(e); 491 | } 492 | } catch (ParseException e1) { 493 | LOG.error("Query failed", e1); 494 | throw new RuntimeException(e1); 495 | } catch (IOException e1) { 496 | LOG.error("Query failed", e1); 497 | throw new RuntimeException(e1); 498 | } 499 | } 500 | 501 | @Override 502 | public void failed(final Exception e) { 503 | LOG.error("Query failed", e); 504 | throw new RuntimeException(e); 505 | } 506 | } 507 | 508 | public String host() { 509 | return host; 510 | } 511 | 512 | public String index() { 513 | return index; 514 | } 515 | 516 | public CloseableHttpAsyncClient httpClient() { 517 | return http_client; 518 | } 519 | 520 | public boolean asyncReplication() { 521 | return async_replication; 522 | } 523 | 524 | public ESPluginConfig config() { 525 | return config; 526 | } 527 | 528 | public TSMetaSchema tsMetaSchema() { 529 | return ts_meta_schema; 530 | } 531 | 532 | public UIDMetaSchema uidMetaSchema() { 533 | return uid_meta_schema; 534 | } 535 | 536 | public AnnotationSchema annotationSchema() { 537 | return annotation_schema; 538 | } 539 | } 540 | -------------------------------------------------------------------------------- /src/main/java/net/opentsdb/search/schemas/annotation/AnnotationSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.annotation; 14 | 15 | import java.io.IOException; 16 | import java.util.concurrent.CancellationException; 17 | 18 | import org.apache.http.HttpResponse; 19 | import org.apache.http.client.methods.HttpDelete; 20 | import org.apache.http.client.methods.HttpPost; 21 | import org.apache.http.concurrent.FutureCallback; 22 | import org.apache.http.entity.ByteArrayEntity; 23 | import org.apache.http.util.EntityUtils; 24 | import org.hbase.async.Counter; 25 | import org.slf4j.Logger; 26 | import org.slf4j.LoggerFactory; 27 | 28 | import com.google.common.base.Strings; 29 | import com.stumbleupon.async.Deferred; 30 | 31 | import net.opentsdb.meta.Annotation; 32 | import net.opentsdb.search.ElasticSearch; 33 | import net.opentsdb.utils.JSON; 34 | 35 | public abstract class AnnotationSchema { 36 | private static final Logger LOG = LoggerFactory.getLogger( 37 | AnnotationSchema.class); 38 | 39 | /** The parent plugin this belongs to. */ 40 | protected final ElasticSearch es; 41 | 42 | /** The type of document used for indexing. */ 43 | protected final String doc_type; 44 | 45 | /** Counters for stats */ 46 | protected final Counter added_ctr = new Counter(); 47 | protected final Counter deleted_ctr = new Counter(); 48 | protected final Counter errors_ctr = new Counter(); 49 | 50 | /** 51 | * Default ctor. All implementations must have this CTOR as we'll call that 52 | * based on the class given in the config. 53 | * @param es The plugin this schema belongs to. 54 | * @throws IllegalArgumentException if 'tsd.search.elasticsearch.annotation_type' 55 | * was null or empty. 56 | */ 57 | public AnnotationSchema(final ElasticSearch es) { 58 | this.es = es; 59 | doc_type = es.config().getString("tsd.search.elasticsearch.annotation_type"); 60 | if (Strings.isNullOrEmpty(doc_type)) { 61 | throw new IllegalArgumentException("Missing config " 62 | + "'tsd.search.elasticsearch.annotation_type'"); 63 | } 64 | } 65 | 66 | /** 67 | * Sends the data to the Elastic Search index. 68 | * @param note A non-null annotation object. 69 | * @return A deferred resolving to true on success or an 70 | * exception on failure. 71 | */ 72 | public Deferred index(final Annotation note) { 73 | if (note == null) { 74 | return Deferred.fromError(new IllegalArgumentException( 75 | "Annotation cannot be null.")); 76 | } 77 | final Deferred result = new Deferred(); 78 | 79 | final class AsyncCB implements FutureCallback { 80 | @Override 81 | public void cancelled() { 82 | result.callback(new CancellationException("Index call was cancelled.")); 83 | errors_ctr.increment(); 84 | } 85 | 86 | @Override 87 | public void completed(final HttpResponse content) { 88 | try { 89 | if (content.getStatusLine().getStatusCode() < 200 || 90 | content.getStatusLine().getStatusCode() > 299) { 91 | result.callback(new IllegalStateException("Unable to post annotation. " 92 | + "Status code: " + content.getStatusLine().getStatusCode() 93 | + " Content: " + EntityUtils.toString(content.getEntity()))); 94 | errors_ctr.increment(); 95 | } else { 96 | result.callback(true); 97 | added_ctr.increment(); 98 | } 99 | } catch (Exception e) { 100 | LOG.error("Unexpected exception parsing content", e); 101 | result.callback(e); 102 | } finally { 103 | try { 104 | EntityUtils.consume(content.getEntity()); 105 | } catch (IOException e) { } 106 | } 107 | } 108 | 109 | @Override 110 | public void failed(final Exception e) { 111 | result.callback(e); 112 | errors_ctr.increment(); 113 | } 114 | 115 | } 116 | 117 | final StringBuilder uri = new StringBuilder(es.host()) 118 | .append("/") 119 | .append(es.index()) 120 | .append("/") 121 | .append(doc_type) 122 | .append("/") 123 | .append(note.getStartTime()); 124 | if (!Strings.isNullOrEmpty(note.getTSUID())) { 125 | uri.append(note.getTSUID()); 126 | } 127 | if (es.asyncReplication()) { 128 | uri.append("?replication=async"); 129 | } 130 | 131 | final HttpPost post = new HttpPost(uri.toString()); 132 | post.setEntity(new ByteArrayEntity(JSON.serializeToBytes(note))); 133 | es.httpClient().execute(post, new AsyncCB()); 134 | return result; 135 | } 136 | 137 | /** 138 | * Deletes the data in the ES index. 139 | * @param note A non-null annotation object. 140 | * @return A deferred resolving to true on success or an 141 | * exception on failure. 142 | */ 143 | public Deferred delete(final Annotation note) { 144 | if (note == null) { 145 | return Deferred.fromError(new IllegalArgumentException( 146 | "Annotation cannot be null.")); 147 | } 148 | final Deferred result = new Deferred(); 149 | 150 | final class AsyncCB implements FutureCallback { 151 | @Override 152 | public void cancelled() { 153 | result.callback(new CancellationException("Index call was cancelled.")); 154 | errors_ctr.increment(); 155 | } 156 | 157 | @Override 158 | public void completed(final HttpResponse content) { 159 | try { 160 | if (content.getStatusLine().getStatusCode() < 200 || 161 | content.getStatusLine().getStatusCode() > 299) { 162 | result.callback(new IllegalStateException("Unable to post meta data. " 163 | + "Status code: " + content.getStatusLine().getStatusCode() 164 | + " Content: " + EntityUtils.toString(content.getEntity()))); 165 | errors_ctr.increment(); 166 | } else { 167 | result.callback(true); 168 | deleted_ctr.increment(); 169 | } 170 | } catch (Exception e) { 171 | LOG.error("Unexpected exception parsing content", e); 172 | result.callback(e); 173 | } finally { 174 | try { 175 | EntityUtils.consume(content.getEntity()); 176 | } catch (IOException e) { } 177 | } 178 | } 179 | 180 | @Override 181 | public void failed(final Exception e) { 182 | result.callback(e); 183 | errors_ctr.increment(); 184 | } 185 | 186 | } 187 | 188 | final StringBuilder uri = new StringBuilder(es.host()) 189 | .append("/") 190 | .append(es.index()) 191 | .append("/") 192 | .append(doc_type) 193 | .append("/") 194 | .append(note.getStartTime()); 195 | if (!Strings.isNullOrEmpty(note.getTSUID())) { 196 | uri.append(note.getTSUID()); 197 | } 198 | if (es.asyncReplication()) { 199 | uri.append("?replication=async"); 200 | } 201 | 202 | final HttpDelete delete = new HttpDelete(uri.toString()); 203 | es.httpClient().execute(delete, new AsyncCB()); 204 | return result; 205 | } 206 | 207 | /** @return The doc type configured in 'tsd.search.elasticsearch.annotation_type' */ 208 | public String docType() { 209 | return doc_type; 210 | } 211 | 212 | /** @return The successfully indexed doc counter value. */ 213 | public long added() { 214 | return added_ctr.get(); 215 | } 216 | 217 | /** @return The successfully deleted doc counter value. */ 218 | public long deleted() { 219 | return deleted_ctr.get(); 220 | } 221 | 222 | /** @return The count of operations throwing exceptions. */ 223 | public long errors() { 224 | return errors_ctr.get(); 225 | } 226 | 227 | } 228 | -------------------------------------------------------------------------------- /src/main/java/net/opentsdb/search/schemas/annotation/DefaultAnnotationSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.annotation; 14 | 15 | import net.opentsdb.search.ElasticSearch; 16 | 17 | /** 18 | * Default implementation of the {@link AnnotationSchema}. 19 | */ 20 | public class DefaultAnnotationSchema extends AnnotationSchema { 21 | 22 | /** 23 | * Default ctor. 24 | * @param es The plugin this schema belongs to. 25 | * @throws IllegalArgumentException if 'tsd.search.elasticsearch.annotation_type' 26 | * was null or empty. 27 | */ 28 | public DefaultAnnotationSchema(final ElasticSearch es) { 29 | super(es); 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/net/opentsdb/search/schemas/tsmeta/AnalyzedAndMappedTSMetaSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.tsmeta; 14 | 15 | import java.io.IOException; 16 | import java.util.concurrent.CancellationException; 17 | 18 | import org.apache.http.HttpResponse; 19 | import org.apache.http.client.methods.HttpPost; 20 | import org.apache.http.concurrent.FutureCallback; 21 | import org.apache.http.entity.ByteArrayEntity; 22 | import org.apache.http.util.EntityUtils; 23 | import org.slf4j.Logger; 24 | import org.slf4j.LoggerFactory; 25 | 26 | import com.stumbleupon.async.Deferred; 27 | 28 | import net.opentsdb.meta.TSMeta; 29 | import net.opentsdb.search.ElasticSearch; 30 | 31 | /** 32 | * Same as {@link DefaultTSMetaSchema} except it extends the information with 33 | * a map of tag/key values and analyzes in lower case using {@link TSMetaAugment}. 34 | * This will send a JSON object similar to: 35 | *

36 | * 

 37 |  * {
 38 |   "tsuid": "010101",
 39 |   "metric": {
 40 |     "uid": "01",
 41 |     "type": "METRIC",
 42 |     "name": "sys.cpu.user",
 43 |     "description": "",
 44 |     "notes": "",
 45 |     "created": 1500686742,
 46 |     "custom": null,
 47 |     "displayName": ""
 48 |   },
 49 |   "tags": [{
 50 |     "uid": "01",
 51 |     "type": "TAGK",
 52 |     "name": "host",
 53 |     "description": "",
 54 |     "notes": "",
 55 |     "created": 1500686742,
 56 |     "custom": null,
 57 |     "displayName": ""
 58 |   }, {
 59 |     "uid": "01",
 60 |     "type": "TAGV",
 61 |     "name": "web01",
 62 |     "description": "",
 63 |     "notes": "",
 64 |     "created": 1500686742,
 65 |     "custom": null,
 66 |     "displayName": ""
 67 |   }],
 68 |   "description": "",
 69 |   "notes": "",
 70 |   "created": 0,
 71 |   "units": "",
 72 |   "retention": 0,
 73 |   "max": "NaN",
 74 |   "min": "NaN",
 75 |   "displayName": "Testing",
 76 |   "dataType": "",
 77 |   "lastReceived": 0,
 78 |   "totalDatapoints": 0,
 79 |   "keys": [{
 80 |     "uid": "01",
 81 |     "type": "TAGK",
 82 |     "name": "host",
 83 |     "description": "",
 84 |     "notes": "",
 85 |     "created": 1500686742,
 86 |     "custom": null,
 87 |     "displayName": ""
 88 |   }],
 89 |   "values": [{
 90 |     "uid": "01",
 91 |     "type": "TAGV",
 92 |     "name": "web01",
 93 |     "description": "",
 94 |     "notes": "",
 95 |     "created": 1500686742,
 96 |     "custom": null,
 97 |     "displayName": ""
 98 |   }],
 99 |   "kv_map": ["TAGK_01=TAGV_01"],
100 |   "kv_map_name": ["TAGK_host=TAGV_web01"]
101 | }
102 |  *
103 | */ 104 | public class AnalyzedAndMappedTSMetaSchema extends TSMetaSchema { 105 | private static final Logger LOG = LoggerFactory.getLogger( 106 | AnalyzedAndMappedTSMetaSchema.class); 107 | 108 | /** 109 | * Default ctor. 110 | * @param es The plugin this schema belongs to. 111 | * @throws IllegalArgumentException if 'tsd.search.elasticsearch.tsmeta_type' 112 | * was null or empty. 113 | */ 114 | public AnalyzedAndMappedTSMetaSchema(final ElasticSearch es) { 115 | super(es); 116 | } 117 | 118 | @Override 119 | public Deferred index(final TSMeta meta) { 120 | if (meta == null) { 121 | return Deferred.fromError(new IllegalArgumentException( 122 | "Meta cannot be null.")); 123 | } 124 | final Deferred result = new Deferred(); 125 | 126 | final class AsyncCB implements FutureCallback { 127 | @Override 128 | public void cancelled() { 129 | result.callback(new CancellationException("Index call was cancelled.")); 130 | errors_ctr.increment(); 131 | } 132 | 133 | @Override 134 | public void completed(final HttpResponse content) { 135 | try { 136 | if (content.getStatusLine().getStatusCode() < 200 || 137 | content.getStatusLine().getStatusCode() > 299) { 138 | result.callback(new IllegalStateException("Unable to post meta data. " 139 | + "Status code: " + content.getStatusLine().getStatusCode() 140 | + " Content: " + EntityUtils.toString(content.getEntity()))); 141 | errors_ctr.increment(); 142 | } else { 143 | result.callback(true); 144 | added_ctr.increment(); 145 | } 146 | } catch (Exception e) { 147 | LOG.error("Unexpected exception parsing content", e); 148 | result.callback(e); 149 | } finally { 150 | try { 151 | EntityUtils.consume(content.getEntity()); 152 | } catch (IOException e) { } 153 | } 154 | } 155 | 156 | @Override 157 | public void failed(final Exception e) { 158 | result.callback(e); 159 | errors_ctr.increment(); 160 | } 161 | 162 | } 163 | 164 | final StringBuilder uri = new StringBuilder(es.host()) 165 | .append("/") 166 | .append(es.index()) 167 | .append("/") 168 | .append(doc_type) 169 | .append("/") 170 | .append(meta.getTSUID()); 171 | if (es.asyncReplication()) { 172 | uri.append("?replication=async"); 173 | } 174 | 175 | final HttpPost post = new HttpPost(uri.toString()); 176 | post.setEntity(new ByteArrayEntity(TSMetaAugment.serializeToBytes(meta))); 177 | es.httpClient().execute(post, new AsyncCB()); 178 | return result; 179 | } 180 | } 181 | -------------------------------------------------------------------------------- /src/main/java/net/opentsdb/search/schemas/tsmeta/DefaultTSMetaSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.tsmeta; 14 | 15 | import net.opentsdb.search.ElasticSearch; 16 | 17 | /** 18 | * Default implementation of the TS Meta Schema 19 | */ 20 | public class DefaultTSMetaSchema extends TSMetaSchema { 21 | 22 | /** 23 | * Default ctor. 24 | * @param es The plugin this schema belongs to. 25 | */ 26 | public DefaultTSMetaSchema(final ElasticSearch es) { 27 | super(es); 28 | } 29 | 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/net/opentsdb/search/schemas/tsmeta/TSMetaAugment.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.tsmeta; 14 | 15 | import java.io.ByteArrayOutputStream; 16 | import java.io.IOException; 17 | import java.util.ArrayList; 18 | 19 | import com.fasterxml.jackson.databind.ObjectMapper; 20 | import com.fasterxml.jackson.databind.node.ObjectNode; 21 | 22 | import net.opentsdb.meta.TSMeta; 23 | import net.opentsdb.meta.UIDMeta; 24 | import net.opentsdb.uid.UniqueId.UniqueIdType; 25 | import net.opentsdb.utils.JSON; 26 | 27 | /** 28 | * Helper function to add data to the base TSMeta when it is serialized to JSON. 29 | * 30 | * This method adds keys, values, kv_map and kv_map_name to the generated JSON 31 | * allowing for searches to find specific key/values by name/uid and to find 32 | * TSUIDs with specific key=value. 33 | * 34 | * keys: Array of normal UIDMeta objects only containing TAGK 35 | * values: Array of normal UIDMeta objects only containing TAGV 36 | * kv_map: Array of strings in the form TAGK_UID=TAGV_UID 37 | * kv_map_name: Array of strings in the form TAGK_keyname=TAGV_valuename 38 | * 39 | * Note: the tags object was not removed, this means keys/values is just 40 | * duplicate data. For search purposes tags should probably be removed. 41 | */ 42 | public class TSMetaAugment { 43 | public static final byte[] serializeToBytes(final TSMeta meta) { 44 | ArrayList keys = new ArrayList(); 45 | ArrayList values = new ArrayList(); 46 | ArrayList kv_map = new ArrayList(); 47 | ArrayList kv_map_name = new ArrayList(); 48 | 49 | String key = null; 50 | String key_name = null; 51 | String value = null; 52 | String value_name = null; 53 | for (UIDMeta m : meta.getTags()) { 54 | if (m.getType() == UniqueIdType.TAGK) { 55 | keys.add(m); 56 | key = "TAGK_" + m.getUID(); 57 | key_name = "TAGK_" + m.getName(); 58 | } else if (m.getType() == UniqueIdType.TAGV) { 59 | values.add(m); 60 | value = "TAGV_" + m.getUID(); 61 | value_name = "TAGV_" + m.getName(); 62 | } 63 | 64 | if (key != null && value != null) { 65 | kv_map.add(key + "=" + value); 66 | kv_map_name.add(key_name + "=" + value_name); 67 | key_name = value_name = key = value = null; 68 | } 69 | } 70 | 71 | ObjectMapper mapper = JSON.getMapper(); 72 | ObjectNode root = (ObjectNode) mapper.valueToTree(meta); 73 | 74 | root.put("keys", mapper.valueToTree(keys)); 75 | root.put("values", mapper.valueToTree(values)); 76 | root.put("kv_map", mapper.valueToTree(kv_map)); 77 | root.put("kv_map_name", mapper.valueToTree(kv_map_name)); 78 | 79 | try { 80 | ByteArrayOutputStream o = new ByteArrayOutputStream(); 81 | mapper.writeTree(mapper.getFactory().createGenerator(o), root); 82 | return o.toByteArray(); 83 | } catch (IOException e) { 84 | return new byte[0]; 85 | } 86 | } 87 | } 88 | -------------------------------------------------------------------------------- /src/main/java/net/opentsdb/search/schemas/tsmeta/TSMetaSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.tsmeta; 14 | 15 | import java.io.IOException; 16 | import java.util.concurrent.CancellationException; 17 | 18 | import org.apache.http.HttpResponse; 19 | import org.apache.http.client.methods.HttpDelete; 20 | import org.apache.http.client.methods.HttpPost; 21 | import org.apache.http.concurrent.FutureCallback; 22 | import org.apache.http.entity.ByteArrayEntity; 23 | import org.apache.http.util.EntityUtils; 24 | import org.hbase.async.Counter; 25 | import org.slf4j.Logger; 26 | import org.slf4j.LoggerFactory; 27 | 28 | import com.google.common.base.Strings; 29 | import com.stumbleupon.async.Deferred; 30 | 31 | import net.opentsdb.meta.TSMeta; 32 | import net.opentsdb.search.ElasticSearch; 33 | import net.opentsdb.utils.JSON; 34 | 35 | /** 36 | * Base class for the TSMeta schema. By default it writes the {@link TSMeta} 37 | * objects as is, expecting the "schema_simple" JSON outlines. 38 | * The default output will look similar to the following JSON: 39 | *

40 | * 

 41 |  * 
 42 | {
 43 |   "tsuid": "010101",
 44 |   "metric": {
 45 |     "uid": "01",
 46 |     "type": "METRIC",
 47 |     "name": "sys.cpu.user",
 48 |     "description": "",
 49 |     "notes": "",
 50 |     "created": 1500687516,
 51 |     "custom": null,
 52 |     "displayName": ""
 53 |   },
 54 |   "tags": [{
 55 |     "uid": "01",
 56 |     "type": "TAGK",
 57 |     "name": "host",
 58 |     "description": "",
 59 |     "notes": "",
 60 |     "created": 1500687516,
 61 |     "custom": null,
 62 |     "displayName": ""
 63 |   }, {
 64 |     "uid": "01",
 65 |     "type": "TAGV",
 66 |     "name": "web01",
 67 |     "description": "",
 68 |     "notes": "",
 69 |     "created": 1500687516,
 70 |     "custom": null,
 71 |     "displayName": ""
 72 |   }],
 73 |   "description": "",
 74 |   "notes": "",
 75 |   "created": 0,
 76 |   "units": "",
 77 |   "retention": 0,
 78 |   "max": "NaN",
 79 |   "min": "NaN",
 80 |   "displayName": "Testing",
 81 |   "dataType": "",
 82 |   "lastReceived": 0,
 83 |   "totalDatapoints": 0
 84 | }
 85 |  *
true on success or an 121 | * exception on failure. 122 | */ 123 | public Deferred index(final TSMeta meta) { 124 | if (meta == null) { 125 | return Deferred.fromError(new IllegalArgumentException( 126 | "Meta cannot be null.")); 127 | } 128 | final Deferred result = new Deferred(); 129 | 130 | final class AsyncCB implements FutureCallback { 131 | @Override 132 | public void cancelled() { 133 | result.callback(new CancellationException("Index call was cancelled.")); 134 | errors_ctr.increment(); 135 | } 136 | 137 | @Override 138 | public void completed(final HttpResponse content) { 139 | try { 140 | if (content.getStatusLine().getStatusCode() < 200 || 141 | content.getStatusLine().getStatusCode() > 299) { 142 | result.callback(new IllegalStateException("Unable to post meta data. " 143 | + "Status code: " + content.getStatusLine().getStatusCode() 144 | + " Content: " + EntityUtils.toString(content.getEntity()))); 145 | errors_ctr.increment(); 146 | } else { 147 | result.callback(true); 148 | added_ctr.increment(); 149 | } 150 | } catch (Exception e) { 151 | LOG.error("Unexpected exception parsing content", e); 152 | result.callback(e); 153 | } finally { 154 | try { 155 | EntityUtils.consume(content.getEntity()); 156 | } catch (IOException e) { } 157 | } 158 | } 159 | 160 | @Override 161 | public void failed(final Exception e) { 162 | result.callback(e); 163 | errors_ctr.increment(); 164 | } 165 | 166 | } 167 | 168 | final StringBuilder uri = new StringBuilder(es.host()) 169 | .append("/") 170 | .append(es.index()) 171 | .append("/") 172 | .append(doc_type) 173 | .append("/") 174 | .append(meta.getTSUID()); 175 | if (es.asyncReplication()) { 176 | uri.append("?replication=async"); 177 | } 178 | 179 | final HttpPost post = new HttpPost(uri.toString()); 180 | post.setEntity(new ByteArrayEntity(JSON.serializeToBytes(meta))); 181 | es.httpClient().execute(post, new AsyncCB()); 182 | return result; 183 | } 184 | 185 | /** 186 | * Deletes the meta data in Elastic Search using the TSUID. 187 | * @param tsuid A non-null and non-empty TSUID to remove. 188 | * @return A deferred resolving to true on success or an 189 | * exception on failure. 190 | */ 191 | public Deferred delete(final String tsuid) { 192 | if (Strings.isNullOrEmpty(tsuid)) { 193 | return Deferred.fromError(new IllegalArgumentException( 194 | "TSUID cannot be null or empty.")); 195 | } 196 | final Deferred result = new Deferred(); 197 | 198 | final class AsyncCB implements FutureCallback { 199 | @Override 200 | public void cancelled() { 201 | result.callback(new CancellationException("Index call was cancelled.")); 202 | errors_ctr.increment(); 203 | } 204 | 205 | @Override 206 | public void completed(final HttpResponse content) { 207 | try { 208 | if (content.getStatusLine().getStatusCode() < 200 || 209 | content.getStatusLine().getStatusCode() > 299) { 210 | result.callback(new IllegalStateException("Unable to post meta data. " 211 | + "Status code: " + content.getStatusLine().getStatusCode() 212 | + " Content: " + EntityUtils.toString(content.getEntity()))); 213 | errors_ctr.increment(); 214 | } else { 215 | result.callback(true); 216 | deleted_ctr.increment(); 217 | } 218 | } catch (Exception e) { 219 | LOG.error("Unexpected exception parsing content", e); 220 | result.callback(e); 221 | } finally { 222 | try { 223 | EntityUtils.consume(content.getEntity()); 224 | } catch (IOException e) { } 225 | } 226 | } 227 | 228 | @Override 229 | public void failed(final Exception e) { 230 | result.callback(e); 231 | errors_ctr.increment(); 232 | } 233 | 234 | } 235 | 236 | final StringBuilder uri = new StringBuilder(es.host()) 237 | .append("/") 238 | .append(es.index()) 239 | .append("/") 240 | .append(doc_type) 241 | .append("/") 242 | .append(tsuid); 243 | if (es.asyncReplication()) { 244 | uri.append("?replication=async"); 245 | } 246 | 247 | final HttpDelete delete = new HttpDelete(uri.toString()); 248 | 249 | es.httpClient().execute(delete, new AsyncCB()); 250 | return result; 251 | } 252 | 253 | /** @return The doc type configured in 'tsd.search.elasticsearch.tsmeta_type' */ 254 | public String docType() { 255 | return doc_type; 256 | } 257 | 258 | /** @return The successfully indexed doc counter value. */ 259 | public long added() { 260 | return added_ctr.get(); 261 | } 262 | 263 | /** @return The successfully deleted doc counter value. */ 264 | public long deleted() { 265 | return deleted_ctr.get(); 266 | } 267 | 268 | /** @return The count of operations throwing exceptions. */ 269 | public long errors() { 270 | return errors_ctr.get(); 271 | } 272 | 273 | } 274 | -------------------------------------------------------------------------------- /src/main/java/net/opentsdb/search/schemas/uidmeta/DefaultUIDMetaSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.uidmeta; 14 | 15 | import net.opentsdb.search.ElasticSearch; 16 | 17 | /** 18 | * Default implementation of the {@link UIDMetaSchema}. 19 | */ 20 | public class DefaultUIDMetaSchema extends UIDMetaSchema { 21 | 22 | /** 23 | * Default ctor. 24 | * @param es The plugin this schema belongs to. 25 | * @throws IllegalArgumentException if 'tsd.search.elasticsearch.uidmeta_type' 26 | * was null or empty. 27 | */ 28 | public DefaultUIDMetaSchema(final ElasticSearch es) { 29 | super(es); 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/net/opentsdb/search/schemas/uidmeta/UIDMetaSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.uidmeta; 14 | 15 | import java.io.IOException; 16 | import java.util.concurrent.CancellationException; 17 | 18 | import org.apache.http.HttpResponse; 19 | import org.apache.http.client.methods.HttpDelete; 20 | import org.apache.http.client.methods.HttpPost; 21 | import org.apache.http.concurrent.FutureCallback; 22 | import org.apache.http.entity.ByteArrayEntity; 23 | import org.apache.http.util.EntityUtils; 24 | import org.hbase.async.Counter; 25 | import org.slf4j.Logger; 26 | import org.slf4j.LoggerFactory; 27 | 28 | import com.google.common.base.Strings; 29 | import com.stumbleupon.async.Deferred; 30 | 31 | import net.opentsdb.meta.UIDMeta; 32 | import net.opentsdb.search.ElasticSearch; 33 | import net.opentsdb.utils.JSON; 34 | 35 | /** 36 | * Base class for the UIDMeta schema. By default it writes that UIDMeta object 37 | * as is, expecting the "simple schema" JSON outlines. 38 | */ 39 | public abstract class UIDMetaSchema { 40 | private static final Logger LOG = LoggerFactory.getLogger(UIDMetaSchema.class); 41 | 42 | /** The parent plugin this belongs to. */ 43 | protected final ElasticSearch es; 44 | 45 | /** The type of document used for indexing. */ 46 | protected final String doc_type; 47 | 48 | /** Counters for stats */ 49 | protected final Counter added_ctr = new Counter(); 50 | protected final Counter deleted_ctr = new Counter(); 51 | protected final Counter errors_ctr = new Counter(); 52 | 53 | /** 54 | * Default ctor. All implementations must have this CTOR as we'll call that 55 | * based on the class given in the config. 56 | * @param es The plugin this schema belongs to. 57 | * @throws IllegalArgumentException if 'tsd.search.elasticsearch.uidmeta_type' 58 | * was null or empty. 59 | */ 60 | public UIDMetaSchema(final ElasticSearch es) { 61 | this.es = es; 62 | doc_type = es.config().getString("tsd.search.elasticsearch.uidmeta_type"); 63 | if (Strings.isNullOrEmpty(doc_type)) { 64 | throw new IllegalArgumentException("Missing config " 65 | + "'tsd.search.elasticsearch.uidmeta_type'"); 66 | } 67 | } 68 | 69 | /** 70 | * Sends the data to the Elastic Search index. 71 | * @param meta A non-null meta object. 72 | * @return A deferred resolving to true on success or an 73 | * exception on failure. 74 | */ 75 | public Deferred index(final UIDMeta meta) { 76 | if (meta == null) { 77 | return Deferred.fromError(new IllegalArgumentException( 78 | "Meta cannot be null.")); 79 | } 80 | final Deferred result = new Deferred(); 81 | 82 | final class AsyncCB implements FutureCallback { 83 | @Override 84 | public void cancelled() { 85 | result.callback(new CancellationException("Index call was cancelled.")); 86 | errors_ctr.increment(); 87 | } 88 | 89 | @Override 90 | public void completed(final HttpResponse content) { 91 | try { 92 | if (content.getStatusLine().getStatusCode() < 200 || 93 | content.getStatusLine().getStatusCode() > 299) { 94 | result.callback(new IllegalStateException("Unable to post meta data. " 95 | + "Status code: " + content.getStatusLine().getStatusCode() 96 | + " Content: " + EntityUtils.toString(content.getEntity()))); 97 | errors_ctr.increment(); 98 | } else { 99 | result.callback(true); 100 | added_ctr.increment(); 101 | } 102 | } catch (Exception e) { 103 | LOG.error("Unexpected exception parsing content", e); 104 | result.callback(e); 105 | } finally { 106 | try { 107 | EntityUtils.consume(content.getEntity()); 108 | } catch (IOException e) { } 109 | } 110 | } 111 | 112 | @Override 113 | public void failed(final Exception e) { 114 | result.callback(e); 115 | errors_ctr.increment(); 116 | } 117 | 118 | } 119 | 120 | final StringBuilder uri = new StringBuilder(es.host()) 121 | .append("/") 122 | .append(es.index()) 123 | .append("/") 124 | .append(doc_type) 125 | .append("/") 126 | .append(meta.getUID()); 127 | if (es.asyncReplication()) { 128 | uri.append("?replication=async"); 129 | } 130 | 131 | final HttpPost post = new HttpPost(uri.toString()); 132 | post.setEntity(new ByteArrayEntity(JSON.serializeToBytes(meta))); 133 | es.httpClient().execute(post, new AsyncCB()); 134 | return result; 135 | } 136 | 137 | /** 138 | * Deletes the data in the ES index. 139 | * @param meta A non-null meta object. 140 | * @return A deferred resolving to true on success or an 141 | * exception on failure. 142 | */ 143 | public Deferred delete(final UIDMeta meta) { 144 | if (meta == null) { 145 | return Deferred.fromError(new IllegalArgumentException( 146 | "Meta cannot be null.")); 147 | } 148 | 149 | final Deferred result = new Deferred(); 150 | 151 | final class AsyncCB implements FutureCallback { 152 | @Override 153 | public void cancelled() { 154 | result.callback(new CancellationException("Index call was cancelled.")); 155 | errors_ctr.increment(); 156 | } 157 | 158 | @Override 159 | public void completed(final HttpResponse content) { 160 | try { 161 | if (content.getStatusLine().getStatusCode() < 200 || 162 | content.getStatusLine().getStatusCode() > 299) { 163 | result.callback(new IllegalStateException("Unable to post meta data. " 164 | + "Status code: " + content.getStatusLine().getStatusCode() 165 | + " Content: " + EntityUtils.toString(content.getEntity()))); 166 | errors_ctr.increment(); 167 | } else { 168 | result.callback(true); 169 | deleted_ctr.increment(); 170 | } 171 | } catch (Exception e) { 172 | LOG.error("Unexpected exception parsing content", e); 173 | result.callback(e); 174 | } finally { 175 | try { 176 | EntityUtils.consume(content.getEntity()); 177 | } catch (IOException e) { } 178 | } 179 | } 180 | 181 | @Override 182 | public void failed(final Exception e) { 183 | result.callback(e); 184 | errors_ctr.increment(); 185 | } 186 | 187 | } 188 | 189 | final StringBuilder uri = new StringBuilder(es.host()) 190 | .append("/") 191 | .append(es.index()) 192 | .append("/") 193 | .append(doc_type) 194 | .append("/") 195 | .append(meta.getUID()); 196 | if (es.asyncReplication()) { 197 | uri.append("?replication=async"); 198 | } 199 | 200 | final HttpDelete delete = new HttpDelete(uri.toString()); 201 | es.httpClient().execute(delete, new AsyncCB()); 202 | return result; 203 | } 204 | 205 | /** @return The doc type configured in 'tsd.search.elasticsearch.uidmeta_type' */ 206 | public String docType() { 207 | return doc_type; 208 | } 209 | 210 | /** @return The successfully indexed doc counter value. */ 211 | public long added() { 212 | return added_ctr.get(); 213 | } 214 | 215 | /** @return The successfully deleted doc counter value. */ 216 | public long deleted() { 217 | return deleted_ctr.get(); 218 | } 219 | 220 | /** @return The count of operations throwing exceptions. */ 221 | public long errors() { 222 | return errors_ctr.get(); 223 | } 224 | 225 | } 226 | -------------------------------------------------------------------------------- /src/test/java/net/opentsdb/search/TestESPluginConfig.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search; 14 | 15 | import static org.junit.Assert.assertEquals; 16 | 17 | import org.junit.Test; 18 | 19 | import net.opentsdb.utils.Config; 20 | 21 | public class TestESPluginConfig { 22 | 23 | @Test 24 | public void defaults() throws Exception { 25 | final ESPluginConfig config = new ESPluginConfig(new Config(false)); 26 | 27 | assertEquals("", config.getString("tsd.search.elasticsearch.hosts")); 28 | assertEquals(1, config.getInt("tsd.search.elasticsearch.index_threads")); 29 | assertEquals("opentsdb", config.getString("tsd.search.elasticsearch.index")); 30 | assertEquals("tsmeta", config.getString("tsd.search.elasticsearch.tsmeta_type")); 31 | assertEquals("uidmeta", config.getString("tsd.search.elasticsearch.uidmeta_type")); 32 | assertEquals("annotation", config.getString("tsd.search.elasticsearch.annotation_type")); 33 | assertEquals(25, config.getInt("tsd.search.elasticsearch.pool.max_per_route")); 34 | assertEquals(50, config.getInt("tsd.search.elasticsearch.pool.max_total")); 35 | 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /src/test/java/net/opentsdb/search/TestElasticSearch.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search; 14 | 15 | import static org.junit.Assert.assertEquals; 16 | import static org.junit.Assert.assertFalse; 17 | import static org.junit.Assert.assertNull; 18 | import static org.junit.Assert.assertTrue; 19 | import static org.junit.Assert.fail; 20 | import static org.mockito.Mockito.doThrow; 21 | import static org.mockito.Mockito.mock; 22 | import static org.mockito.Mockito.times; 23 | import static org.mockito.Mockito.verify; 24 | import static org.mockito.Mockito.when; 25 | 26 | import java.io.IOException; 27 | 28 | import org.apache.http.HttpResponse; 29 | import org.apache.http.StatusLine; 30 | import org.apache.http.entity.StringEntity; 31 | import org.apache.http.impl.nio.client.CloseableHttpAsyncClient; 32 | import org.apache.http.impl.nio.client.HttpAsyncClientBuilder; 33 | import org.apache.http.impl.nio.client.HttpAsyncClients; 34 | import org.apache.http.impl.nio.conn.PoolingNHttpClientConnectionManager; 35 | import org.junit.Before; 36 | import org.junit.Test; 37 | import org.junit.runner.RunWith; 38 | import org.powermock.api.mockito.PowerMockito; 39 | import org.powermock.core.classloader.annotations.PrepareForTest; 40 | import org.powermock.modules.junit4.PowerMockRunner; 41 | import org.powermock.reflect.Whitebox; 42 | 43 | import com.stumbleupon.async.Deferred; 44 | 45 | import net.opentsdb.core.TSDB; 46 | import net.opentsdb.meta.Annotation; 47 | import net.opentsdb.meta.TSMeta; 48 | import net.opentsdb.meta.UIDMeta; 49 | import net.opentsdb.search.schemas.annotation.AnnotationSchema; 50 | import net.opentsdb.search.schemas.annotation.DefaultAnnotationSchema; 51 | import net.opentsdb.search.schemas.tsmeta.DefaultTSMetaSchema; 52 | import net.opentsdb.search.schemas.tsmeta.TSMetaSchema; 53 | import net.opentsdb.search.schemas.uidmeta.DefaultUIDMetaSchema; 54 | import net.opentsdb.search.schemas.uidmeta.UIDMetaSchema; 55 | import net.opentsdb.uid.UniqueId.UniqueIdType; 56 | import net.opentsdb.utils.Config; 57 | 58 | @RunWith(PowerMockRunner.class) 59 | @PrepareForTest({ TSDB.class, ElasticSearch.class, HttpAsyncClients.class, 60 | PoolingNHttpClientConnectionManager.class }) 61 | public class TestElasticSearch { 62 | 63 | private TSDB tsdb; 64 | private Config config; 65 | private PoolingNHttpClientConnectionManager connection_manager; 66 | private HttpAsyncClientBuilder client_builder; 67 | private CloseableHttpAsyncClient client; 68 | private TSMetaSchema ts_meta_schema; 69 | private UIDMetaSchema uid_meta_schema; 70 | private AnnotationSchema annotation_schema; 71 | 72 | @Before 73 | public void before() throws Exception { 74 | tsdb = PowerMockito.mock(TSDB.class); 75 | config = new Config(false); 76 | connection_manager = mock(PoolingNHttpClientConnectionManager.class); 77 | client_builder = mock(HttpAsyncClientBuilder.class); 78 | client = mock(CloseableHttpAsyncClient.class); 79 | ts_meta_schema = mock(TSMetaSchema.class); 80 | uid_meta_schema = mock(UIDMetaSchema.class); 81 | annotation_schema = mock(AnnotationSchema.class); 82 | 83 | config.overrideConfig("tsd.search.elasticsearch.host", "localhost:9200"); 84 | 85 | when(tsdb.getConfig()).thenReturn(config); 86 | 87 | PowerMockito.mockStatic(HttpAsyncClients.class); 88 | when(HttpAsyncClients.custom()).thenReturn(client_builder); 89 | 90 | PowerMockito.whenNew(PoolingNHttpClientConnectionManager.class) 91 | .withAnyArguments().thenReturn(connection_manager); 92 | when(client_builder.build()).thenReturn(client); 93 | } 94 | 95 | @Test 96 | public void initialize() throws Exception { 97 | final ElasticSearch plugin = new ElasticSearch(); 98 | plugin.initialize(tsdb); 99 | 100 | verify(client, times(1)).start(); 101 | assertEquals("http://localhost:9200", plugin.host()); 102 | verify(connection_manager, times(1)).setMaxTotal( 103 | plugin.config().getInt("tsd.search.elasticsearch.pool.max_total")); 104 | verify(connection_manager, times(1)).setDefaultMaxPerRoute( 105 | plugin.config().getInt("tsd.search.elasticsearch.pool.max_per_route")); 106 | assertTrue(plugin.tsMetaSchema() instanceof DefaultTSMetaSchema); 107 | assertTrue(plugin.uidMetaSchema() instanceof DefaultUIDMetaSchema); 108 | assertTrue(plugin.annotationSchema() instanceof DefaultAnnotationSchema); 109 | } 110 | 111 | @Test 112 | public void initializeDisabledIndices() throws Exception { 113 | config.overrideConfig("tsd.search.elasticsearch.schema.tsmeta", null); 114 | config.overrideConfig("tsd.search.elasticsearch.schema.uidmeta", null); 115 | config.overrideConfig("tsd.search.elasticsearch.schema.annotation", null); 116 | final ElasticSearch plugin = new ElasticSearch(); 117 | plugin.initialize(tsdb); 118 | 119 | verify(client, times(1)).start(); 120 | assertEquals("http://localhost:9200", plugin.host()); 121 | verify(connection_manager, times(1)).setMaxTotal( 122 | plugin.config().getInt("tsd.search.elasticsearch.pool.max_total")); 123 | verify(connection_manager, times(1)).setDefaultMaxPerRoute( 124 | plugin.config().getInt("tsd.search.elasticsearch.pool.max_per_route")); 125 | assertNull(plugin.tsMetaSchema()); 126 | assertNull(plugin.uidMetaSchema()); 127 | assertNull(plugin.annotationSchema()); 128 | } 129 | 130 | @Test (expected = IllegalArgumentException.class) 131 | public void initializeNullHost() throws Exception { 132 | config.overrideConfig("tsd.search.elasticsearch.host", null); 133 | final ElasticSearch plugin = new ElasticSearch(); 134 | plugin.initialize(tsdb); 135 | } 136 | 137 | @Test (expected = IllegalArgumentException.class) 138 | public void initializeEmptyHost() throws Exception { 139 | config.overrideConfig("tsd.search.elasticsearch.host", ""); 140 | final ElasticSearch plugin = new ElasticSearch(); 141 | plugin.initialize(tsdb); 142 | } 143 | 144 | @Test (expected = IllegalArgumentException.class) 145 | public void initializeMisingIndex() throws Exception { 146 | config.overrideConfig("tsd.search.elasticsearch.index", ""); 147 | final ElasticSearch plugin = new ElasticSearch(); 148 | plugin.initialize(tsdb); 149 | } 150 | 151 | @Test (expected = IllegalArgumentException.class) 152 | public void initializeMisingTSmega() throws Exception { 153 | config.overrideConfig("tsd.search.elasticsearch.tsmeta_type", ""); 154 | final ElasticSearch plugin = new ElasticSearch(); 155 | plugin.initialize(tsdb); 156 | } 157 | 158 | @Test (expected = IllegalArgumentException.class) 159 | public void initializeMisingUIDMeta() throws Exception { 160 | config.overrideConfig("tsd.search.elasticsearch.uidmeta_type", ""); 161 | final ElasticSearch plugin = new ElasticSearch(); 162 | plugin.initialize(tsdb); 163 | } 164 | 165 | @Test (expected = IllegalArgumentException.class) 166 | public void initializeNoSuchClass() throws Exception { 167 | config.overrideConfig("tsd.search.elasticsearch.schema.tsmeta", 168 | "net.opentsdb.search.TestElasticSearch$NoSuchClass"); 169 | final ElasticSearch plugin = new ElasticSearch(); 170 | plugin.initialize(tsdb); 171 | } 172 | 173 | @Test (expected = IllegalArgumentException.class) 174 | public void initializeBadClassCtor() throws Exception { 175 | config.overrideConfig("tsd.search.elasticsearch.schema.tsmeta", 176 | "net.opentsdb.search.TestElasticSearch$BadSchema"); 177 | final ElasticSearch plugin = new ElasticSearch(); 178 | plugin.initialize(tsdb); 179 | } 180 | 181 | @Test 182 | public void indexTSMeta() throws Exception { 183 | final TSMeta meta = new TSMeta("010101"); 184 | meta.setDisplayName("Testing"); 185 | ElasticSearch plugin = new ElasticSearch(); 186 | Whitebox.setInternalState(plugin, "ts_meta_schema", ts_meta_schema); 187 | 188 | Deferred deferred = plugin.indexTSMeta(meta); 189 | verify(ts_meta_schema, times(1)).index(meta); 190 | assertNull(deferred); 191 | 192 | Whitebox.setInternalState(plugin, "ts_meta_schema", (TSMetaSchema) null); 193 | deferred = plugin.indexTSMeta(meta); 194 | verify(ts_meta_schema, times(1)).index(meta); 195 | assertFalse((Boolean) deferred.join()); 196 | } 197 | 198 | @Test 199 | public void deleteTSMeta() throws Exception { 200 | ElasticSearch plugin = new ElasticSearch(); 201 | Whitebox.setInternalState(plugin, "ts_meta_schema", ts_meta_schema); 202 | 203 | Deferred deferred = plugin.deleteTSMeta("010101"); 204 | verify(ts_meta_schema, times(1)).delete("010101"); 205 | assertNull(deferred); 206 | 207 | Whitebox.setInternalState(plugin, "ts_meta_schema", (TSMetaSchema) null); 208 | deferred = plugin.deleteTSMeta("010101"); 209 | verify(ts_meta_schema, times(1)).delete("010101"); 210 | assertFalse((Boolean) deferred.join()); 211 | } 212 | 213 | @Test 214 | public void indexUIDMeta() throws Exception { 215 | final UIDMeta meta = new UIDMeta(UniqueIdType.METRIC, "01"); 216 | meta.setDisplayName("Testing"); 217 | ElasticSearch plugin = new ElasticSearch(); 218 | Whitebox.setInternalState(plugin, "uid_meta_schema", uid_meta_schema); 219 | 220 | Deferred deferred = plugin.indexUIDMeta(meta); 221 | verify(uid_meta_schema, times(1)).index(meta); 222 | assertNull(deferred); 223 | 224 | Whitebox.setInternalState(plugin, "uid_meta_schema", (UIDMetaSchema) null); 225 | deferred = plugin.indexUIDMeta(meta); 226 | verify(uid_meta_schema, times(1)).index(meta); 227 | assertFalse((Boolean) deferred.join()); 228 | } 229 | 230 | @Test 231 | public void deleteUIDMeta() throws Exception { 232 | final UIDMeta meta = new UIDMeta(UniqueIdType.METRIC, "01"); 233 | meta.setDisplayName("Testing"); 234 | ElasticSearch plugin = new ElasticSearch(); 235 | Whitebox.setInternalState(plugin, "uid_meta_schema", uid_meta_schema); 236 | 237 | Deferred deferred = plugin.deleteUIDMeta(meta); 238 | verify(uid_meta_schema, times(1)).delete(meta); 239 | assertNull(deferred); 240 | 241 | Whitebox.setInternalState(plugin, "uid_meta_schema", (UIDMetaSchema) null); 242 | deferred = plugin.deleteUIDMeta(meta); 243 | verify(uid_meta_schema, times(1)).delete(meta); 244 | assertFalse((Boolean) deferred.join()); 245 | } 246 | 247 | @Test 248 | public void indexAnnotation() throws Exception { 249 | final Annotation note = new Annotation(); 250 | note.setTSUID("01010101"); 251 | ElasticSearch plugin = new ElasticSearch(); 252 | Whitebox.setInternalState(plugin, "annotation_schema", annotation_schema); 253 | 254 | Deferred deferred = plugin.indexAnnotation(note); 255 | verify(annotation_schema, times(1)).index(note); 256 | assertNull(deferred); 257 | 258 | Whitebox.setInternalState(plugin, "annotation_schema", (AnnotationSchema) null); 259 | deferred = plugin.indexAnnotation(note); 260 | verify(annotation_schema, times(1)).index(note); 261 | assertFalse((Boolean) deferred.join()); 262 | } 263 | 264 | @Test 265 | public void deleteAnnotation() throws Exception { 266 | final Annotation note = new Annotation(); 267 | note.setTSUID("01010101"); 268 | ElasticSearch plugin = new ElasticSearch(); 269 | Whitebox.setInternalState(plugin, "annotation_schema", annotation_schema); 270 | 271 | Deferred deferred = plugin.deleteAnnotation(note); 272 | verify(annotation_schema, times(1)).delete(note); 273 | assertNull(deferred); 274 | 275 | Whitebox.setInternalState(plugin, "annotation_schema", (AnnotationSchema) null); 276 | deferred = plugin.deleteAnnotation(note); 277 | verify(annotation_schema, times(1)).delete(note); 278 | assertFalse((Boolean) deferred.join()); 279 | } 280 | 281 | @Test 282 | public void shutdown() throws Exception { 283 | final ElasticSearch plugin = new ElasticSearch(); 284 | plugin.initialize(tsdb); 285 | 286 | assertNull(plugin.shutdown().join()); 287 | verify(client, times(1)).close(); 288 | 289 | doThrow(new IOException("Boo!")).when(client).close(); 290 | Deferred deferred = plugin.shutdown(); 291 | try { 292 | deferred.join(); 293 | fail("Expected IOException"); 294 | } catch (IOException e) { } 295 | } 296 | 297 | public static class BadSchema extends TSMetaSchema { 298 | 299 | public BadSchema(final ElasticSearch es, final long ignored) { 300 | super(es); 301 | } 302 | 303 | } 304 | 305 | /** 306 | * Helper to mock out a response. 307 | * @param status_code The status code to return. 308 | * @param json A non-null JSON string to return. Can be empty. 309 | * @return A mocked response. 310 | * @throws Exception If something goes pear shaped. 311 | */ 312 | public static HttpResponse mockResponse(final int status_code, 313 | final String json) 314 | throws Exception { 315 | final HttpResponse response = mock(HttpResponse.class); 316 | final StatusLine status_line = mock(StatusLine.class); 317 | when(status_line.getStatusCode()).thenReturn(status_code); 318 | when(response.getStatusLine()).thenReturn(status_line); 319 | when(response.getEntity()).thenReturn(new StringEntity(json)); 320 | return response; 321 | } 322 | } 323 | -------------------------------------------------------------------------------- /src/test/java/net/opentsdb/search/schemas/annotation/TestDefaultAnnotationSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.annotation; 14 | 15 | import static org.junit.Assert.assertEquals; 16 | import static org.junit.Assert.assertTrue; 17 | import static org.junit.Assert.fail; 18 | import static org.mockito.Matchers.any; 19 | import static org.mockito.Mockito.mock; 20 | import static org.mockito.Mockito.when; 21 | 22 | import java.util.concurrent.CancellationException; 23 | 24 | import org.apache.http.HttpResponse; 25 | import org.apache.http.client.methods.HttpPost; 26 | import org.apache.http.client.methods.HttpUriRequest; 27 | import org.apache.http.concurrent.FutureCallback; 28 | import org.apache.http.impl.nio.client.CloseableHttpAsyncClient; 29 | import org.apache.http.impl.nio.client.HttpAsyncClients; 30 | import org.apache.http.util.EntityUtils; 31 | import org.junit.Before; 32 | import org.junit.Test; 33 | import org.junit.runner.RunWith; 34 | import org.mockito.invocation.InvocationOnMock; 35 | import org.mockito.stubbing.Answer; 36 | import org.powermock.core.classloader.annotations.PrepareForTest; 37 | import org.powermock.modules.junit4.PowerMockRunner; 38 | 39 | import com.stumbleupon.async.Deferred; 40 | import com.stumbleupon.async.TimeoutException; 41 | 42 | import net.opentsdb.meta.Annotation; 43 | import net.opentsdb.search.ESPluginConfig; 44 | import net.opentsdb.search.ElasticSearch; 45 | import net.opentsdb.search.TestElasticSearch; 46 | import net.opentsdb.utils.Config; 47 | 48 | @RunWith(PowerMockRunner.class) 49 | @PrepareForTest({ ElasticSearch.class, HttpAsyncClients.class }) 50 | public class TestDefaultAnnotationSchema { 51 | private static final String HOST = "localhost:9092"; 52 | 53 | private ESPluginConfig config; 54 | private CloseableHttpAsyncClient client; 55 | private ElasticSearch es; 56 | private FutureCallback cb; 57 | private HttpUriRequest request; 58 | private Annotation note; 59 | private String index; 60 | private String doc_type; 61 | 62 | @SuppressWarnings("unchecked") 63 | @Before 64 | public void before() throws Exception { 65 | config = new ESPluginConfig(new Config(false)); 66 | client = mock(CloseableHttpAsyncClient.class); 67 | es = mock(ElasticSearch.class); 68 | note = new Annotation(); 69 | note.setTSUID("010101"); 70 | note.setDescription("Unit testing Dragonstone!"); 71 | note.setStartTime(1483228800); 72 | 73 | index = config.getString("tsd.search.elasticsearch.index"); 74 | doc_type = config.getString("tsd.search.elasticsearch.annotation_type"); 75 | 76 | when(es.httpClient()).thenReturn(client); 77 | when(es.host()).thenReturn(HOST); 78 | when(es.index()).thenReturn(index); 79 | when(es.config()).thenReturn(config); 80 | when(client.execute(any(HttpUriRequest.class), 81 | any(FutureCallback.class))) 82 | .thenAnswer(new Answer() { 83 | @Override 84 | public Void answer(InvocationOnMock invocation) throws Throwable { 85 | request = (HttpUriRequest) invocation.getArguments()[0]; 86 | cb = (FutureCallback) invocation.getArguments()[1]; 87 | return null; 88 | } 89 | }); 90 | } 91 | 92 | @Test 93 | public void ctor() { 94 | DefaultAnnotationSchema schema = new DefaultAnnotationSchema(es); 95 | assertEquals(doc_type, schema.docType()); 96 | 97 | config.overrideConfig("tsd.search.elasticsearch.annotation_type", null); 98 | try { 99 | new DefaultAnnotationSchema(es); 100 | fail("Expected IllegalArgumentException"); 101 | } catch (IllegalArgumentException e) { } 102 | } 103 | 104 | @Test 105 | public void index() throws Exception { 106 | final DefaultAnnotationSchema schema = new DefaultAnnotationSchema(es); 107 | Deferred deferred = schema.index(note); 108 | try { 109 | deferred.join(1); 110 | fail("Expected TimeoutException"); 111 | } catch (TimeoutException e) { } 112 | assertEquals(HOST + "/" + index + "/" + doc_type + "/1483228800010101", 113 | request.getURI().toString()); 114 | 115 | // good 116 | cb.completed(TestElasticSearch.mockResponse(204, "")); 117 | assertTrue((Boolean) deferred.join()); 118 | assertCounters(schema, 1, 0, 0); 119 | 120 | // good with async 121 | when(es.asyncReplication()).thenReturn(true); 122 | deferred = schema.index(note); 123 | assertEquals(HOST + "/" + index + "/" + doc_type 124 | + "/1483228800010101?replication=async", request.getURI().toString()); 125 | final String payload = EntityUtils.toString(((HttpPost) request) 126 | .getEntity()); 127 | assertTrue(payload.contains("\"description\":\"Unit testing Dragonstone!\"")); 128 | assertTrue(payload.contains("\"tsuid\":\"010101\"")); 129 | assertTrue(payload.contains("\"startTime\":1483228800")); 130 | 131 | // global 132 | note = new Annotation(); 133 | note.setDescription("Unit testing Dragonstone!"); 134 | note.setStartTime(1483228800); 135 | deferred = schema.index(note); 136 | assertEquals(HOST + "/" + index + "/" + doc_type 137 | + "/1483228800?replication=async", request.getURI().toString()); 138 | 139 | // bad 140 | deferred = schema.index(note); 141 | cb.completed(TestElasticSearch.mockResponse(500, "WTF?")); 142 | try { 143 | deferred.join(); 144 | fail("Expected IllegalStateException"); 145 | } catch (IllegalStateException e) { } 146 | assertCounters(schema, 1, 0, 1); 147 | 148 | // cancelled 149 | deferred = schema.index(note); 150 | cb.cancelled(); 151 | try { 152 | deferred.join(); 153 | fail("Expected CancellationException"); 154 | } catch (CancellationException e) { } 155 | assertCounters(schema, 1, 0, 2); 156 | 157 | // oopsies 158 | deferred = schema.index(note); 159 | cb.failed(new IllegalArgumentException("Boo!")); 160 | try { 161 | deferred.join(); 162 | fail("Expected IllegalArgumentException"); 163 | } catch (IllegalArgumentException e) { } 164 | assertCounters(schema, 1, 0, 3); 165 | 166 | deferred = schema.index(null); 167 | try { 168 | deferred.join(); 169 | fail("Expected IllegalArgumentException"); 170 | } catch (IllegalArgumentException e) { } 171 | } 172 | 173 | @Test 174 | public void delete() throws Exception { 175 | final DefaultAnnotationSchema schema = new DefaultAnnotationSchema(es); 176 | Deferred deferred = schema.delete(note); 177 | try { 178 | deferred.join(1); 179 | fail("Expected TimeoutException"); 180 | } catch (TimeoutException e) { } 181 | assertEquals(HOST + "/" + index + "/" + doc_type + "/1483228800010101", 182 | request.getURI().toString()); 183 | 184 | // good 185 | cb.completed(TestElasticSearch.mockResponse(204, "")); 186 | assertTrue((Boolean) deferred.join()); 187 | assertCounters(schema, 0, 1, 0); 188 | 189 | // good with async 190 | when(es.asyncReplication()).thenReturn(true); 191 | deferred = schema.delete(note); 192 | assertEquals(HOST + "/" + index + "/" + doc_type + 193 | "/1483228800010101?replication=async",request.getURI().toString()); 194 | 195 | // bad 196 | deferred = schema.delete(note); 197 | cb.completed(TestElasticSearch.mockResponse(500, "WTF?")); 198 | try { 199 | deferred.join(); 200 | fail("Expected IllegalStateException"); 201 | } catch (IllegalStateException e) { } 202 | assertCounters(schema, 0, 1, 1); 203 | 204 | // cancelled 205 | deferred = schema.delete(note); 206 | cb.cancelled(); 207 | try { 208 | deferred.join(); 209 | fail("Expected CancellationException"); 210 | } catch (CancellationException e) { } 211 | assertCounters(schema, 0, 1, 2); 212 | 213 | // oopsies 214 | deferred = schema.delete(note); 215 | cb.failed(new IllegalArgumentException("Boo!")); 216 | try { 217 | deferred.join(); 218 | fail("Expected IllegalArgumentException"); 219 | } catch (IllegalArgumentException e) { } 220 | assertCounters(schema, 0, 1, 3); 221 | 222 | deferred = schema.delete(null); 223 | try { 224 | deferred.join(); 225 | fail("Expected IllegalArgumentException"); 226 | } catch (IllegalArgumentException e) { } 227 | } 228 | 229 | void assertCounters(final AnnotationSchema schema, 230 | final long added, 231 | final long deleted, 232 | final long errors) { 233 | assertEquals(added, schema.added()); 234 | assertEquals(deleted, schema.deleted()); 235 | assertEquals(errors, schema.errors()); 236 | } 237 | } 238 | -------------------------------------------------------------------------------- /src/test/java/net/opentsdb/search/schemas/tsmeta/TestAnalyzedAndMappedTSMetaSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.tsmeta; 14 | 15 | import static org.junit.Assert.assertEquals; 16 | import static org.junit.Assert.assertTrue; 17 | import static org.junit.Assert.fail; 18 | import static org.mockito.Matchers.any; 19 | import static org.mockito.Mockito.mock; 20 | import static org.mockito.Mockito.when; 21 | 22 | import java.util.concurrent.CancellationException; 23 | 24 | import org.apache.http.HttpResponse; 25 | import org.apache.http.client.methods.HttpPost; 26 | import org.apache.http.client.methods.HttpUriRequest; 27 | import org.apache.http.concurrent.FutureCallback; 28 | import org.apache.http.impl.nio.client.CloseableHttpAsyncClient; 29 | import org.apache.http.impl.nio.client.HttpAsyncClients; 30 | import org.apache.http.util.EntityUtils; 31 | import org.junit.Before; 32 | import org.junit.Test; 33 | import org.junit.runner.RunWith; 34 | import org.mockito.invocation.InvocationOnMock; 35 | import org.mockito.stubbing.Answer; 36 | import org.powermock.core.classloader.annotations.PrepareForTest; 37 | import org.powermock.modules.junit4.PowerMockRunner; 38 | import org.powermock.reflect.Whitebox; 39 | 40 | import com.google.common.collect.Lists; 41 | import com.stumbleupon.async.Deferred; 42 | import com.stumbleupon.async.TimeoutException; 43 | 44 | import net.opentsdb.meta.TSMeta; 45 | import net.opentsdb.meta.UIDMeta; 46 | import net.opentsdb.search.ESPluginConfig; 47 | import net.opentsdb.search.ElasticSearch; 48 | import net.opentsdb.search.TestElasticSearch; 49 | import net.opentsdb.search.schemas.tsmeta.AnalyzedAndMappedTSMetaSchema; 50 | import net.opentsdb.search.schemas.tsmeta.TSMetaSchema; 51 | import net.opentsdb.uid.UniqueId.UniqueIdType; 52 | import net.opentsdb.utils.Config; 53 | 54 | @RunWith(PowerMockRunner.class) 55 | @PrepareForTest({ ElasticSearch.class, HttpAsyncClients.class }) 56 | public class TestAnalyzedAndMappedTSMetaSchema { 57 | private static final String HOST = "localhost:9092"; 58 | 59 | private ESPluginConfig config; 60 | private CloseableHttpAsyncClient client; 61 | private ElasticSearch es; 62 | private FutureCallback cb; 63 | private HttpUriRequest request; 64 | private TSMeta meta; 65 | private String index; 66 | private String doc_type; 67 | 68 | @SuppressWarnings("unchecked") 69 | @Before 70 | public void before() throws Exception { 71 | config = new ESPluginConfig(new Config(false)); 72 | client = mock(CloseableHttpAsyncClient.class); 73 | es = mock(ElasticSearch.class); 74 | meta = new TSMeta("010101"); 75 | meta.setDisplayName("Testing"); 76 | final UIDMeta metric = new UIDMeta(UniqueIdType.METRIC, new byte[] { 1 }, 77 | "sys.cpu.user"); 78 | Whitebox.setInternalState(meta, "metric", metric); 79 | final UIDMeta tagk = new UIDMeta(UniqueIdType.TAGK, new byte[] { 1 }, 80 | "host"); 81 | final UIDMeta tagv = new UIDMeta(UniqueIdType.TAGV, new byte[] { 1 }, 82 | "web01"); 83 | Whitebox.setInternalState(meta, "tags", Lists.newArrayList(tagk, tagv)); 84 | index = config.getString("tsd.search.elasticsearch.index"); 85 | doc_type = config.getString("tsd.search.elasticsearch.tsmeta_type"); 86 | 87 | when(es.httpClient()).thenReturn(client); 88 | when(es.host()).thenReturn(HOST); 89 | when(es.index()).thenReturn(index); 90 | when(es.config()).thenReturn(config); 91 | when(client.execute(any(HttpUriRequest.class), 92 | any(FutureCallback.class))) 93 | .thenAnswer(new Answer() { 94 | @Override 95 | public Void answer(InvocationOnMock invocation) throws Throwable { 96 | request = (HttpUriRequest) invocation.getArguments()[0]; 97 | cb = (FutureCallback) invocation.getArguments()[1]; 98 | return null; 99 | } 100 | }); 101 | } 102 | 103 | @Test 104 | public void ctor() { 105 | final AnalyzedAndMappedTSMetaSchema schema = 106 | new AnalyzedAndMappedTSMetaSchema(es); 107 | assertEquals(doc_type, schema.docType()); 108 | } 109 | 110 | @Test 111 | public void index() throws Exception { 112 | final AnalyzedAndMappedTSMetaSchema schema = new AnalyzedAndMappedTSMetaSchema(es); 113 | Deferred deferred = schema.index(meta); 114 | try { 115 | deferred.join(1); 116 | fail("Expected TimeoutException"); 117 | } catch (TimeoutException e) { } 118 | assertEquals(HOST + "/" + index + "/" + doc_type + "/010101", 119 | request.getURI().toString()); 120 | final String payload = EntityUtils.toString(((HttpPost) request) 121 | .getEntity()); 122 | System.out.println(payload); 123 | assertTrue(payload.contains("\"tsuid\":\"010101\"")); 124 | assertTrue(payload.contains("\"name\":\"sys.cpu.user\"")); 125 | assertTrue(payload.contains("\"name\":\"host\"")); 126 | assertTrue(payload.contains("\"name\":\"web01\"")); 127 | assertTrue(payload.contains("\"kv_map\":[\"TAGK_01=TAGV_01\"]")); 128 | assertTrue(payload.contains("\"kv_map_name\":[\"TAGK_host=TAGV_web01\"]")); 129 | assertTrue(payload.contains("\"keys\":[")); 130 | assertTrue(payload.contains("\"values\":[")); 131 | 132 | // good 133 | cb.completed(TestElasticSearch.mockResponse(204, "")); 134 | assertTrue((Boolean) deferred.join()); 135 | assertCounters(schema, 1, 0, 0); 136 | 137 | // good with async 138 | when(es.asyncReplication()).thenReturn(true); 139 | deferred = schema.index(meta); 140 | assertEquals(HOST + "/" + index + "/" + doc_type 141 | + "/010101?replication=async", request.getURI().toString()); 142 | 143 | // bad 144 | deferred = schema.index(meta); 145 | cb.completed(TestElasticSearch.mockResponse(500, "WTF?")); 146 | try { 147 | deferred.join(); 148 | fail("Expected IllegalStateException"); 149 | } catch (IllegalStateException e) { } 150 | assertCounters(schema, 1, 0, 1); 151 | 152 | // cancelled 153 | deferred = schema.index(meta); 154 | cb.cancelled(); 155 | try { 156 | deferred.join(); 157 | fail("Expected CancellationException"); 158 | } catch (CancellationException e) { } 159 | assertCounters(schema, 1, 0, 2); 160 | 161 | // oopsies 162 | deferred = schema.index(meta); 163 | cb.failed(new IllegalArgumentException("Boo!")); 164 | try { 165 | deferred.join(); 166 | fail("Expected IllegalArgumentException"); 167 | } catch (IllegalArgumentException e) { } 168 | assertCounters(schema, 1, 0, 3); 169 | 170 | deferred = schema.index(null); 171 | try { 172 | deferred.join(); 173 | fail("Expected IllegalArgumentException"); 174 | } catch (IllegalArgumentException e) { } 175 | } 176 | 177 | @Test 178 | public void delete() throws Exception { 179 | final AnalyzedAndMappedTSMetaSchema schema = new AnalyzedAndMappedTSMetaSchema(es); 180 | Deferred deferred = schema.delete("010101"); 181 | try { 182 | deferred.join(1); 183 | fail("Expected TimeoutException"); 184 | } catch (TimeoutException e) { } 185 | assertEquals(HOST + "/" + index + "/" + doc_type + "/010101", 186 | request.getURI().toString()); 187 | 188 | // good 189 | cb.completed(TestElasticSearch.mockResponse(204, "")); 190 | assertTrue((Boolean) deferred.join()); 191 | assertCounters(schema, 0, 1, 0); 192 | 193 | // good with async 194 | when(es.asyncReplication()).thenReturn(true); 195 | deferred = schema.delete("010101"); 196 | assertEquals(HOST + "/" + index + "/" + doc_type 197 | + "/010101?replication=async", request.getURI().toString()); 198 | 199 | // bad 200 | deferred = schema.delete("010101"); 201 | cb.completed(TestElasticSearch.mockResponse(500, "WTF?")); 202 | try { 203 | deferred.join(); 204 | fail("Expected IllegalStateException"); 205 | } catch (IllegalStateException e) { } 206 | assertCounters(schema, 0, 1, 1); 207 | 208 | // cancelled 209 | deferred = schema.delete("010101"); 210 | cb.cancelled(); 211 | try { 212 | deferred.join(); 213 | fail("Expected CancellationException"); 214 | } catch (CancellationException e) { } 215 | assertCounters(schema, 0, 1, 2); 216 | 217 | // oopsies 218 | deferred = schema.delete("010101"); 219 | cb.failed(new IllegalArgumentException("Boo!")); 220 | try { 221 | deferred.join(); 222 | fail("Expected IllegalArgumentException"); 223 | } catch (IllegalArgumentException e) { } 224 | assertCounters(schema, 0, 1, 3); 225 | 226 | deferred = schema.delete(null); 227 | try { 228 | deferred.join(); 229 | fail("Expected IllegalArgumentException"); 230 | } catch (IllegalArgumentException e) { } 231 | } 232 | 233 | void assertCounters(final TSMetaSchema schema, 234 | final long added, 235 | final long deleted, 236 | final long errors) { 237 | assertEquals(added, schema.added()); 238 | assertEquals(deleted, schema.deleted()); 239 | assertEquals(errors, schema.errors()); 240 | } 241 | } 242 | -------------------------------------------------------------------------------- /src/test/java/net/opentsdb/search/schemas/tsmeta/TestDefaultTSMetaSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.tsmeta; 14 | 15 | import static org.junit.Assert.assertEquals; 16 | import static org.junit.Assert.assertTrue; 17 | import static org.junit.Assert.fail; 18 | import static org.mockito.Matchers.any; 19 | import static org.mockito.Mockito.mock; 20 | import static org.mockito.Mockito.when; 21 | 22 | import java.util.concurrent.CancellationException; 23 | 24 | import org.apache.http.HttpResponse; 25 | import org.apache.http.client.methods.HttpPost; 26 | import org.apache.http.client.methods.HttpUriRequest; 27 | import org.apache.http.concurrent.FutureCallback; 28 | import org.apache.http.impl.nio.client.CloseableHttpAsyncClient; 29 | import org.apache.http.impl.nio.client.HttpAsyncClients; 30 | import org.apache.http.util.EntityUtils; 31 | import org.junit.Before; 32 | import org.junit.Test; 33 | import org.junit.runner.RunWith; 34 | import org.mockito.invocation.InvocationOnMock; 35 | import org.mockito.stubbing.Answer; 36 | import org.powermock.core.classloader.annotations.PrepareForTest; 37 | import org.powermock.modules.junit4.PowerMockRunner; 38 | import org.powermock.reflect.Whitebox; 39 | 40 | import com.google.common.collect.Lists; 41 | import com.stumbleupon.async.Deferred; 42 | import com.stumbleupon.async.TimeoutException; 43 | 44 | import net.opentsdb.meta.TSMeta; 45 | import net.opentsdb.meta.UIDMeta; 46 | import net.opentsdb.search.ESPluginConfig; 47 | import net.opentsdb.search.ElasticSearch; 48 | import net.opentsdb.search.TestElasticSearch; 49 | import net.opentsdb.search.schemas.tsmeta.DefaultTSMetaSchema; 50 | import net.opentsdb.search.schemas.tsmeta.TSMetaSchema; 51 | import net.opentsdb.uid.UniqueId.UniqueIdType; 52 | import net.opentsdb.utils.Config; 53 | 54 | @RunWith(PowerMockRunner.class) 55 | @PrepareForTest({ ElasticSearch.class, HttpAsyncClients.class }) 56 | public class TestDefaultTSMetaSchema { 57 | private static final String HOST = "localhost:9092"; 58 | 59 | private ESPluginConfig config; 60 | private CloseableHttpAsyncClient client; 61 | private ElasticSearch es; 62 | private FutureCallback cb; 63 | private HttpUriRequest request; 64 | private TSMeta meta; 65 | private String index; 66 | private String doc_type; 67 | 68 | @SuppressWarnings("unchecked") 69 | @Before 70 | public void before() throws Exception { 71 | config = new ESPluginConfig(new Config(false)); 72 | client = mock(CloseableHttpAsyncClient.class); 73 | es = mock(ElasticSearch.class); 74 | meta = new TSMeta("010101"); 75 | meta.setDisplayName("Testing"); 76 | final UIDMeta metric = new UIDMeta(UniqueIdType.METRIC, new byte[] { 1 }, 77 | "sys.cpu.user"); 78 | Whitebox.setInternalState(meta, "metric", metric); 79 | final UIDMeta tagk = new UIDMeta(UniqueIdType.TAGK, new byte[] { 1 }, 80 | "host"); 81 | final UIDMeta tagv = new UIDMeta(UniqueIdType.TAGV, new byte[] { 1 }, 82 | "web01"); 83 | Whitebox.setInternalState(meta, "tags", Lists.newArrayList(tagk, tagv)); 84 | index = config.getString("tsd.search.elasticsearch.index"); 85 | doc_type = config.getString("tsd.search.elasticsearch.tsmeta_type"); 86 | 87 | when(es.httpClient()).thenReturn(client); 88 | when(es.host()).thenReturn(HOST); 89 | when(es.index()).thenReturn(index); 90 | when(es.config()).thenReturn(config); 91 | when(client.execute(any(HttpUriRequest.class), 92 | any(FutureCallback.class))) 93 | .thenAnswer(new Answer() { 94 | @Override 95 | public Void answer(InvocationOnMock invocation) throws Throwable { 96 | request = (HttpUriRequest) invocation.getArguments()[0]; 97 | cb = (FutureCallback) invocation.getArguments()[1]; 98 | return null; 99 | } 100 | }); 101 | } 102 | 103 | @Test 104 | public void ctor() { 105 | DefaultTSMetaSchema schema = new DefaultTSMetaSchema(es); 106 | assertEquals(doc_type, schema.docType()); 107 | 108 | config.overrideConfig("tsd.search.elasticsearch.tsmeta_type", null); 109 | try { 110 | new DefaultTSMetaSchema(es); 111 | fail("Expected IllegalArgumentException"); 112 | } catch (IllegalArgumentException e) { } 113 | } 114 | 115 | @Test 116 | public void index() throws Exception { 117 | final DefaultTSMetaSchema schema = new DefaultTSMetaSchema(es); 118 | Deferred deferred = schema.index(meta); 119 | try { 120 | deferred.join(1); 121 | fail("Expected TimeoutException"); 122 | } catch (TimeoutException e) { } 123 | assertEquals(HOST + "/" + index + "/" + doc_type + "/010101", 124 | request.getURI().toString()); 125 | 126 | // good 127 | cb.completed(TestElasticSearch.mockResponse(204, "")); 128 | assertTrue((Boolean) deferred.join()); 129 | assertCounters(schema, 1, 0, 0); 130 | 131 | // good with async 132 | when(es.asyncReplication()).thenReturn(true); 133 | deferred = schema.index(meta); 134 | assertEquals(HOST + "/" + index + "/" + doc_type 135 | + "/010101?replication=async", request.getURI().toString()); 136 | final String payload = EntityUtils.toString(((HttpPost) request) 137 | .getEntity()); 138 | assertTrue(payload.contains("\"tsuid\":\"010101\"")); 139 | assertTrue(payload.contains("\"name\":\"sys.cpu.user\"")); 140 | assertTrue(payload.contains("\"name\":\"host\"")); 141 | assertTrue(payload.contains("\"name\":\"web01\"")); 142 | 143 | // bad 144 | deferred = schema.index(meta); 145 | cb.completed(TestElasticSearch.mockResponse(500, "WTF?")); 146 | try { 147 | deferred.join(); 148 | fail("Expected IllegalStateException"); 149 | } catch (IllegalStateException e) { } 150 | assertCounters(schema, 1, 0, 1); 151 | 152 | // cancelled 153 | deferred = schema.index(meta); 154 | cb.cancelled(); 155 | try { 156 | deferred.join(); 157 | fail("Expected CancellationException"); 158 | } catch (CancellationException e) { } 159 | assertCounters(schema, 1, 0, 2); 160 | 161 | // oopsies 162 | deferred = schema.index(meta); 163 | cb.failed(new IllegalArgumentException("Boo!")); 164 | try { 165 | deferred.join(); 166 | fail("Expected IllegalArgumentException"); 167 | } catch (IllegalArgumentException e) { } 168 | assertCounters(schema, 1, 0, 3); 169 | 170 | deferred = schema.index(null); 171 | try { 172 | deferred.join(); 173 | fail("Expected IllegalArgumentException"); 174 | } catch (IllegalArgumentException e) { } 175 | } 176 | 177 | @Test 178 | public void delete() throws Exception { 179 | final DefaultTSMetaSchema schema = new DefaultTSMetaSchema(es); 180 | Deferred deferred = schema.delete("010101"); 181 | try { 182 | deferred.join(1); 183 | fail("Expected TimeoutException"); 184 | } catch (TimeoutException e) { } 185 | assertEquals(HOST + "/" + index + "/" + doc_type + "/010101", 186 | request.getURI().toString()); 187 | 188 | // good 189 | cb.completed(TestElasticSearch.mockResponse(204, "")); 190 | assertTrue((Boolean) deferred.join()); 191 | assertCounters(schema, 0, 1, 0); 192 | 193 | // good with async 194 | when(es.asyncReplication()).thenReturn(true); 195 | deferred = schema.delete("010101"); 196 | assertEquals(HOST + "/" + index + "/" + doc_type 197 | + "/010101?replication=async", request.getURI().toString()); 198 | 199 | // bad 200 | deferred = schema.delete("010101"); 201 | cb.completed(TestElasticSearch.mockResponse(500, "WTF?")); 202 | try { 203 | deferred.join(); 204 | fail("Expected IllegalStateException"); 205 | } catch (IllegalStateException e) { } 206 | assertCounters(schema, 0, 1, 1); 207 | 208 | // cancelled 209 | deferred = schema.delete("010101"); 210 | cb.cancelled(); 211 | try { 212 | deferred.join(); 213 | fail("Expected CancellationException"); 214 | } catch (CancellationException e) { } 215 | assertCounters(schema, 0, 1, 2); 216 | 217 | // oopsies 218 | deferred = schema.delete("010101"); 219 | cb.failed(new IllegalArgumentException("Boo!")); 220 | try { 221 | deferred.join(); 222 | fail("Expected IllegalArgumentException"); 223 | } catch (IllegalArgumentException e) { } 224 | assertCounters(schema, 0, 1, 3); 225 | 226 | deferred = schema.delete(null); 227 | try { 228 | deferred.join(); 229 | fail("Expected IllegalArgumentException"); 230 | } catch (IllegalArgumentException e) { } 231 | } 232 | 233 | void assertCounters(final TSMetaSchema schema, 234 | final long added, 235 | final long deleted, 236 | final long errors) { 237 | assertEquals(added, schema.added()); 238 | assertEquals(deleted, schema.deleted()); 239 | assertEquals(errors, schema.errors()); 240 | } 241 | } 242 | -------------------------------------------------------------------------------- /src/test/java/net/opentsdb/search/schemas/uidmeta/TestDefaultUIDMetaSchema.java: -------------------------------------------------------------------------------- 1 | // This file is part of OpenTSDB. 2 | // Copyright (C) 2017 The OpenTSDB Authors. 3 | // 4 | // This program is free software: you can redistribute it and/or modify it 5 | // under the terms of the GNU Lesser General Public License as published by 6 | // the Free Software Foundation, either version 2.1 of the License, or (at your 7 | // option) any later version. This program is distributed in the hope that it 8 | // will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty 9 | // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser 10 | // General Public License for more details. You should have received a copy 11 | // of the GNU Lesser General Public License along with this program. If not, 12 | // see . 13 | package net.opentsdb.search.schemas.uidmeta; 14 | 15 | import static org.junit.Assert.assertEquals; 16 | import static org.junit.Assert.assertTrue; 17 | import static org.junit.Assert.fail; 18 | import static org.mockito.Matchers.any; 19 | import static org.mockito.Mockito.mock; 20 | import static org.mockito.Mockito.when; 21 | 22 | import java.util.concurrent.CancellationException; 23 | 24 | import org.apache.http.HttpResponse; 25 | import org.apache.http.client.methods.HttpPost; 26 | import org.apache.http.client.methods.HttpUriRequest; 27 | import org.apache.http.concurrent.FutureCallback; 28 | import org.apache.http.impl.nio.client.CloseableHttpAsyncClient; 29 | import org.apache.http.impl.nio.client.HttpAsyncClients; 30 | import org.apache.http.util.EntityUtils; 31 | import org.junit.Before; 32 | import org.junit.Test; 33 | import org.junit.runner.RunWith; 34 | import org.mockito.invocation.InvocationOnMock; 35 | import org.mockito.stubbing.Answer; 36 | import org.powermock.core.classloader.annotations.PrepareForTest; 37 | import org.powermock.modules.junit4.PowerMockRunner; 38 | 39 | import com.stumbleupon.async.Deferred; 40 | import com.stumbleupon.async.TimeoutException; 41 | 42 | import net.opentsdb.meta.UIDMeta; 43 | import net.opentsdb.search.ESPluginConfig; 44 | import net.opentsdb.search.ElasticSearch; 45 | import net.opentsdb.search.TestElasticSearch; 46 | import net.opentsdb.uid.UniqueId.UniqueIdType; 47 | import net.opentsdb.utils.Config; 48 | 49 | @RunWith(PowerMockRunner.class) 50 | @PrepareForTest({ ElasticSearch.class, HttpAsyncClients.class }) 51 | public class TestDefaultUIDMetaSchema { 52 | private static final String HOST = "localhost:9092"; 53 | 54 | private ESPluginConfig config; 55 | private CloseableHttpAsyncClient client; 56 | private ElasticSearch es; 57 | private FutureCallback cb; 58 | private HttpUriRequest request; 59 | private UIDMeta meta; 60 | private String index; 61 | private String doc_type; 62 | 63 | @SuppressWarnings("unchecked") 64 | @Before 65 | public void before() throws Exception { 66 | config = new ESPluginConfig(new Config(false)); 67 | client = mock(CloseableHttpAsyncClient.class); 68 | es = mock(ElasticSearch.class); 69 | meta = new UIDMeta(UniqueIdType.METRIC, new byte[] { 1 }, "sys.cpu.user"); 70 | index = config.getString("tsd.search.elasticsearch.index"); 71 | doc_type = config.getString("tsd.search.elasticsearch.uidmeta_type"); 72 | 73 | when(es.httpClient()).thenReturn(client); 74 | when(es.host()).thenReturn(HOST); 75 | when(es.index()).thenReturn(index); 76 | when(es.config()).thenReturn(config); 77 | when(client.execute(any(HttpUriRequest.class), 78 | any(FutureCallback.class))) 79 | .thenAnswer(new Answer() { 80 | @Override 81 | public Void answer(InvocationOnMock invocation) throws Throwable { 82 | request = (HttpUriRequest) invocation.getArguments()[0]; 83 | cb = (FutureCallback) invocation.getArguments()[1]; 84 | return null; 85 | } 86 | }); 87 | } 88 | 89 | @Test 90 | public void ctor() { 91 | DefaultUIDMetaSchema schema = new DefaultUIDMetaSchema(es); 92 | assertEquals(doc_type, schema.docType()); 93 | 94 | config.overrideConfig("tsd.search.elasticsearch.uidmeta_type", null); 95 | try { 96 | new DefaultUIDMetaSchema(es); 97 | fail("Expected IllegalArgumentException"); 98 | } catch (IllegalArgumentException e) { } 99 | } 100 | 101 | @Test 102 | public void index() throws Exception { 103 | final DefaultUIDMetaSchema schema = new DefaultUIDMetaSchema(es); 104 | Deferred deferred = schema.index(meta); 105 | try { 106 | deferred.join(1); 107 | fail("Expected TimeoutException"); 108 | } catch (TimeoutException e) { } 109 | assertEquals(HOST + "/" + index + "/" + doc_type + "/01", 110 | request.getURI().toString()); 111 | 112 | // good 113 | cb.completed(TestElasticSearch.mockResponse(204, "")); 114 | assertTrue((Boolean) deferred.join()); 115 | assertCounters(schema, 1, 0, 0); 116 | 117 | // good with async 118 | when(es.asyncReplication()).thenReturn(true); 119 | deferred = schema.index(meta); 120 | assertEquals(HOST + "/" + index + "/" + doc_type + "/01?replication=async", 121 | request.getURI().toString()); 122 | final String payload = EntityUtils.toString(((HttpPost) request) 123 | .getEntity()); 124 | assertTrue(payload.contains("\"uid\":\"01\"")); 125 | assertTrue(payload.contains("\"name\":\"sys.cpu.user\"")); 126 | 127 | // bad 128 | deferred = schema.index(meta); 129 | cb.completed(TestElasticSearch.mockResponse(500, "WTF?")); 130 | try { 131 | deferred.join(); 132 | fail("Expected IllegalStateException"); 133 | } catch (IllegalStateException e) { } 134 | assertCounters(schema, 1, 0, 1); 135 | 136 | // cancelled 137 | deferred = schema.index(meta); 138 | cb.cancelled(); 139 | try { 140 | deferred.join(); 141 | fail("Expected CancellationException"); 142 | } catch (CancellationException e) { } 143 | assertCounters(schema, 1, 0, 2); 144 | 145 | // oopsies 146 | deferred = schema.index(meta); 147 | cb.failed(new IllegalArgumentException("Boo!")); 148 | try { 149 | deferred.join(); 150 | fail("Expected IllegalArgumentException"); 151 | } catch (IllegalArgumentException e) { } 152 | assertCounters(schema, 1, 0, 3); 153 | 154 | deferred = schema.index(null); 155 | try { 156 | deferred.join(); 157 | fail("Expected IllegalArgumentException"); 158 | } catch (IllegalArgumentException e) { } 159 | } 160 | 161 | @Test 162 | public void delete() throws Exception { 163 | final DefaultUIDMetaSchema schema = new DefaultUIDMetaSchema(es); 164 | Deferred deferred = schema.delete(meta); 165 | try { 166 | deferred.join(1); 167 | fail("Expected TimeoutException"); 168 | } catch (TimeoutException e) { } 169 | assertEquals(HOST + "/" + index + "/" + doc_type + "/01", 170 | request.getURI().toString()); 171 | 172 | // good 173 | cb.completed(TestElasticSearch.mockResponse(204, "")); 174 | assertTrue((Boolean) deferred.join()); 175 | assertCounters(schema, 0, 1, 0); 176 | 177 | // good with async 178 | when(es.asyncReplication()).thenReturn(true); 179 | deferred = schema.delete(meta); 180 | assertEquals(HOST + "/" + index + "/" + doc_type + "/01?replication=async", 181 | request.getURI().toString()); 182 | 183 | // bad 184 | deferred = schema.delete(meta); 185 | cb.completed(TestElasticSearch.mockResponse(500, "WTF?")); 186 | try { 187 | deferred.join(); 188 | fail("Expected IllegalStateException"); 189 | } catch (IllegalStateException e) { } 190 | assertCounters(schema, 0, 1, 1); 191 | 192 | // cancelled 193 | deferred = schema.delete(meta); 194 | cb.cancelled(); 195 | try { 196 | deferred.join(); 197 | fail("Expected CancellationException"); 198 | } catch (CancellationException e) { } 199 | assertCounters(schema, 0, 1, 2); 200 | 201 | // oopsies 202 | deferred = schema.delete(meta); 203 | cb.failed(new IllegalArgumentException("Boo!")); 204 | try { 205 | deferred.join(); 206 | fail("Expected IllegalArgumentException"); 207 | } catch (IllegalArgumentException e) { } 208 | assertCounters(schema, 0, 1, 3); 209 | 210 | deferred = schema.delete(null); 211 | try { 212 | deferred.join(); 213 | fail("Expected IllegalArgumentException"); 214 | } catch (IllegalArgumentException e) { } 215 | } 216 | 217 | void assertCounters(final UIDMetaSchema schema, 218 | final long added, 219 | final long deleted, 220 | final long errors) { 221 | assertEquals(added, schema.added()); 222 | assertEquals(deleted, schema.deleted()); 223 | assertEquals(errors, schema.errors()); 224 | } 225 | } 226 | --------------------------------------------------------------------------------