Skip to content

Commit 8d290a9

Browse files
vbaranovvbaranov
authored
Merge pull request #74 from blockscout/vb-enable-indexer-metrics
Enable indexer Prometheus metrics
2 parents be2d998 + a9e47b6 commit 8d290a9

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

‎setup/env-variables/backend-env-variables.mdx‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ title: "Backend ENVs: Common"
5252

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

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

5760
[Backend ENVs: Integrations](/setup/env-variables/backend-envs-integrations)
@@ -150,8 +153,6 @@ Can be set in format `1h` for 1 hour, `1m` for 1 minute, `1s` or `1` for 1 secon
150153
| `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 |
151154
| `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 |
152155
| `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 |
153-
| `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 |
154-
| `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 |
155156
| `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 |
156157
| `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 |
157158
| `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 |
@@ -654,3 +655,18 @@ Section created as a result of [#11417](https://github.com/blockscout/blockscout
654655
| `ADDRESSES_BLACKLIST_URL` | URL to fetch blacklist from | Version: v6.10.0\+ <br />Default: (empty) <br />Applications: API |
655656
| `ADDRESSES_BLACKLIST_UPDATE_INTERVAL` | Interval between scheduled updates of blacklist | Version: v6.10.0\+ <br />Default: `15m` <br />Applications: API |
656657
| `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 |
658+
659+
660+
## Prometheus Metrics Management
661+
662+
| Variable | Description | Parameters |
663+
| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
664+
| `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 |
665+
| `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 |
666+
| `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 |
667+
| `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 |
668+
| `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 |
669+
| `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 |
670+
| `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 |
671+
| `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 |
672+

0 commit comments

Comments
 (0)