Skip to content

Enable indexer Prometheus metrics #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 25, 2025
Merged

Enable indexer Prometheus metrics #74

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22394da
Enable indexer Prometheus metrics
vbaranov Nov 19, 2025
a9e47b6
Apply suggestions from code review
vbaranov Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions setup/env-variables/backend-env-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@

[Addresses Blacklist management](/setup/env-variables/backend-env-variables#addresses-blacklist-management)

[Prometheus Metrics Management](/setup/env-variables/backend-env-variables#prometheus-metrics-management)
</Card>
<Card>
[Backend ENVs: Chain-Specific](/setup/env-variables/backend-envs-chain-specific)

[Backend ENVs: Integrations](/setup/env-variables/backend-envs-integrations)
Expand Down Expand Up @@ -150,13 +153,11 @@
| `ADDRESSES_TABS_COUNTERS_TTL` | TTL for cached tabs counters (works only for counters which are \< 51, if counter \>= 51, then ttl == :infinity). Implemented in [#8512](https://github.com/blockscout/blockscout/pull/8512) | Version: v5.3.0\+ <br />Default: `10m` <br />Applications: API |
| `API_INTERNAL_TRANSACTIONS_INDEXING_FINISHED_THRESHOLD` | In the case when the 1st tx in the chain already has internal transactions, If the number of blocks in `pending_block_operations` is less than the value in this env var, Blockscout will consider that indexing of internal transactions is finished, otherwise, it will consider that indexing is still taking place and the indexing banner will appear at the top. Implemented in [#7576](https://github.com/blockscout/blockscout/pull/7576). | Version: v5.2.0\+ <br />Default: `1000` <br />Applications: API |
| `DATABASE_EVENT_URL` | Variable to define the Postgres Database endpoint that will be used by event listener process. Applicable for separate indexer and API setup. More info in related PR. Implemented in [#10164](https://github.com/blockscout/blockscout/pull/10164). | Version: v6.8.0\+ <br />Default: (empty) <br />Applications: API |
| `PUBLIC_METRICS_ENABLED` | Variable to enable running queries at /public-metrics endpoint. Implemented in [#10469](https://github.com/blockscout/blockscout/pull/10469). | Version: v6.8.0\+ <br />Default: `false` <br />Applications: API |
| `PUBLIC_METRICS_UPDATE_PERIOD_HOURS` | Public metrics update period in hours at /public-metrics endpoint. Implemented in [#10469](https://github.com/blockscout/blockscout/pull/10469). | Version: v6.8.0\+ <br />Default: 24 <br />Applications: API |
| `SHRINK_INTERNAL_TRANSACTIONS_ENABLED` | Variable to enable internal transactions shrinking logic. Implemented in [#10567](https://github.com/blockscout/blockscout/pull/10567). | Version: v6.8.0\+ <br />Default: `false` <br />Applications: API, Indexer |
| `HACKNEY_DEFAULT_POOL_SIZE` | Size of `default` hackney pool. Implemented in [#12406](https://github.com/blockscout/blockscout/pull/12406). | Version: v8.1.0\+ <br />Default: `1000` <br />Applications: API, Indexer |
| `UNIVERSAL_PROXY_CONFIG_URL` | Config URL for universal proxy. Implemented in [#12442](https://github.com/blockscout/blockscout/pull/12442). | Version: v8.1.0\+ <br />Default: `https://raw.githubusercontent.com/blockscout/backend-configs/refs/heads/main/universal-proxy-config.json` <br />Applications: API |
| `DATABASE_EVENT_POOL_SIZE` | Variable to define the pool size for DB repo `DATABASE_EVENT_URL`. Applicable for separate indexer and API setup. Implemented in [#13064](https://github.com/blockscout/blockscout/pull/13064). | Version: v9.1.0\+ <br />Default: 10<br />Applications: API, Indexer |
| `K8S_SERVICE` | Kubernetes service name for Elixir nodes clusterization, more info on how to configure it can be found here https://hexdocs.pm/libcluster/Cluster.Strategy.Kubernetes.DNS.html. Implemented in [#13080](https://github.com/blockscout/blockscout/pull/13080). | Version: v9.2.0\+ <br />Default: (empty) <br />Applications: API, Indexer |

Check warning on line 160 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L160 

Did you really mean 'clusterization'?

Check warning on line 160 in setup/env-variables/backend-env-variables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (blockscout-main) - vale-spellcheck

setup/env-variables/backend-env-variables.mdx#L160 

Did you really mean 'clusterization'?

## Indexer Management

Expand Down Expand Up @@ -653,3 +654,18 @@
| `ADDRESSES_BLACKLIST_URL` | URL to fetch blacklist from | Version: v6.10.0\+ <br />Default: (empty) <br />Applications: API |
| `ADDRESSES_BLACKLIST_UPDATE_INTERVAL` | Interval between scheduled updates of blacklist | Version: v6.10.0\+ <br />Default: `15m` <br />Applications: API |
| `ADDRESSES_BLACKLIST_RETRY_INTERVAL` | Time to wait before new attempt of blacklist fetching, after abnormal termination of fetching task | Version: v6.10.0\+ <br />Default: `5s` <br />Applications: API |


## Prometheus Metrics Management

| Variable | Description | Parameters |
| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `PUBLIC_METRICS_ENABLED` | Enables the `/public-metrics` endpoint. Implemented in [#10469](https://github.com/blockscout/blockscout/pull/10469). | Version: v6.8.0\+ <br />Default: `false` <br />Applications: API |
| `PUBLIC_METRICS_UPDATE_PERIOD_HOURS` | Update frequency (in hours) for refreshing data at the `/public-metrics` endpoint. Implemented in [#10469](https://github.com/blockscout/blockscout/pull/10469). | Version: v6.8.0\+ <br />Default: 24 <br />Applications: API |
| `INDEXER_METRICS_ENABLED` | Flag to enable base indexer metrics. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: master <br />Default: true <br />Applications: Indexer |
| `INDEXER_METRICS_ENABLED_TOKEN_INSTANCES_NOT_UPLOADED_TO_CDN_COUNT` | Flag to enable indexer metric: the count of token instances not uploaded to CDN. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: master <br />Default: false <br />Applications: Indexer |
| `INDEXER_METRICS_ENABLED_FAILED_TOKEN_INSTANCES_METADATA_COUNT` | Flag to enable indexer metric: the count of token instances with failed metadata fetches. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: master <br />Default: true <br />Applications: Indexer |
| `INDEXER_METRICS_ENABLED_UNFETCHED_TOKEN_INSTANCES_COUNT` | Flag to enable indexer metric: the count of token instances pending to fetch. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: master <br />Default: true <br />Applications: Indexer |
| `INDEXER_METRICS_ENABLED_MISSING_CURRENT_TOKEN_BALANCES_COUNT` | Flag to enable indexer metric: the count of current token balances with missing values. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: master <br />Default: true <br />Applications: Indexer |
| `INDEXER_METRICS_ENABLED_MISSING_ARCHIVAL_TOKEN_BALANCES_COUNT` | Flag to enable indexer metric: the count of archival token balances with missing values. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: master <br />Default: true <br />Applications: Indexer |