{"id":18437840,"url":"https://github.com/zilliqa/zilliqa-exporter","last_synced_at":"2025-04-07T20:34:35.524Z","repository":{"id":57566009,"uuid":"237910513","full_name":"Zilliqa/zilliqa-exporter","owner":"Zilliqa","description":"export zilliqa metrics to prometheus","archived":false,"fork":false,"pushed_at":"2022-03-21T08:55:18.000Z","size":384,"stargazers_count":1,"open_issues_count":1,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-23T00:31:47.254Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zilliqa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-03T07:40:57.000Z","updated_at":"2022-03-21T08:55:21.000Z","dependencies_parsed_at":"2022-08-27T19:01:08.311Z","dependency_job_id":null,"html_url":"https://github.com/Zilliqa/zilliqa-exporter","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fzilliqa-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fzilliqa-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fzilliqa-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fzilliqa-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zilliqa","download_url":"https://codeload.github.com/Zilliqa/zilliqa-exporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247726135,"owners_count":20985835,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T06:16:23.230Z","updated_at":"2025-04-07T20:34:34.389Z","avatar_url":"https://github.com/Zilliqa.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zilliqa Exporter\n\nA daemon that exports metrics of Zilliqa node as [Open Metrics](https://github.com/OpenObservability/OpenMetrics) Format\n\n## Common Labels:\n\n| Name         | Description                                                                                                         |\n| :----------- | :------------------------------------------------------------------------------------------------------------------ |\n| type         | type of node, can auto detect from pod name or zilliqad commandline params. (normal,lookup,newlookup,level2lookup)  |\n| index        | index of node, can auto detect from pod name or zilliqad commandline params. (normal,lookup,newlookup,level2lookup) |\n| pod_name     | node's pod name, from env \"POD_NAME\" or \"Z7A_POD_NAME\"                                                              |\n| pod_ip       | IP of the pod, from env \"POD_IP\", \"Z7A_POD_IP\"                                                                      |\n| cluster_name | name of genet cluster, from env \"CLUSTER_NAME\"                                                                      |\n| network_name | name of zilliqa network, from env \"Z7A_TESTNET_NAME\", \"TESTNET_NAME\", \"NETWORK_NAME\"                                |\n| public_ip    | public IP address, from AWS metadata                                                                                |\n| local_ip     | local private IP address, from AWS metadata                                                                         |\n\n\n## Metrics \u0026 Source\n\n### Constant Collector\n\nCollect constant info from environment variables, AWS metadata and Zilliqa commandline.\n\nOnly collect once when exporter starts.\n\n| Metric    | Description                                      | Source                                                |\n| :-------- | :----------------------------------------------- | :---------------------------------------------------- |\n| node_info | Node Information of zilliqa and host environment | CMD Options \u0026 EnvVars \u0026 AWS Metadata \u0026 Zilliqa Binary |\n\n\n### API Collector\n\nCollect info from zilliqa node's JSONRPC API server\nOnly for Lookup, Seed, Seed-apipub(Level2Lookup)\n\n| Metric                   | Description                                         | Method              | Additional Labels       |\n| :----------------------- | :-------------------------------------------------- | :------------------ | :---------------------- |\n| api_server_up            | JsonRPC API server up and running                   | -                   | endpoint                |\n| epoch                    | Current TX block number of the node                 | GetBlockchainInfo   | -                       |\n| ds_epoch                 | Current DS block number of the node                 | GetBlockchainInfo   | -                       |\n| transaction_rate         | Current transaction rate                            | GetBlockchainInfo   | -                       |\n| tx_block_rate            | Current TX block rate                               | GetBlockchainInfo   | -                       |\n| ds_block_rate            | Current DS block rate                               | GetBlockchainInfo   | -                       |\n| num_peers                | Peers count                                         | GetBlockchainInfo   | -                       |\n| sharding_peers           | Peers count of every shard                          | GetBlockchainInfo   | shard_index (of shard)  |\n| num_txns_tx_epoch        | numTxnsTxEpoch                                      | GetBlockchainInfo   | -                       |\n| num_txns_ds_epoch        | numTxnsDSEpoch                                      | GetBlockchainInfo   | -                       |\n| num_transactions         | Transactions count                                  | GetBlockchainInfo   | -                       |\n| difficulty               | The minimum shard difficulty of the previous block  | GetPrevDifficulty   | -                       |\n| ds_difficulty            | The minimum DS difficulty of the previous block     | GetPrevDSDifficulty | -                       |\n| network_id               | Network ID of current zilliqa network               | GetNetworkId        | -                       |\n| latest_txblock_timestamp | The timestamp of the latest tx block (milliseconds) | GetLatestTxBlock    | -                       |\n| latest_dsblock_timestamp | The timestamp of the latest ds block (milliseconds) | GetLatestDsBlock    | -                       |\n\n~~Mainnet Only Metrics (scheduled):~~\n\n| Metric           | Description                                    | Method                | Period |\n| :--------------- | :--------------------------------------------- | :-------------------- | :----- |\n| ud_state_size    | State data size of unstoppable domain contract | GetSmartContractState | 1h     |\n| ud_state_entries | State records of unstoppable domain contract   | GetSmartContractState | 1h     |\n\n### Admin Collector\n\nCollect info from zilliqa node's Admin API server (Status Server)\n\n| Metric          | Description                         | Method      | Additional Labels                  |\n| :-------------- | :---------------------------------- | :---------- | :--------------------------------- |\n| admin_server_up | Admin JsonRPC server up and running | -           | endpoint                           |\n| node_type       | Zilliqa network node type           | GetNodeType | text (representative of node type) |\n\nOnly for Shard Node:\n\n| Metric        | Description                                        | Method              | Additional Labels |\n| :------------ | :------------------------------------------------- | :------------------ | :---------------- |\n| shard_id      | Shard ID of the shard of current node              | GetNodeType         | -                 |\n| epoch         | Current TX block number of the node                | GetBlockchainInfo   | -                 |\n| ds_epoch      | Current DS block number of the node                | GetBlockchainInfo   | -                 |\n| difficulty    | The minimum shard difficulty of the previous block | GetPrevDifficulty   | -                 |\n| ds_difficulty | The minimum DS difficulty of the previous block    | GetPrevDSDifficulty | -                 |\n\n\nNot implemented Yet:\n\n| Metric     | Description | Method       | Additional Labels |\n| :--------- | :---------- | :----------- | :---------------- |\n| node_state | Node state  | GetNodeState | -                 |\n\n### ProcessInfo Collector\n\nGet running process information\n\n| Label         | Description               |\n| :------------ | :------------------------ |\n| process_name  | Process Name              |\n| pid           | Process ID                |\n| cwd           | Current working directory |\n\n| Metric                  | Description                                         | unit         | Additional Labels                  |\n| :---------------------- | :-------------------------------------------------- | :----------- | :--------------------------------- |\n| zilliqa_process_running | If zilliqa process is running                       | -            |                                    |\n| synctype                | Synctype from zilliqa commandline option            | -            |                                    |\n| nodetype                | Nodetype from zilliqa commandline option            | -            | text (representative of node type) |\n| nodeindex               | Nodeindex from zilliqa commandline option           | -            |                                    |\n| node_uptime             | Uptime of zilliqa node (unix timestamp)             | milliseconds |                                    |\n| connection_count        | Network Connection count of zilliqa process         | -            | local_port, status                 |\n| thread_count            | Thread count of zilliqa process                     | -            |                                    |\n| fd_count                | Opened file descriptor count of zilliqa process     | -            |                                    |\n| storage_total           | Total capacity of zilliqa persistence storage (cwd) | bytes        |                                    |\n| storage_used            | Used space of zilliqa persistence storage (cwd)     | bytes        |                                    |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fzilliqa-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzilliqa%2Fzilliqa-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fzilliqa-exporter/lists"}