diff --git a/setup/env-variables/backend-env-variables.mdx b/setup/env-variables/backend-env-variables.mdx index 6aae224..72411d6 100644 --- a/setup/env-variables/backend-env-variables.mdx +++ b/setup/env-variables/backend-env-variables.mdx @@ -52,6 +52,9 @@ title: "Backend ENVs: Common" [Addresses Blacklist management](/setup/env-variables/backend-env-variables#addresses-blacklist-management) + [Prometheus Metrics Management](/setup/env-variables/backend-env-variables#prometheus-metrics-management) + + [Backend ENVs: Chain-Specific](/setup/env-variables/backend-envs-chain-specific) [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 | `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\+
Default: `10m`
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\+
Default: `1000`
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\+
Default: (empty)
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\+
Default: `false`
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\+
Default: 24
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\+
Default: `false`
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\+
Default: `1000`
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\+
Default: `https://raw.githubusercontent.com/blockscout/backend-configs/refs/heads/main/universal-proxy-config.json`
Applications: API | @@ -653,3 +654,18 @@ Section created as a result of [#11417](https://github.com/blockscout/blockscout | `ADDRESSES_BLACKLIST_URL` | URL to fetch blacklist from | Version: v6.10.0\+
Default: (empty)
Applications: API | | `ADDRESSES_BLACKLIST_UPDATE_INTERVAL` | Interval between scheduled updates of blacklist | Version: v6.10.0\+
Default: `15m`
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\+
Default: `5s`
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\+
Default: `false`
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\+
Default: 24
Applications: API | +| `INDEXER_METRICS_ENABLED` | Flag to enable base indexer metrics. Implemented in [#13539](https://github.com/blockscout/blockscout/pull/13539). | Version: master
Default: true
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
Default: false
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
Default: true
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
Default: true
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
Default: true
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
Default: true
Applications: Indexer | +