├── .eslintrc ├── .gitignore ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── Makefile ├── README.md ├── graylog-dashboard.js ├── lib ├── graylog-api.js ├── handlers.js └── screen.js ├── package.json ├── screencast.gif └── tailgl.js /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "extends": "eslint:recommended", 4 | "rules": { 5 | "curly": [1, "multi-line"], 6 | "no-console": 0, 7 | "no-use-before-define": [1, "nofunc"], 8 | "no-underscore-dangle": 0, 9 | "no-unused-vars": [1, {"vars": "local", "args": "none"}], 10 | "new-cap": 0, 11 | "consistent-return": 0, 12 | "prefer-const": 1, 13 | "camelcase": 0, 14 | "dot-notation": 0, 15 | "semi": [1, "always"] 16 | }, 17 | env: { 18 | "node": true, 19 | "es6": true, 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | 1.0.0 2 | ----- 3 | 4 | * Stream ID no longer required to start; instead, use first stream. 5 | * Added Stream list to side of dash; use keys / mouse to switch streams. 6 | * Updated all deps (some were very out of date). 7 | * Main loop refactored to promises. 8 | * Simplified some internal APIs. 9 | * Removed need for credentials file (all arguments may be passed via args) 10 | * Added `--help` option. 11 | * Added `--cred-file-path` option. 12 | * Credentials file may now contain any option. 13 | * Added `--poll-interval` option (default `1000`). 14 | * Renamed `--host` to `--server-url`. 15 | * The user is now prompted for missing mandatory options, including password. 16 | 17 | 18 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Please follow [the instructions on graylog.org](https://www.graylog.org/contributing-to-graylog/). 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Mostly lifted from https://andreypopp.com/posts/2013-05-16-makefile-recipes-for-node-js.html 2 | # Thanks @andreypopp 3 | 4 | export BIN := $(shell npm bin) 5 | export NODE_ENV = test 6 | 7 | .PHONY: lint test 8 | 9 | lint: 10 | @$(BIN)/eslint lib/* 11 | 12 | test: $(BIN) 13 | echo "No test yet." 14 | exit 0 15 | 16 | node_modules/.bin: install 17 | 18 | define release 19 | VERSION=`node -pe "require('./package.json').version"` && \ 20 | NEXT_VERSION=`node -pe "require('semver').inc(\"$$VERSION\", '$(1)')"` && \ 21 | node -e "\ 22 | ['./package.json'].forEach(function(fileName) {\ 23 | var j = require(fileName);\ 24 | j.version = \"$$NEXT_VERSION\";\ 25 | var s = JSON.stringify(j, null, 2);\ 26 | require('fs').writeFileSync(fileName, s);\ 27 | });" && \ 28 | git add package.json CHANGELOG.md && \ 29 | git commit -m "release v$$NEXT_VERSION" && \ 30 | git tag "v$$NEXT_VERSION" -m "release v$$NEXT_VERSION" 31 | endef 32 | 33 | release-patch: test 34 | @$(call release,patch) 35 | 36 | release-minor: test 37 | @$(call release,minor) 38 | 39 | release-major: test 40 | @$(call release,major) 41 | 42 | publish: 43 | git push --tags origin HEAD:master 44 | npm publish 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # The Graylog CLI dashboard 2 | 3 | This is a [Graylog](http://www.graylog.org/) stream dashboard that runs in your shell. It is meant to be a perfect companion for example 4 | when performing a release on the main monitor and having the dashboard on the second monitor to keep an eye on errors and exceptions on 5 | your platform. 6 | 7 | ![screencast](https://github.com/Graylog2/cli-dashboard/blob/master/screencast.gif) 8 | 9 | The most important library we use is [blessed-contrib](https://github.com/yaronn/blessed-contrib) 10 | by [Yaron Naveh](https://twitter.com/YaronNaveh). Great job on that! 11 | 12 | **The dashboard should run on Linux and OSX.** Please report any issues in the [issue tracker](https://github.com/Graylog2/cli-dashboard/issues). 13 | 14 | ## Installation 15 | 16 | Install the dashboard: (You'll have to have [node.js](http://nodejs.org/download/) > 6.0 installed. 17 | Protip: It's in [homebrew](http://brew.sh) if you are on OSX.) 18 | 19 | $ npm install graylog-cli-dashboard -g 20 | 21 | View the options: 22 | 23 | $ graylog-dashboard --help 24 | Usage: graylog-dashboard.js [options] 25 | 26 | Rest API Options: 27 | --server-url (Deprecated; use api-host, path, port) Full Graylog API URL 28 | --api-host Graylog API Hostname 29 | --api-port Graylog API Port [default: 9000] 30 | --api-path Graylog API Path [default: "/api/"] 31 | --api-protocol Graylog API Protocol [default: "https"] 32 | --username Graylog API Username 33 | --password Graylog API Password 34 | 35 | Options: 36 | --stream-title Graylog Stream Title 37 | --poll-interval How often (in ms) to poll the Graylog server [default: 1000] 38 | --cred-file-path Path to an optional credentials file 39 | [default: "/Users/samuelreed/.graylog_dashboard"] 40 | --insecure If set, will not verify leaf certificates. 41 | --help Show help [boolean] 42 | 43 | Full example: 44 | 45 | $ graylog-dashboard --stream-title "Production Webservers" --api-host graylog.example.org 46 | 47 | Make sure to run this with a recent version (>= 4) of node.js. 48 | 49 | #### Credentials File 50 | 51 | If you wish, you may place a YAML file containing any of the above options at a path of your choosing. 52 | The default is `~/.graylog_dashboard`. For example: 53 | 54 | username: lennart 55 | password: sEcReT 56 | api-host: graylog.foo.com 57 | api-path: / 58 | api-port: 12900 59 | 60 | If you do not provide this file, and do not provide required data via command options, you will be prompted. 61 | 62 | #### Specifying a Stream 63 | 64 | Choose one from the list on the right side of the screen, or specify a `--stream-title` in the command. 65 | 66 | #### If the graylog-dashboard executable cannot be found 67 | 68 | You must have the `graylog-dashboard` executable that gets installed by NPM in your `PATH`. This is usually the case after installing 69 | NPM in the first place but the output of `npm install` should show you where it was installed if you cannot find it: 70 | 71 | /usr/local/share/npm/bin/graylog-dashboard -> /usr/local/share/npm/lib/node_modules/graylog-cli-dashboard/graylog-dashboard.js 72 | # In this OSX example graylog-dashboard has been linked to the graylog-dashboard.js file in /usr/local/share/npm/... 73 | # Execute /usr/local/share/npm/bin/graylog-dashboard to try it out 74 | 75 | ### The Dashboard in the Wild 76 | 77 | Because this stuff looks like it is from space we suspect that people like to show it. **Send us a photo of your dashboard running somewhere** 78 | and we are more than happy to publish it here. **Bonus points for messy desks or interesting stuff in the background.** 79 | 80 | ### Working with NPM 81 | 82 | This is a few helpful notes for all of us who do not regularly work with the node/NPM ecosystem and can't remember how to do stuff. 83 | 84 | #### Bumping and releasing a new version 85 | 86 | $ make version [major | minor | patch] 87 | $ make publish 88 | -------------------------------------------------------------------------------- /graylog-dashboard.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 'use strict'; 3 | 4 | /** 5 | * This file is part of Graylog2. 6 | * 7 | * Graylog2 is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * Graylog2 is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with Graylog2. If not, see . 19 | */ 20 | 21 | const Promise = require('bluebird'); 22 | const graylog = require('./lib/graylog-api'); 23 | const ui = require('./lib/screen'); 24 | const url = require('url'); 25 | const handlers = require('./lib/handlers'); 26 | const fs = require('fs'); 27 | const yaml = require('js-yaml'); 28 | const inquirer = require('inquirer'); 29 | const yargs = require('yargs') 30 | .usage('Usage: $0 [options]') 31 | .describe('stream-title', 'Graylog Stream Title') 32 | .alias('S','stream-title') 33 | .group(['server-url', 'api-host', 'api-port', 'api-path', 'api-protocol', 'username', 'password'], 'Rest API Options:') 34 | .describe('server-url', '(Deprecated; use api-host, path, port) Full Graylog API URL') 35 | .describe('api-host', 'Graylog API Hostname') 36 | .alias('H','api-host') 37 | .describe('api-port', 'Graylog API Port') 38 | .default('api-port', 9000) 39 | .describe('api-path', 'Graylog API Path') 40 | .default('api-path', '/api/') 41 | .describe('api-protocol', 'Graylog API Protocol') 42 | .alias('P','api-protocol') 43 | .default('api-protocol', 'https') 44 | .describe('poll-interval', 'How often (in ms) to poll the Graylog server') 45 | .default('poll-interval', 1000) 46 | .describe('username', 'Graylog API Username') 47 | .alias('u','username') 48 | .describe('password', 'Graylog API Password') 49 | .alias('p','password') 50 | .describe('sort', 'Stream Sorting') 51 | .default('sort','timestamp:desc') 52 | .describe('query', 'Query') 53 | .default('query','*') 54 | .alias('Q','query') 55 | .describe('fields', 'Fields') 56 | .default('fields','timestamp,message') 57 | .describe('range', 'Range in seconds') 58 | .default('range','86400') 59 | .describe('batch', 'events per request') 60 | .default('batch','50') 61 | .describe('cred-file-path', 'Path to an optional credentials file') 62 | .default('cred-file-path', `${process.env.HOME}/.graylog_dashboard`) 63 | .describe('insecure', 'If set, will not verify leaf certificates.') 64 | .help(); 65 | 66 | // Will contain: 67 | // username, password, host, streamID, pollInterval, credFilePath 68 | let config; 69 | 70 | function getOptions() { 71 | return Promise.try(function getOptionInput() { 72 | const {argv} = yargs; 73 | 74 | // Read user credentials. 75 | let fileConfig = {}; 76 | try { 77 | fileConfig = yaml.safeLoad(fs.readFileSync(argv['cred-file-path'], 'utf8')); 78 | } catch (err) { 79 | // Ignore, maybe everything was defined in argv 80 | } 81 | 82 | // Remove falsy values from argv to clean up merge. 83 | Object.keys(argv).forEach((k) => { 84 | if (!argv[k]) delete argv[k]; 85 | }); 86 | // Merge argv & file config. 87 | config = Object.assign({}, argv, fileConfig); 88 | 89 | if (config.insecure) process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0"; 90 | }) 91 | .then(function checkMissingOptions() { 92 | // Check mandatory config. 93 | const shouldPrompt = ['username', 'password'].filter((k) => !config[k]); 94 | 95 | // Prompt user for missing options. 96 | if (shouldPrompt.length) { 97 | const questions = shouldPrompt.map((k) => ( 98 | {name: k, message: `Please input ${k}:`, type: k === 'password' ? 'password' : 'input'} 99 | )); 100 | 101 | // Inquirer uses core `readline`. When activated, it automatically emits `line` and `keypress` events. 102 | // Built-in NodeJS `readline` uses `stream[Symbol('keypress-decoder')]` to mark this, but blessed 103 | // uses its own check. If both are running, we'll get double keypress events which makes working 104 | // the stream list very difficult. 105 | process.stdin._keypressDecoder = true; 106 | 107 | const prompt = inquirer.createPromptModule(); 108 | return prompt(questions) 109 | .then(function(result) { 110 | Object.assign(config, result); 111 | }); 112 | } 113 | }) 114 | .then(function coerceOptions() { 115 | config.sort = config['sort'] || "timestamp:desc"; 116 | // DEPRECATED: serverURL 117 | let fullURL = config.serverURL || config['server-url']; 118 | if (fullURL) { 119 | // Make sure we have a protocol (default: https) 120 | if (!/^\w+:\/\//.test(fullURL)) fullURL = 'https://' + fullURL; 121 | 122 | // Make sure we have a port (default REST API port is 9000) 123 | const parts = url.parse(fullURL); 124 | if (!parts.port) parts.port = 9000; 125 | if (!parts.path) parts.path = '/api/'; 126 | parts.href = parts.host = null; // otherwise url won't change when re-formatting 127 | config.serverURL = url.format(parts); 128 | } else if (config['api-host']) { 129 | config.serverURL = `${config['api-protocol']}://${config['api-host']}:${config['api-port']}${config['api-path']}`; 130 | } else { 131 | throw new Error('Either "server-url" or "api-host" must be defined!'); 132 | } 133 | return config; 134 | }); 135 | } 136 | 137 | let streams; // filled in after streams runs 138 | function storeStreams(_streams) { 139 | streams = _streams; 140 | if (!config.streamTitle) { 141 | // Could happen on startup 142 | config.streamTitle = streams[0].title; 143 | } 144 | const thisStream = streams.find((s) => s.title === config.streamTitle); 145 | config.streamID = thisStream.id; 146 | ui.flush(thisStream.title, streams); 147 | } 148 | 149 | function onStreamChange(blessedEl) { 150 | const streamTitle = blessedEl.content; 151 | config.streamTitle = streamTitle; 152 | config.streamID = streams.find((s) => s.title === streamTitle).id; 153 | ui.flush(streamTitle, streams); 154 | } 155 | 156 | function poll() { 157 | return Promise.all([ 158 | graylog.lastMessagesOfStream(config).then(handlers.updateMessagesList), 159 | graylog.streamThroughput(config).then(handlers.updateStreamThroughput), 160 | graylog.totalThroughput(config).then(handlers.updateTotalThroughputLine), 161 | graylog.streamAlerts(config).then(handlers.renderAlerts), 162 | ]) 163 | .then(() => ui.render()) // batch up renders 164 | .delay(config.pollInterval) 165 | .then(() => poll(config.streamID)); 166 | } 167 | 168 | // Entry 169 | getOptions() 170 | .then(graylog.getMetadata) 171 | .then(() => ui.create({onStreamChange})) 172 | .then(() => graylog.streams(config)) 173 | .tap(storeStreams) 174 | .then(handlers.updateStreamsList) 175 | .then(poll) 176 | .catch((e) => { ui.screen && ui.screen.destroy(); console.error(e); process.exit(1); }); 177 | -------------------------------------------------------------------------------- /lib/graylog-api.js: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog2. 3 | * 4 | * Graylog2 is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog2 is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog2. If not, see . 16 | */ 17 | 18 | 19 | const Promise = require('bluebird'); 20 | const request = require('request'); 21 | const moment = require('moment'); 22 | Promise.promisifyAll(request); 23 | 24 | let GRAYLOG_META = null; 25 | 26 | module.exports = { 27 | 28 | streamAlerts(options) { 29 | const url = `${options.serverURL}streams/${options.streamID}/alerts/check`; 30 | 31 | return makeRequest({uri: url, json: true, auth: makeAuth(options)}) 32 | .then((response) => { 33 | return response.body; 34 | }) 35 | .catch((error) => { 36 | throw new Error('Could not get stream alerts. Error:' + error.message); 37 | }); 38 | }, 39 | 40 | lastMessagesOfStream(options) { 41 | var fields = options.fields.split(','); 42 | if (!fields.includes('_id')) { fields.unshift('_id'); } 43 | if (!fields.includes('timestamp')) { fields.unshift('timestamp'); } 44 | const parameters = { 45 | query: options.query, 46 | fields: fields.join(','), 47 | filter: "streams:" + options.streamID, 48 | sort: options.sort, 49 | limit: options.batch 50 | }; 51 | // Max via graylog API 52 | if (parameters.limit === Infinity) parameters.limit = 1e4; 53 | let url; 54 | if (options.last_timestamp) { 55 | url = `${options.serverURL}search/universal/absolute`; 56 | parameters.from = options.last_timestamp; 57 | parameters.to = moment().toISOString(); // now 58 | } 59 | else { 60 | url = `${options.serverURL}search/universal/relative`; 61 | parameters.range = options.range; 62 | } 63 | 64 | // In 2.3 / ElasticSearch > 5.5 this was changed to `stored_fields` 65 | // https://github.com/Graylog2/graylog2-server/issues/4042 66 | if (parseFloat(GRAYLOG_META.version) >= 2.3) { 67 | parameters.stored_fields = parameters.fields; 68 | delete parameters.fields; 69 | } 70 | 71 | return makeRequest({uri: url, json: true, qs: parameters, auth: makeAuth(options)}) 72 | .then((response) => { 73 | return response.body.messages.map((m) => m.message); 74 | }) 75 | .catch((error) => { 76 | throw new Error('Could not get stream messages. ' + error.message + '\n' + JSON.stringify(parameters)); 77 | }); 78 | }, 79 | 80 | streams(options) { 81 | const url = `${options.serverURL}streams`; 82 | 83 | return makeRequest({uri: url, json: true, auth: makeAuth(options)}) 84 | .then((response) => { 85 | return response.body.streams 86 | .sort((a, b) => a.title.localeCompare(b.title)); 87 | }) 88 | .catch((error) => { 89 | throw new Error('Could not get streams. ' + error.message); 90 | }); 91 | }, 92 | 93 | streamThroughput(options) { 94 | const url = `${options.serverURL}system/metrics/org.graylog2.plugin.streams.Stream.${options.streamID}.incomingMessages.1-sec-rate`; 95 | 96 | return makeRequest({uri: url, json: true, auth: makeAuth(options)}) 97 | .then((response) => { 98 | return response.body.value; 99 | }) 100 | .catch((error) => { 101 | throw new Error('Could not get stream throughput. ' + error.message); 102 | }); 103 | }, 104 | 105 | totalThroughput(options) { 106 | const url = `${options.serverURL}system/throughput`; 107 | 108 | return makeRequest({uri: url, json: true, auth: makeAuth(options)}) 109 | .then((response) => { 110 | return response.body.throughput; 111 | }) 112 | .catch((error) => { 113 | throw new Error('Could not get stream total throughput. ' + error.message); 114 | }); 115 | }, 116 | 117 | getMetadata(options) { 118 | const url = `${options.serverURL}system`; 119 | return makeRequest({uri: url, json: true, auth: makeAuth(options)}) 120 | .then((response) => { 121 | GRAYLOG_META = response.body; 122 | return response.body; 123 | }) 124 | .catch((error) => { 125 | throw new Error('Could not get Graylog version. ' + error.message); 126 | }); 127 | } 128 | }; 129 | 130 | function makeRequest(options) { 131 | return request.getAsync(options) 132 | .then((response) => { 133 | if (response.statusCode < 200 || response.statusCode >= 400) { 134 | throw new Error(`Bad status code: ${response.statusCode} ${response.statusMessage} ${JSON.stringify(response.body || '')}`); 135 | } 136 | return response; 137 | }); 138 | } 139 | 140 | // TODO API Token? 141 | function makeAuth(options) { 142 | return {user: options.username, pass: options.password, sendImmediately: true}; 143 | } 144 | -------------------------------------------------------------------------------- /lib/handlers.js: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog2. 3 | * 4 | * Graylog2 is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog2 is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog2. If not, see . 16 | */ 17 | 18 | 19 | const moment = require('moment'); 20 | const ui = require('./screen'); 21 | 22 | const totalThroughputData = []; 23 | const streamThroughputData = []; 24 | 25 | module.exports = { 26 | 27 | updateMessagesList(messages) { 28 | const messageList = ui.getWidget('messageList'); 29 | 30 | const items = messages 31 | .sort((message1, message2) => new Date(message1.timestamp) - new Date(message2.timestamp)) 32 | .map((message) => `${moment(message.timestamp).format()} - ${message.message}`); 33 | 34 | messageList.setItems(items); 35 | }, 36 | 37 | updateTotalThroughputLine(throughput) { 38 | const throughputLine = ui.getWidget('totalThroughput'); 39 | 40 | // Manage local data array. 41 | if(totalThroughputData.length >= 300) { 42 | totalThroughputData.shift(); 43 | } 44 | totalThroughputData.push({x: moment().format("HH:mm"), y: throughput}); 45 | 46 | throughputLine.setData(transformLineData(totalThroughputData)); 47 | }, 48 | 49 | updateStreamThroughput(throughput) { 50 | if (!throughput) throughput = 0; 51 | // Update in title of log messages widget. 52 | const messageList = ui.getWidget('messageList'); 53 | const label = getWidgetLabel(messageList); 54 | messageList.setLabel(label.replace(/(Throughput: )(\d+)/, "$1" + throughput)); 55 | 56 | // Update in chart. 57 | const throughputLine = ui.getWidget('streamThroughput'); 58 | 59 | // Manage local data array. 60 | while(streamThroughputData.length >= 300) { 61 | streamThroughputData.shift(); 62 | } 63 | streamThroughputData.push({x: moment().format("HH:mm"), y: throughput}); 64 | 65 | throughputLine.setData(transformLineData(streamThroughputData)); 66 | }, 67 | 68 | updateStreamsList(streams) { 69 | const streamsList = ui.getWidget('streamsList'); 70 | streamsList.setItems(streams.map((s) => s.title)); 71 | streamsList.focus(); 72 | }, 73 | 74 | renderAlerts(alertList) { 75 | const alerts = ui.getWidget('alerts'); 76 | const lines = []; 77 | 78 | if(alertList.total_triggered == 0) { 79 | lines.push(""); // Empty line as padding. 80 | lines.push("{center}{green-fg}No active alerts for this stream!{/green-fg}{/center}"); 81 | } else { 82 | // Stream has active alerts! 83 | let msg; 84 | if (alertList.total_triggered == 1) { 85 | msg = "One active stream alert:"; 86 | } else { 87 | msg = "Multiple (" + alertList.total_triggered + ") active stream alerts:"; 88 | } 89 | 90 | lines.push(`{center}{red-bg}!! ${msg} !!{/red-bg}{/center}`); 91 | lines.push(""); 92 | 93 | // Add alerts to list. 94 | for(const i in alertList.results) { 95 | lines.push(buildAlertDescription(i, alertList.results[i])); 96 | } 97 | 98 | lines.push(""); 99 | lines.push("{center}Open your Graylog web interface for alert details.{/center}"); 100 | } 101 | 102 | alerts.setItems(lines); 103 | } 104 | }; 105 | 106 | // Blessed-contrib expects an object with x/y array datapoints. 107 | function transformLineData(dataArray) { 108 | return dataArray.reduce((memo, d) => { 109 | memo.x.push(d.x); 110 | memo.y.push(d.y); 111 | return memo; 112 | }, {x: [], y: []}); 113 | } 114 | 115 | function buildAlertDescription(i, alert) { 116 | return `{red-fg}#${i + 1}:{/red-fg} ${alert.condition.type} alert. (Condition created by ${alert.condition.creator_user_id})`; 117 | } 118 | 119 | // We can't just get the label from options, it'll be stale. 120 | function getWidgetLabel(widget) { 121 | return widget.children.find((c) => c._isLabel).content; 122 | } 123 | -------------------------------------------------------------------------------- /lib/screen.js: -------------------------------------------------------------------------------- 1 | var blessed = require("blessed"); 2 | /** 3 | * This file is part of Graylog2. 4 | * 5 | * Graylog2 is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * Graylog2 is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with Graylog2. If not, see . 17 | */ 18 | 19 | 20 | const contrib = require("blessed-contrib"); 21 | 22 | const positions = { 23 | // [row, col, rowSpan, colSpan] 24 | totalThroughput: [0, 2, 1, 2], 25 | alerts: [1, 2, 1, 2], 26 | streamThroughput: [0, 0, 2, 2], 27 | messageList: [2, 0, 2, 4], 28 | streamsList: [0, 4, 4, 1], 29 | }; 30 | const widgets = {}; 31 | 32 | module.exports = { 33 | 34 | create(options) { 35 | if (module.exports.screen) throw new Error('Screen already created!'); 36 | 37 | const screen = module.exports.screen = blessed.screen({ 38 | autoPadding: true, 39 | smartCSR: true, 40 | }); 41 | const grid = module.exports.grid = new contrib.grid({rows: 4, cols: 5, screen}); 42 | 43 | // Set up widgets. 44 | widgets.streamThroughput = grid.set(...positions.streamThroughput, contrib.line, { 45 | label: "Stream Throughput (max last 5 minutes)", 46 | style: { 47 | line: "red", 48 | text: "green", 49 | baseline: "white" 50 | }, 51 | showNthLabel: 60 52 | }); 53 | 54 | widgets.totalThroughput = grid.set(...positions.totalThroughput, contrib.line, { 55 | label: "Total Throughput (max last 5 minutes)", 56 | style: { 57 | line: "green", 58 | text: "green", 59 | baseline: "white" 60 | }, 61 | showNthLabel: 60 62 | }); 63 | 64 | widgets.alerts = grid.set(...positions.alerts, blessed.list, { 65 | label: "Alerts (30s cached)", 66 | tags: true, 67 | items: ["Loading ..."], 68 | mouse: true, 69 | scrollable: true 70 | }); 71 | 72 | widgets.messageList = grid.set(...positions.messageList, contrib.log, { 73 | fg: "green", 74 | selectedFg: "green", 75 | bufferLength: 50, 76 | label: "Messages (Throughput: 0/sec)" 77 | }); 78 | 79 | widgets.streamsList = grid.set(...positions.streamsList, blessed.list, { 80 | keys: true, 81 | fg: 'white', 82 | selectedFg: 'white', 83 | selectedBg: 'blue', 84 | interactive: true, 85 | label: 'Available Streams', 86 | mouse: true, 87 | border: {type: "line", fg: "cyan"}, 88 | style: { 89 | selected: { 90 | bg: 'green', 91 | bold: true, 92 | underline: true, 93 | } 94 | } 95 | }); 96 | 97 | widgets.streamsList.on('select', options.onStreamChange); 98 | 99 | screen.render(); 100 | 101 | screen.key(['escape', 'q', 'C-c'], function(ch, key) { 102 | return process.exit(0); 103 | }); 104 | }, 105 | 106 | flush(streamName, streams) { 107 | Object.keys(widgets).forEach((key) => { 108 | const w = widgets[key]; 109 | if (w === widgets.streamsList) { 110 | const titles = streams.map((s) => s.title); 111 | w.setItems(titles); 112 | w.select(titles.indexOf(streamName)); 113 | } else { 114 | if (w.setData) w.setData([{x: 0, y: 0}]); 115 | if (w.clearItems) w.clearItems(); 116 | } 117 | if (w === widgets.messageList || w === widgets.streamThroughput || w === widgets.alerts) { 118 | const {label} = w.options; 119 | label.replace(/ \(Stream: .*\)/, ''); 120 | w.setLabel(`${label} (Stream: ${streamName})`); 121 | } 122 | }); 123 | module.exports.render(); 124 | }, 125 | 126 | getWidget(name) { 127 | if (widgets[name]) return widgets[name]; 128 | throw new Error(`Invalid widget name: ${name}. Available widgets: ${Object.keys(widgets)}`); 129 | }, 130 | 131 | render() { 132 | module.exports.screen.render(); 133 | }, 134 | }; 135 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "graylog-cli-dashboard", 3 | "version": "1.1.1", 4 | "description": "CLI dashboard for Graylog because ain't nobody got time for browser windows.", 5 | "homepage": "http://www.graylog.org/", 6 | "author": { 7 | "name": "Lennart Koopmann", 8 | "email": "lennart@torch.sh" 9 | }, 10 | "engines": { 11 | "node": ">=6.0" 12 | }, 13 | "repository": { 14 | "type": "git", 15 | "url": "git@github.com:Graylog2/cli-dashboard.git" 16 | }, 17 | "bugs": { 18 | "url": "https://github.com/Graylog2/cli-dashboard/issues" 19 | }, 20 | "licenses": [ 21 | { 22 | "type": "GPLv3", 23 | "url": "https://github.com/Graylog2/cli-dashboard/blob/master/COPYING" 24 | } 25 | ], 26 | "dependencies": { 27 | "ansi": "^0.3.1", 28 | "blessed": "^0.1.81", 29 | "blessed-contrib": "^4.5.5", 30 | "bluebird": "^3.4.6", 31 | "inquirer": "^1.2.2", 32 | "js-yaml": "^3.2.5", 33 | "moment": "^2.9.0", 34 | "request": "^2.76.0", 35 | "yargs": "^6.3.0" 36 | }, 37 | "preferGlobal": "true", 38 | "bin": { 39 | "graylog-dashboard": "graylog-dashboard.js", 40 | "tailgl": "tailgl.js" 41 | }, 42 | "devDependencies": { 43 | "eslint": "^3.9.0", 44 | "semver": "^5.3.0" 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /screencast.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/graylog-labs/cli-dashboard/4bfe2e46270e67876a4310e0c3dcdb971418aa76/screencast.gif -------------------------------------------------------------------------------- /tailgl.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 'use strict'; 3 | 4 | /** 5 | * This file is part of Graylog2. 6 | * 7 | * Graylog2 is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * Graylog2 is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with Graylog2. If not, see . 19 | */ 20 | 21 | const Promise = require('bluebird'); 22 | const graylog = require('./lib/graylog-api'); 23 | const moment = require('moment'); 24 | const ansi = require('ansi'); 25 | const cursor = ansi(process.stdout); 26 | const url = require('url'); 27 | const fs = require('fs'); 28 | const yaml = require('js-yaml'); 29 | const inquirer = require('inquirer'); 30 | const yargs = require('yargs') 31 | .usage('Usage: $0 [options]') 32 | .describe('stream-title', 'Graylog Stream Title') 33 | .alias('S','stream-title') 34 | .group(['server-url', 'api-host', 'api-port', 'api-path', 'api-protocol', 'username', 'password'], 'Rest API Options:') 35 | .describe('server-url', '(Deprecated; use api-host, path, port) Full Graylog API URL') 36 | .describe('api-host', 'Graylog API Hostname') 37 | .alias('H','api-host') 38 | .describe('api-port', 'Graylog API Port') 39 | .default('api-port', 9000) 40 | .describe('api-path', 'Graylog API Path') 41 | .default('api-path', '/api/') 42 | .describe('api-protocol', 'Graylog API Protocol') 43 | .alias('P','api-protocol') 44 | .default('api-protocol', 'https') 45 | .describe('poll-interval', 'How often (in ms) to poll the Graylog server') 46 | .default('poll-interval', 1000) 47 | .describe('username', 'Graylog API Username') 48 | .alias('u','username') 49 | .describe('password', 'Graylog API Password') 50 | .alias('p','password') 51 | .describe('sort', 'Stream Sorting') 52 | .default('sort','timestamp:desc') 53 | .describe('query', 'Query') 54 | .default('query','*') 55 | .alias('Q','query') 56 | .describe('fields', 'Fields') 57 | .default('fields','timestamp,source,message') 58 | .describe('range', 'Range in seconds. Must be larger than poll interval.') 59 | .default('range','5') // intentional; just long enough to tail the page 60 | .describe('batch', 'events per request') 61 | .default('batch', Infinity) 62 | .describe('format','output format (ansi,csv,json)') 63 | .default('format','ansi') 64 | .describe('cred-file-path', 'Path to an optional credentials file') 65 | .default('cred-file-path', `${process.env.HOME}/.graylog_dashboard`) 66 | .describe('insecure', 'If set, will not verify leaf certificates.') 67 | .help(); 68 | 69 | // Will contain: 70 | // username, password, host, streamID, pollInterval, credFilePath 71 | let config; 72 | 73 | function updateMessagesList(messages) { 74 | 75 | const fields = config.fields.split(','); 76 | 77 | const items = messages 78 | .sort((message1, message2) => new Date(message1.timestamp) - new Date(message2.timestamp)); 79 | 80 | let msg; 81 | while(items.length) { 82 | msg = items.shift(); 83 | // skip if _id already displayed 84 | if (config.id_blacklist[ msg['_id'] ]) { continue; } 85 | fields.forEach(function(el) { 86 | switch(el){ 87 | case 'timestamp': 88 | cursor.grey().write( moment(msg.timestamp).format('YYYY-MM-DD HH:mm:ss') ); 89 | break; 90 | case 'source': 91 | cursor.yellow().write( ' '+ msg.source ); 92 | break; 93 | default: 94 | cursor.reset().write( ' '+ msg[el] ); 95 | } 96 | }); 97 | cursor.write('\n'); 98 | 99 | // blacklist displayed message-ids in order to prevent successive 100 | // results from the same second from being re-displayed 101 | config.id_blacklist[ msg['_id'] ] = msg.timestamp; 102 | } 103 | 104 | // save last msg id and last timestamp 105 | if (msg) { 106 | config.last_id = msg['_id']; 107 | config.last_timestamp = msg.timestamp; 108 | } 109 | 110 | // clean id_blacklist 111 | for (var id in config.id_blacklist) { 112 | if ( new Date(config.id_blacklist[id]) < new Date(config.last_timestamp) ) { 113 | delete config.id_blacklist[id]; 114 | } 115 | } 116 | } 117 | 118 | 119 | function getOptions() { 120 | return Promise.try(function getOptionInput() { 121 | const {argv} = yargs; 122 | 123 | // Read user credentials. 124 | let fileConfig = {}; 125 | try { 126 | fileConfig = yaml.safeLoad(fs.readFileSync(argv['cred-file-path'], 'utf8')); 127 | } catch (err) { 128 | // Ignore, maybe everything was defined in argv 129 | } 130 | 131 | // Remove falsy values from argv to clean up merge. 132 | Object.keys(argv).forEach((k) => { 133 | if (!argv[k]) delete argv[k]; 134 | }); 135 | // Merge argv & file config. 136 | config = Object.assign({}, argv, fileConfig); 137 | 138 | if (config.insecure) process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0"; 139 | }) 140 | .then(function coerceOptions() { 141 | // inital value 142 | config.id_blacklist = {}; 143 | 144 | // DEPRECATED: serverURL 145 | let fullURL = config.serverURL || config['server-url']; 146 | if (fullURL) { 147 | // Make sure we have a protocol (default: https) 148 | if (!/^\w+:\/\//.test(fullURL)) fullURL = 'https://' + fullURL; 149 | 150 | // Make sure we have a port (default REST API port is 9000) 151 | const parts = url.parse(fullURL); 152 | if (!parts.port) parts.port = 9000; 153 | if (!parts.path) parts.path = '/api/'; 154 | parts.href = parts.host = null; // otherwise url won't change when re-formatting 155 | config.serverURL = url.format(parts); 156 | } else if (config['api-host']) { 157 | config.serverURL = `${config['api-protocol']}://${config['api-host']}:${config['api-port']}${config['api-path']}`; 158 | } else { 159 | throw new Error('Either "server-url" or "api-host" must be defined!'); 160 | } 161 | 162 | if (config.pollInterval / 1000 > (config.range - 1)) { 163 | throw new Error('Poll interval must be more often than range, or messages will be missed.'); 164 | } 165 | }) 166 | .then(function checkMissingOptions() { 167 | // Check mandatory config. 168 | const shouldPrompt = ['username', 'password'].filter((k) => !config[k]); 169 | 170 | // Prompt user for missing options. 171 | if (shouldPrompt.length) { 172 | const questions = shouldPrompt.map((k) => ( 173 | {name: k, message: `Please input ${k}:`, type: k === 'password' ? 'password' : 'input'} 174 | )); 175 | 176 | // Inquirer uses core `readline`. When activated, it automatically emits `line` and `keypress` events. 177 | // Built-in NodeJS `readline` uses `stream[Symbol('keypress-decoder')]` to mark this, but blessed 178 | // uses its own check. If both are running, we'll get double keypress events which makes working 179 | // the stream list very difficult. 180 | process.stdin._keypressDecoder = true; 181 | 182 | const prompt = inquirer.createPromptModule(); 183 | return prompt(questions) 184 | .then(function(result) { 185 | return Object.assign(config, result); 186 | }); 187 | } 188 | return config; 189 | }); 190 | 191 | } 192 | 193 | let streams; // filled in after streams runs 194 | function storeStreams(_streams) { 195 | streams = _streams; 196 | if (!config.streamTitle) { 197 | // Could happen on startup 198 | config.streamTitle = streams[0].title; 199 | } 200 | const thisStream = streams.find((s) => s.title === config.streamTitle); 201 | config.streamID = thisStream.id; 202 | } 203 | 204 | function poll() { 205 | return graylog.lastMessagesOfStream(config) 206 | .then(updateMessagesList) 207 | .delay(config.pollInterval) 208 | .then(() => poll(config.streamID)); 209 | } 210 | 211 | // Entry 212 | getOptions() 213 | .then(graylog.getMetadata) 214 | .then(() => graylog.streams(config)) 215 | .tap(storeStreams) 216 | .then(poll) 217 | .catch(console.error); 218 | --------------------------------------------------------------------------------