From ec34f67683cbc0d5fb49c2908beb454544050d72 Mon Sep 17 00:00:00 2001 From: "Ciro S. Costa" Date: Sat, 26 Jun 2021 10:26:27 -0400 Subject: [PATCH] init: add readme Signed-off-by: Ciro S. Costa --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 113 ++++++++++++++++++++++++++ assets/donate.png | Bin 0 -> 7547 bytes assets/pod.yaml | 24 ++++++ 4 files changed, 338 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 assets/donate.png create mode 100644 assets/pod.yaml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..682ce4d --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 Ciro S. Costa + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..62f10e5 --- /dev/null +++ b/README.md @@ -0,0 +1,113 @@ +# monero-exporter + +Prometheus exporter for [monero](https://getmonero.org). + + +## Installation + +Using Go: + +``` +go get github.com/cirocosta/monero-exporter/cmd/monero-exporter +``` + +From releases: + +**TODO** + + +## Usage + +```console +$ monero-exporter --help +Usage: + monero-exporter [OPTIONS] + +Application Options: + --monerod-address= address of monerod rpc (restricted if possible) (default: http://localhost:18081) + --geoip-file= filepath of geoip database + +Help Options: + -h, --help Show this help message +``` + +## Metrics + + +| name | description | +| ---- | ----------- | +| monero_bans | number of nodes banned | +| monero_connections | connections info | +| monero_connections_livetime | peers livetime distribution | +| monero_fee_estimate | fee estimate for 1 grace block | +| monero_height_divergence | how much our peers diverge from us in block height | +| monero_info_alt_blocks_count | info for alt_blocks_count | +| monero_info_block_size_limit | info for block_size_limit | +| monero_info_block_size_median | info for block_size_median | +| monero_info_busy_syncing | info for busy_syncing | +| monero_info_cumulative_difficulty | info for cumulative_difficulty | +| monero_info_difficulty | info for difficulty | +| monero_info_free_space | info for free_space | +| monero_info_grey_peerlist_size | info for grey_peerlist_size | +| monero_info_height | info for height | +| monero_info_height_without_bootstrap | info for height_without_bootstrap | +| monero_info_incoming_connections_count | info for incoming_connections_count | +| monero_info_mainnet | info for mainnet | +| monero_info_offline | info for offline | +| monero_info_outgoing_connections_count | info for outgoing_connections_count | +| monero_info_rpc_connections_count | info for rpc_connections_count | +| monero_info_stagenet | info for stagenet | +| monero_info_start_time | info for start_time | +| monero_info_synchronized | info for synchronized | +| monero_info_target | info for target | +| monero_info_target_height | info for target_height | +| monero_info_testnet | info for testnet | +| monero_info_tx_count | info for tx_count | +| monero_info_tx_pool_size | info for tx_pool_size | +| monero_info_untrusted | info for untrusted | +| monero_info_was_bootstrap_ever_used | info for was_bootstrap_ever_used | +| monero_info_white_peerlist_size | info for white_peerlist_size | +| monero_last_block_header_block_size | info for block_size | +| monero_last_block_header_block_weight | info for block_weight | +| monero_last_block_header_cumulative_difficulty | info for cumulative_difficulty | +| monero_last_block_header_cumulative_difficulty_top64 | info for cumulative_difficulty_top64 | +| monero_last_block_header_depth | info for depth | +| monero_last_block_header_difficulty | info for difficulty | +| monero_last_block_header_difficulty_top64 | info for difficulty_top64 | +| monero_last_block_header_height | info for height | +| monero_last_block_header_long_term_weight | info for long_term_weight | +| monero_last_block_header_major_version | info for major_version | +| monero_last_block_header_minor_version | info for minor_version | +| monero_last_block_header_nonce | info for nonce | +| monero_last_block_header_num_txes | info for num_txes | +| monero_last_block_header_orphan_status | info for orphan_status | +| monero_last_block_header_reward | info for reward | +| monero_last_block_header_timestamp | info for timestamp | +| monero_last_block_txn_fee | distribution of outputs in last block | +| monero_last_block_txn_size | distribution of tx sizes | +| monero_last_block_vin | distribution of inputs in last block | +| monero_last_block_vout | distribution of outputs in last block | +| monero_mempool_bytes_max | info for bytes_max | +| monero_mempool_bytes_med | info for bytes_med | +| monero_mempool_bytes_min | info for bytes_min | +| monero_mempool_bytes_total | info for bytes_total | +| monero_mempool_fee_total | info for fee_total | +| monero_mempool_histo_98pc | info for histo_98pc | +| monero_mempool_num_10m | info for num_10m | +| monero_mempool_num_double_spends | info for num_double_spends | +| monero_mempool_num_failing | info for num_failing | +| monero_mempool_num_not_relayed | info for num_not_relayed | +| monero_mempool_oldest | info for oldest | +| monero_mempool_txs_total | info for txs_total | +| monero_net_total_in_bytes | network statistics | +| monero_net_total_out_bytes | network statistics | +| monero_peers_new | peers info | +| monero_rpc_count | todo | +| monero_rpc_time | todo | + + +## Donate + +![xmr address](./assets/donate.png) + +891B5keCnwXN14hA9FoAzGFtaWmcuLjTDT5aRTp65juBLkbNpEhLNfgcBn6aWdGuBqBnSThqMPsGRjWVQadCrhoAT6CnSL3 diff --git a/assets/donate.png b/assets/donate.png new file mode 100644 index 0000000000000000000000000000000000000000..3f2b6685cadfe281d48fad55bd3378ae940968ef GIT binary patch literal 7547 zcmeI0!D`fC6ovmGVrZpAa3gBTEBFKxloneMDbj`R#3vA3I*`Eu!B?YlvJYI8vMhS7y1{ zvf|n1^Q2nYQS*dF34JnUYDR@xTQ%)C4B_DkM_bsm#9OuslaVT-vKE$!Fmb8QUT1QYS`C!EU^);y@Huj*>6KWW3o^F%xgQ+qh|99g@VB~iEhptXyq=mT zEFT9j_Y(rzMggizlp3 z1PKl@b*>qrGF=X;Il>CkP|}P@E1EZPKlrIr%@rOcGg(?;HE}WMYvSr3D1(^1<^hXJ zQic&a#k@w0)tZ_soR;l;svWIXHKHClIs_N#fP7AH>OAa3o!3N>jjdSrov3R}K5)z} zYECVgo3($#r6kve3U!6svEHI!dp5~_CrbI&m%&D1B~wE>;O`k`lF1oav-QgyPuK`h zy=r18q*v>W2`UYpD3bVIFb@XRFcTamtVO6+%3s4U=m>YO{#tfyc;Ry`APNdmQj=+-r_7BSl9oZPiMNl zbA+i#m4T?qYx8xJ?5H`x@|s3w#&~ujE>)qZ)|Y`NtP*T;R&Z*7=E&wo|JH1FUZI8CBe*h1cq2>Sp literal 0 HcmV?d00001 diff --git a/assets/pod.yaml b/assets/pod.yaml new file mode 100644 index 0000000..43f90b9 --- /dev/null +++ b/assets/pod.yaml @@ -0,0 +1,24 @@ +apiVersion: v1 +kind: Pod +metadata: + name: node-0 +spec: + restartPolicy: Never + containers: + - command: + - monerod + - --non-interactive + - --out-peers=128 + - --in-peers=128 + - --prune-blockchain + - --limit-rate=128000 + image: index.docker.io/utxobr/monerod@sha256:19ba5793c00375e7115469de9c14fcad928df5867c76ab5de099e83f646e175d + imagePullPolicy: IfNotPresent + name: monerod + ports: + - containerPort: 18080 + name: p2p + protocol: TCP + - containerPort: 18089 + name: restricted + protocol: TCP