├── .circleci └── config.yml ├── .github └── ISSUE_TEMPLATE │ └── new-metric-request.md ├── .gitignore ├── LICENSE ├── Makefile ├── README.md ├── gentoo └── app-metrics │ └── nftables_exporter │ ├── files │ └── nftables_exporter.yaml │ └── nftables_exporter-9999.ebuild ├── logging.go ├── main.go ├── nftables.go ├── nftables_exporter.yaml ├── nftablesrule.go ├── options.go ├── readjson.go └── systemd └── nftables_exporter.service /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | jobs: 3 | build: 4 | working_directory: /go/src/github.com/Sheridan/nftables_exporter 5 | docker: 6 | - image: circleci/golang:1.10.0 7 | environment: 8 | - GOCACHE: "/tmp/go/cache" 9 | - DEP_VERSION: 0.4.1 10 | steps: 11 | - checkout 12 | - run: 13 | name: build 14 | command: make build 15 | - store_artifacts: 16 | path: bin/nftables_exporter 17 | destination: nftables_exporter 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/new-metric-request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: New metric request 3 | about: Need more metrics 4 | title: Need more metrics 5 | labels: enhancement 6 | assignees: Sheridan 7 | 8 | --- 9 | 10 | **Describe the metrics you'd like** 11 | Describe the metric you would like to see. What should be the name, tags? 12 | If possible, give an example of the ntables rules that will be involved in the collection of metrics. 13 | 14 | **Attach json example** 15 | For faster development, attach a file to the message, which generated with `nft -j list ruleset > /path/to/nft.json` 16 | To preserve anonymity after exporting a file, replace the values of addresses and ports that are important to you with any others. 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | vendor 2 | bin 3 | nft.json 4 | 5 | Manifest 6 | -------------------------------------------------------------------------------- /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 | GOPATH=$(shell pwd)/vendor:$(shell pwd) 2 | GOBIN=$(shell pwd)/bin 3 | GOFILES=$(wildcard *.go) 4 | GONAME=$(shell basename "$(PWD)") 5 | 6 | build: get 7 | @echo "Building $(GOFILES) to ./bin" 8 | @GOPATH=$(GOPATH) GOBIN=$(GOBIN) go build -v -o bin/$(GONAME) $(GOFILES) 9 | 10 | get: 11 | @GOPATH=$(GOPATH) GOBIN=$(GOBIN) go get -v . 12 | 13 | install: 14 | @GOPATH=$(GOPATH) GOBIN=$(GOBIN) go install $(GOFILES) 15 | 16 | run: build 17 | @GOPATH=$(GOPATH) GOBIN=$(GOBIN) go run $(GOFILES) --config=$(shell pwd)/nftables_exporter.yaml --debug --verbose 18 | 19 | clear: 20 | @clear 21 | 22 | clean: 23 | @echo "Cleaning" 24 | @GOPATH=$(GOPATH) GOBIN=$(GOBIN) go clean 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![CircleCI](https://circleci.com/gh/Sheridan/nftables_exporter.svg?style=svg)](https://circleci.com/gh/Sheridan/nftables_exporter) 2 | 3 | # nftables_exporter 4 | Export nftables statistics to prometheus 5 | 6 | 7 | 8 | ## Need more? 9 | **If you need additional metrics - contact me :)** 10 | **Create a feature request, describe the metric that you would like to have and attach exported from nftables json file** 11 | 12 | # Configuration 13 | ## Command line options 14 | * `--config=/path/to/file.yaml`: Path to configuration file, default `/etc/nftables_exporter.yaml` 15 | * `--verbose`: verbosed log, default no 16 | * `--debug`: Debug logging, default no 17 | * `--version`: Show version and exit 18 | 19 | ## Configuration file 20 | Example content: 21 | ``` 22 | nftables_exporter: 23 | bind_to: "[::1]:9630" 24 | url_path: "/metrics" 25 | nft_location: /sbin/nft 26 | fake_nft_json: /path/to/nft.json 27 | ``` 28 | `fake_nft_json` used for debugging. I create this file with the command `nft -j list ruleset > /path/to/nft.json`. For normal exporter usage, this option is not needed. 29 | 30 | # Example metrics 31 | ``` 32 | # HELP nftables_chain_rules Count rules in chain 33 | # TYPE nftables_chain_rules gauge 34 | nftables_chain_rules{family="inet",name="forward",table="filter"} 2.0 35 | nftables_chain_rules{family="inet",name="global",table="filter"} 15.0 36 | # HELP nftables_table_chains Count chains in table 37 | # TYPE nftables_table_chains gauge 38 | nftables_table_chains{family="inet",name="filter"} 7.0 39 | nftables_table_chains{family="ip",name="nat"} 4.0 40 | # HELP nftables_rule_bytes Bytes, matched by rule per rule comment 41 | # TYPE nftables_rule_bytes gauge 42 | nftables_rule_bytes{action="accept",chain="host_spc",comment="[spc->internet] Default http [tcp]",destination_addresses="any",destination_ports="http",family="inet",input_interfaces="internal_0",output_interfaces="external_kis_0",source_addresses="10.0.0.10",source_ports="any",table="filter"} 2280.0 43 | # HELP nftables_rule_packets Packets, matched by rule per rule comment 44 | # TYPE nftables_rule_packets gauge 45 | nftables_rule_packets{action="accept",chain="host_spc",comment="[spc->internet] Default http [tcp]",destination_addresses="any",destination_ports="http",family="inet",input_interfaces="internal_0",output_interfaces="external_kis_0",source_addresses="10.0.0.10",source_ports="any",table="filter"} 38.0 46 | ``` 47 | 48 | # Thank to 49 | * [@onokonem](https://github.com/onokonem) 50 | -------------------------------------------------------------------------------- /gentoo/app-metrics/nftables_exporter/files/nftables_exporter.yaml: -------------------------------------------------------------------------------- 1 | nftables_exporter: 2 | bind_to: "[::1]:9630" 3 | url_path: "/metrics" 4 | fake_nft_json: nft.json 5 | nft_location: /sbin/nft 6 | -------------------------------------------------------------------------------- /gentoo/app-metrics/nftables_exporter/nftables_exporter-9999.ebuild: -------------------------------------------------------------------------------- 1 | # Copyright 2019+ Maxim "Sheridan" Gorlov 2 | # Distributed under the terms of the GNU General Public License v3 3 | 4 | EAPI=6 5 | EGIT_REPO_URI="https://github.com/Sheridan/${PN}" 6 | inherit git-r3 7 | 8 | DESCRIPTION="Exporting nftables metrics" 9 | HOMEPAGE="https://github.com/Sheridan/nftables_exporter" 10 | LICENSE="GPL-3" 11 | SLOT="0" 12 | RDEPEND="net-firewall/nftables" 13 | DEPEND="dev-lang/go" 14 | KEYWORDS="~amd64 ~ppc ~x86 ~arm" 15 | 16 | src_unpack() { 17 | git-r3_src_unpack 18 | cd "${S}" 19 | make get 20 | } 21 | 22 | src_compile() { 23 | make build 24 | } 25 | 26 | src_install() { 27 | newbin bin/${PN}-${PV} ${PN} 28 | dodoc "README.md" 29 | insinto /etc 30 | newins "${FILESDIR}/nftables_exporter.yaml" nftables_exporter.yaml 31 | } 32 | -------------------------------------------------------------------------------- /logging.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | ) 6 | 7 | // Logger is logger 8 | type Logger struct { 9 | verbose bool 10 | debug bool 11 | } 12 | 13 | func newLogger(verbose bool, debug bool) Logger { 14 | logger := Logger{verbose: verbose, debug: debug} 15 | return logger 16 | } 17 | 18 | // Msg formatted message 19 | func (i Logger) print(prefix string, format string, values ...interface{}) { 20 | fmt.Printf(fmt.Sprintf("[%s] %s\n", prefix, format), values...) 21 | } 22 | 23 | // Info log message 24 | func (i Logger) Info(format string, values ...interface{}) { 25 | i.print("Info", format, values...) 26 | } 27 | 28 | // Warning log message 29 | func (i Logger) Warning(format string, values ...interface{}) { 30 | i.print("Warning", format, values...) 31 | } 32 | 33 | // Error log message 34 | func (i Logger) Error(format string, values ...interface{}) { 35 | i.print("Error", format, values...) 36 | } 37 | 38 | // Panic log message 39 | func (i Logger) Panic(format string, values ...interface{}) { 40 | i.print("Panic", format, values...) 41 | } 42 | 43 | // Verbose log message 44 | func (i Logger) Verbose(format string, values ...interface{}) { 45 | if i.verbose { 46 | i.print("Verbose", format, values...) 47 | } 48 | } 49 | 50 | // Debug log message 51 | func (i Logger) Debug(format string, values ...interface{}) { 52 | if i.debug { 53 | i.print("Debug", format, values...) 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "log" 5 | "net/http" 6 | 7 | "github.com/prometheus/client_golang/prometheus" 8 | "github.com/prometheus/client_golang/prometheus/promhttp" 9 | ) 10 | 11 | var ( 12 | options Options 13 | logger Logger 14 | promhttpHandler = promhttp.Handler() 15 | 16 | tableChainsDesc = prometheus.NewDesc( 17 | "nftables_table_chains", 18 | "Count chains in table", 19 | []string{ 20 | "name", 21 | "family", 22 | }, 23 | nil, 24 | ) 25 | chainRulesDesc = prometheus.NewDesc( 26 | "nftables_chain_rules", 27 | "Count rules in chain", 28 | []string{ 29 | "name", 30 | "family", 31 | "table", 32 | }, 33 | nil, 34 | ) 35 | ruleBytesDesc = prometheus.NewDesc( 36 | "nftables_rule_bytes", 37 | "Bytes, matched by rule per rule comment", 38 | []string{ 39 | "chain", 40 | "family", 41 | "table", 42 | "input_interfaces", 43 | "output_interfaces", 44 | "source_addresses", 45 | "destination_addresses", 46 | "source_ports", 47 | "destination_ports", 48 | "comment", 49 | "action", 50 | }, 51 | nil, 52 | ) 53 | rulePacketsDesc = prometheus.NewDesc( 54 | "nftables_rule_packets", 55 | "Packets, matched by rule per rule comment", 56 | []string{ 57 | "chain", 58 | "family", 59 | "table", 60 | "input_interfaces", 61 | "output_interfaces", 62 | "source_addresses", 63 | "destination_addresses", 64 | "source_ports", 65 | "destination_ports", 66 | "comment", 67 | "action", 68 | }, 69 | nil, 70 | ) 71 | ) 72 | 73 | // NFTablesManagerCollector implements the Collector interface. 74 | type NFTablesManagerCollector struct { 75 | } 76 | 77 | // Describe sends the super-set of all possible descriptors of metrics 78 | func (i NFTablesManagerCollector) Describe(ch chan<- *prometheus.Desc) { 79 | prometheus.DescribeByCollect(i, ch) 80 | } 81 | 82 | // Collect is called by the Prometheus registry when collecting metrics. 83 | func (i NFTablesManagerCollector) Collect(ch chan<- prometheus.Metric) { 84 | json, err := readData() 85 | if err != nil { 86 | logger.Error("Failed parsing nftables data: %s", err) 87 | } else { 88 | nft := NewNFTables(json, ch) 89 | nft.Collect() 90 | } 91 | } 92 | 93 | func init() { 94 | options = loadOptions() 95 | } 96 | 97 | func main() { 98 | reg := prometheus.NewPedanticRegistry() 99 | reg.MustRegister( 100 | prometheus.NewProcessCollector(prometheus.ProcessCollectorOpts{}), 101 | prometheus.NewGoCollector(), 102 | ) 103 | 104 | prometheus.WrapRegistererWithPrefix("", reg).MustRegister(NFTablesManagerCollector{}) 105 | 106 | logger.Info("Starting on %s%s", options.Nft.BindTo, options.Nft.URLPath) 107 | http.Handle(options.Nft.URLPath, promhttp.HandlerFor(reg, promhttp.HandlerOpts{})) 108 | log.Fatal(http.ListenAndServe(options.Nft.BindTo, nil)) 109 | } 110 | -------------------------------------------------------------------------------- /nftables.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "strings" 6 | 7 | "github.com/prometheus/client_golang/prometheus" 8 | "github.com/tidwall/gjson" 9 | ) 10 | 11 | // NFTables object 12 | type NFTables struct { 13 | ch chan<- prometheus.Metric 14 | json gjson.Result 15 | } 16 | 17 | // NewNFTables is NFTables constructor 18 | func NewNFTables(json gjson.Result, ch chan<- prometheus.Metric) NFTables { 19 | logger.Verbose("Collecting metrics") 20 | nft := NFTables{} 21 | nft.ch = ch 22 | nft.json = json 23 | return nft 24 | } 25 | 26 | func (nft NFTables) arrayToTag(values []string) string { 27 | if len(values) == 0 { 28 | return "any" 29 | } 30 | return strings.Join(values, ",") 31 | } 32 | 33 | // Collect metrics 34 | func (nft NFTables) Collect() { 35 | tables := nft.json.Get("#.table").Array() 36 | chains := nft.json.Get("#.chain").Array() 37 | rules := nft.json.Get("#.rule").Array() 38 | for _, jTable := range tables { 39 | table := jTable.Get("name").String() 40 | family := jTable.Get("family").String() 41 | tableChains := 0 42 | for _, jChain := range chains { 43 | if jChain.Get("table").String() == table && jChain.Get("family").String() == family { 44 | tableChains++ 45 | chain := jChain.Get("name").String() 46 | chainRules := 0 47 | for _, jRule := range rules { 48 | if jRule.Get("table").String() == table && jRule.Get("family").String() == family && jRule.Get("chain").String() == chain { 49 | chainRules++ 50 | nft.mineRule(jRule) 51 | } 52 | } 53 | nft.ch <- prometheus.MustNewConstMetric( 54 | chainRulesDesc, 55 | prometheus.GaugeValue, 56 | float64(chainRules), 57 | chain, 58 | family, 59 | table, 60 | ) 61 | } 62 | } 63 | nft.ch <- prometheus.MustNewConstMetric( 64 | tableChainsDesc, 65 | prometheus.GaugeValue, 66 | float64(tableChains), 67 | table, 68 | family, 69 | ) 70 | } 71 | } 72 | 73 | // Mining "rule": {} metrics 74 | func (nft NFTables) mineRule(value gjson.Result) { 75 | // fmt.Printf("[rule] %s = %s\n", key, value) 76 | rule := NewRule(value.Get("chain").String(), value.Get("family").String(), value.Get("table").String()) 77 | counter := value.Get("expr.#.counter|0") 78 | if counter.Exists() { 79 | // fmt.Println(counter.Get("bytes").Float(), counter.Get("packets").Float()) 80 | rule.Couters.Bytes = counter.Get("bytes").Float() 81 | rule.Couters.Packets = counter.Get("packets").Float() 82 | comment := value.Get("comment") 83 | rule.Action = nft.mineAction(value.Get("expr")) 84 | if comment.Exists() { 85 | rule.Comment = comment.String() 86 | } 87 | for _, match := range value.Get("expr.#.match").Array() { 88 | // fmt.Printf("[match] %s\n", match) 89 | left := match.Get("left") 90 | right := match.Get("right") 91 | if left.Exists() && right.Exists() { 92 | // fmt.Printf("[left] %s, [right] %s\n", left, right) 93 | meta := left.Get("meta") 94 | if meta.Exists() { 95 | switch meta.Get("key").String() { 96 | case "iif", "iifname": 97 | rule.Interfaces.Input = append(rule.Interfaces.Input, right.String()) 98 | case "oif", "oifname": 99 | rule.Interfaces.Output = append(rule.Interfaces.Output, right.String()) 100 | } 101 | continue 102 | } 103 | payload := left.Get("payload") 104 | if payload.Exists() { 105 | field := payload.Get("field") 106 | if field.Exists() { 107 | switch field.String() { // TODO: ip4 \ ip6 proto as tag? 108 | case "saddr": 109 | rule.Addresses.Source = append(rule.Addresses.Source, nft.mineAddress(right)...) 110 | case "daddr": 111 | rule.Addresses.Destination = append(rule.Addresses.Destination, nft.mineAddress(right)...) 112 | case "sport": 113 | rule.Ports.Source = append(rule.Ports.Source, nft.minePorts(right)...) 114 | case "dport": 115 | rule.Ports.Destination = append(rule.Ports.Destination, nft.minePorts(right)...) 116 | } 117 | } 118 | continue 119 | } 120 | } 121 | } 122 | nft.setRuleCounters(rule) 123 | } 124 | } 125 | 126 | func (nft NFTables) mineAction(expr gjson.Result) string { 127 | // logger.Info("%+v", value.Get("expr.#.(drop|accept|masquerade)")) 128 | for _, action := range []string{"drop", "accept", "masquerade"} { 129 | // logger.Info("%+v", expr.Get(fmt.Sprintf("#.%s", action))) 130 | jAction := expr.Get(fmt.Sprintf("#.%s|0", action)) 131 | if jAction.Exists() { 132 | // logger.Info("%+v, %s", jAction, action) 133 | return action 134 | } 135 | } 136 | return "policy" 137 | } 138 | 139 | func (nft NFTables) mineAddress(right gjson.Result) []string { 140 | switch right.Type { 141 | case gjson.String: 142 | return []string{right.String()} 143 | case gjson.JSON: 144 | { 145 | prefix := right.Get("prefix") 146 | if prefix.Exists() { 147 | return []string{nft.subnetToString(prefix)} 148 | } 149 | set := right.Get("set") 150 | if set.Exists() { 151 | var addresses []string 152 | // fmt.Printf("[prefix] %s\n", set.Get("#.prefix")) 153 | for _, prefix := range set.Get("#.prefix").Array() { 154 | // fmt.Printf("[prefix] %s\n", prefix) 155 | addresses = append(addresses, nft.subnetToString(prefix)) 156 | } 157 | return addresses 158 | } 159 | } 160 | } 161 | return []string{} 162 | } 163 | 164 | func (nft NFTables) subnetToString(prefix gjson.Result) string { 165 | return fmt.Sprintf("%s/%s", prefix.Get("addr").String(), prefix.Get("len").String()) 166 | } 167 | 168 | func (nft NFTables) minePorts(right gjson.Result) []string { 169 | switch right.Type { 170 | case gjson.String, gjson.Number: 171 | return []string{right.String()} 172 | case gjson.JSON: 173 | return nft.portsToArray(right, []string{"set", "range"}) 174 | } 175 | return []string{} 176 | } 177 | 178 | func (nft NFTables) portsToArray(right gjson.Result, keys []string) []string { 179 | var ports []string 180 | for _, key := range keys { 181 | values := right.Get(key) 182 | if values.Exists() { 183 | // fmt.Printf("{matchval type}: %+v\n", values) 184 | for _, port := range values.Array() { 185 | // fmt.Printf("[ptype] %s\n", port.Type) 186 | switch port.Type { 187 | case gjson.String, gjson.Number: 188 | ports = append(ports, port.String()) 189 | case gjson.JSON: 190 | ports = append(ports, nft.portsToArray(port, []string{"set", "range"})...) 191 | } 192 | } 193 | } 194 | } 195 | // fmt.Printf("[ports] %s\n", ports) 196 | return ports 197 | } 198 | 199 | func (nft NFTables) setRuleCounters(rule Rule) { 200 | InputInterfaces := nft.arrayToTag(rule.Interfaces.Input) 201 | OutputInterfaces := nft.arrayToTag(rule.Interfaces.Output) 202 | SourceAddresses := nft.arrayToTag(rule.Addresses.Source) 203 | DestinationAddresses := nft.arrayToTag(rule.Addresses.Destination) 204 | SourcePorts := nft.arrayToTag(rule.Ports.Source) 205 | DestinationPorts := nft.arrayToTag(rule.Ports.Destination) 206 | // logger.Verbose(fmt.Sprintf("%s.%s.%s => %s:%s:%s -> %s:%s:%s = %f, %s, %s", rule.Chain, rule.Family, rule.Table, InputInterfaces, SourceAddresses, SourcePorts, OutputInterfaces, DestinationAddresses, DestinationPorts, rule.Couters.Bytes, rule.Action, rule.Comment)) 207 | nft.ch <- prometheus.MustNewConstMetric( 208 | ruleBytesDesc, 209 | prometheus.CounterValue, 210 | rule.Couters.Bytes, 211 | rule.Chain, 212 | rule.Family, 213 | rule.Table, 214 | InputInterfaces, 215 | OutputInterfaces, 216 | SourceAddresses, 217 | DestinationAddresses, 218 | SourcePorts, 219 | DestinationPorts, 220 | rule.Comment, 221 | rule.Action, 222 | ) 223 | nft.ch <- prometheus.MustNewConstMetric( 224 | rulePacketsDesc, 225 | prometheus.CounterValue, 226 | rule.Couters.Packets, 227 | rule.Chain, 228 | rule.Family, 229 | rule.Table, 230 | InputInterfaces, 231 | OutputInterfaces, 232 | SourceAddresses, 233 | DestinationAddresses, 234 | SourcePorts, 235 | DestinationPorts, 236 | rule.Comment, 237 | rule.Action, 238 | ) 239 | } 240 | -------------------------------------------------------------------------------- /nftables_exporter.yaml: -------------------------------------------------------------------------------- 1 | nftables_exporter: 2 | bind_to: "[::1]:9630" 3 | url_path: "/metrics" 4 | fake_nft_json: nft.json 5 | nft_location: /sbin/nft 6 | -------------------------------------------------------------------------------- /nftablesrule.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | // Rule - chain rule 4 | type Rule struct { 5 | Chain string 6 | Table string 7 | Family string 8 | Comment string 9 | Action string 10 | Interfaces struct { 11 | Input []string 12 | Output []string 13 | } 14 | Addresses struct { 15 | Source []string 16 | Destination []string 17 | } 18 | Ports struct { 19 | Source []string 20 | Destination []string 21 | } 22 | Couters struct { 23 | Bytes float64 24 | Packets float64 25 | } 26 | } 27 | 28 | // NewRule is Rule constructor 29 | func NewRule(chain string, family string, table string) Rule { 30 | rule := Rule{} 31 | rule.Chain = chain 32 | rule.Family = family 33 | rule.Table = table 34 | rule.Comment = "empty" 35 | rule.Action = "policy" 36 | return rule 37 | } 38 | -------------------------------------------------------------------------------- /options.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | "io/ioutil" 7 | "os" 8 | 9 | yaml "gopkg.in/yaml.v2" 10 | ) 11 | 12 | var ( 13 | exporterVersion = "0.5" 14 | ) 15 | 16 | // NFTOptions is a inner representation of a options 17 | type NFTOptions struct { 18 | BindTo string `yaml:"bind_to"` 19 | URLPath string `yaml:"url_path"` 20 | FakeNftJSON string `yaml:"fake_nft_json"` 21 | NFTLocation string `yaml:"nft_location"` 22 | } 23 | 24 | // Options is a representation of a options 25 | type Options struct { 26 | Nft NFTOptions `yaml:"nftables_exporter"` 27 | } 28 | 29 | // Parse options from yaml config file 30 | func loadOptions() Options { 31 | configFile := flag.String("config", "/etc/nftables_exporter.yaml", "Path to nftables_exporter config file") 32 | verbose := flag.Bool("verbose", false, "Verbose log output") 33 | debug := flag.Bool("debug", false, "Debug log output") 34 | version := flag.Bool("version", false, "Show application version and exit") 35 | flag.Parse() 36 | 37 | if *version { 38 | fmt.Printf("nftables_exporter version: %s\n", exporterVersion) 39 | os.Exit(0) 40 | } 41 | 42 | logger = newLogger(*verbose, *debug) 43 | 44 | logger.Verbose("Read options from %s\n", *configFile) 45 | yamlFile, err := ioutil.ReadFile(*configFile) 46 | if err != nil { 47 | logger.Panic("Failed read %s: %s", configFile, err) 48 | } 49 | 50 | opts := Options{ 51 | NFTOptions{ 52 | BindTo: "9630", 53 | URLPath: "/metrics", 54 | FakeNftJSON: "", 55 | NFTLocation: "/sbin/nft", 56 | }, 57 | } 58 | 59 | if yaml.Unmarshal(yamlFile, &opts) != nil { 60 | logger.Panic("Failed parse %s: %s", configFile, err) 61 | } 62 | logger.Debug("Parsed options: %s", opts) 63 | return opts 64 | } 65 | -------------------------------------------------------------------------------- /readjson.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "errors" 5 | "io/ioutil" 6 | "log" 7 | "os" 8 | "os/exec" 9 | 10 | "github.com/tidwall/gjson" 11 | ) 12 | 13 | // Parse json to gjson object 14 | func parseJSON(data string) (gjson.Result, error) { 15 | if !gjson.Valid(data) { 16 | return gjson.Parse("{}"), errors.New("Invalid JSON") 17 | } 18 | return gjson.Get(data, "nftables"), nil 19 | } 20 | 21 | // Reading fake nftables json 22 | func readFakeNFTables() (gjson.Result, error) { 23 | logger.Verbose("Read fake nftables data from json: %s", options.Nft.FakeNftJSON) 24 | jsonFile, err := ioutil.ReadFile(options.Nft.FakeNftJSON) 25 | if err != nil { 26 | logger.Error("Fake nftables data reading error: %s", err) 27 | } 28 | return parseJSON(string(jsonFile)) 29 | } 30 | 31 | // Get json from nftables and parse it 32 | func readNFTables() (gjson.Result, error) { 33 | logger.Debug("Collecting NFTables counters...") 34 | out, err := exec.Command(options.Nft.NFTLocation, "-j", "list", "ruleset").Output() 35 | if err != nil { 36 | log.Fatal("NFTables reading error: ", err) 37 | } 38 | return parseJSON(string(out)) 39 | } 40 | 41 | // Select json source and parse 42 | func readData() (gjson.Result, error) { 43 | if _, err := os.Stat(options.Nft.FakeNftJSON); err == nil { 44 | return readFakeNFTables() 45 | } 46 | return readNFTables() 47 | } 48 | -------------------------------------------------------------------------------- /systemd/nftables_exporter.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=nftables exporter service 3 | After=network-online.target 4 | 5 | [Service] 6 | Type=simple 7 | PIDFile=/run/nftables_exporter.pid 8 | ExecStart=/usr/bin/nftables_exporter 9 | User=root 10 | Group=root 11 | SyslogIdentifier=nftables_exporter 12 | Restart=on-failure 13 | RemainAfterExit=no 14 | RestartSec=100ms 15 | StandardOutput=journal 16 | StandardError=journal 17 | 18 | [Install] 19 | WantedBy=multi-user.target 20 | --------------------------------------------------------------------------------