Feature flags set in
advanced config section allow users to modify parameters that affect the behavior of the whole framework. Choosing the right combination of flags for an indexer project can improve performance, reduce RAM consumption, or enable useful features.
|Enable sending crash reports to the Baking Bad team
|Start collecting realtime messages while sync is in progress
|Subscribe to all operations/big map diffs during realtime indexing
|Enable contract and token metadata interfaces
|Do not start the job scheduler until all indexes are synchronized
|Disable warning about running unstable or out-of-date DipDup version
Enables sending crash reports to the Baking Bad team. This is disabled by default. You can inspect crash dumps saved as
/tmp/dipdup/crashdumps/XXXXXXX.json before enabling this option.
By default, DipDup enters a sync state twice: before and after establishing a realtime connection. This flag allows collecting realtime messages while the sync is in progress, right after indexes load.
Let's consider two scenarios:
Indexing 10 contracts with 10 000 operations each. Initial indexing could take several hours. There is no need to accumulate incoming operations since resync time after establishing a realtime connection depends on the contract number, thus taking a negligible amount of time.
Indexing 10 000 contracts with 10 operations each. Both initial sync and resync will take a while. But the number of operations received during this time won't affect RAM consumption much.
If you do not have strict RAM constraints, it's recommended to enable this flag. You'll get faster indexing times and decreased load on TzKT API.
Subscribe to all operations/big map diffs during realtime indexing instead of separate channels. This flag helps to avoid the 10.000 subscription limit of TzKT and speed up processing. The downside is an increased RAM consumption during sync, especially if
early_realtime flag is enabled too.
Without this flag calling
ctx.update_token_metadata methods will have no effect. Corresponding internal tables are created on reindexing in any way.
Do not start the job scheduler until all indexes are synchronized. If your jobs perform some calculations that make sense only after the indexer has reached realtime, this toggle can save you some IOPS.
Disables warning about running unstable or out-of-date DipDup version.
DipDup uses multiple environment variables internally. They read once on process start and usually do not change during runtime. Some variables modify the framework's behavior, while others are informational.
Please note that they are not currently a part of the public API and can be changed without notice.
|Running in GitHub Actions
|Running in Docker
|Base image used when building Docker image (default, slim or pytezos)
|Enable features thar require schema changes
|Path to the currently used package
|Path to datasource replay files; used in tests
|Running in pytest
DIPDUP_NEXT flag will give you the picture of what's coming in the next major release, but enabling it on existing schema will trigger a reindexing.