indexer-alt: generate example config #20464
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Skipped Deployments
|
amnn
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
8 tasks
bmwill
approved these changes
Nov 28, 2024
## Description Using the default impl for `IndexerConfig` to generate the output for `generate-config` lead to sub-par results because most of its fields are optional, and so will not show up. This change introduces an explicit `example` function that is responsible for generating a non-default output that does a better job of documenting what fields and pipelines are available to configure. ## Test plan Generate a config: ``` sui$ cargo run -p sui-indexer-alt -- generate-config [ingestion] checkpoint-buffer-size = 5000 ingest-concurrency = 200 retry-interval-ms = 200 [consistency] consistent-pruning-interval-ms = 300000 pruner-delay-ms = 120000 [committer] write-concurrency = 5 collect-interval-ms = 500 watermark-interval-ms = 500 [pruner] interval-ms = 300000 delay-ms = 120000 retention = 4000000 max-chunk-size = 2000 [pipeline.sum_coin_balances] [pipeline.wal_coin_balances] [pipeline.sum_obj_types] [pipeline.wal_obj_types] [pipeline.sum_displays] [pipeline.sum_packages] [pipeline.ev_emit_mod] [pipeline.ev_struct_inst] [pipeline.kv_checkpoints] [pipeline.kv_epoch_ends] [pipeline.kv_epoch_starts] [pipeline.kv_feature_flags] [pipeline.kv_objects] [pipeline.kv_protocol_configs] [pipeline.kv_transactions] [pipeline.obj_versions] [pipeline.tx_affected_addresses] [pipeline.tx_affected_objects] [pipeline.tx_balance_changes] [pipeline.tx_calls] [pipeline.tx_digests] [pipeline.tx_kinds] ```
## Description Replace use of macros with a `Merge` trait. ## Test plan CI
## Description Avoid catch-all (`..`) patterns, and be explicit about the `extra` pattern, so that if we introduce new fields in future, we notice. ## Test plan CI
amnn
force-pushed
the
amnn/idx-eg-cfg
branch
from
198ce46 to
18b79b7
Compare
amnn
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Using the default impl for
IndexerConfigto generate the output forgenerate-configlead to sub-par results because most of its fields are optional, and so will not show up.This change introduces an explicit
examplefunction that is responsible for generating a non-default output that does a better job of documenting what fields and pipelines are available to configure.Test plan
Generate a config:
Stack
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.