Documentation Index
Fetch the complete documentation index at: https://docs.canton.network/llms.txt
Use this file to discover all available pages before exploring further.
Configuration options
./scribe.jar pipeline parameters
| Parameter | Description |
|---|---|
--config file | Path to configuration overrides via an external HOCON file (optional) • Environment variable: SCRIBE_CONFIG• System property: config |
--pipeline-datasource enum | Ledger API service to use as data source (default: TransactionStream) • Environment variable: SCRIBE_PIPELINE_DATASOURCE• System property: pipeline.datasource• Enumeration values: TransactionStream, TransactionTreeStream |
--pipeline-oauth-clientid string | Client’s identifier (optional) • Environment variable: SCRIBE_PIPELINE_OAUTH_CLIENTID• System property: pipeline.oauth.clientId |
--pipeline-oauth-accesstoken string | Access token (optional) • Environment variable: SCRIBE_PIPELINE_OAUTH_ACCESSTOKEN• System property: pipeline.oauth.accessToken |
--pipeline-oauth-scope [enum | string] | Token scope (default: Default) • Environment variable: SCRIBE_PIPELINE_OAUTH_SCOPE• System property: pipeline.oauth.scope• Enumeration values: Default, None |
--pipeline-oauth-parameters map | Custom parameters • Environment variable: SCRIBE_PIPELINE_OAUTH_PARAMETERS• System property: pipeline.oauth.parameters |
--pipeline-oauth-preemptexpiry string | The duration (ISO 8601) prior to expiry of current, for a new token to be requested (default: PT1M) • Environment variable: SCRIBE_PIPELINE_OAUTH_PREEMPTEXPIRY• System property: pipeline.oauth.preemptExpiry |
--pipeline-oauth-cafile file | Trusted Certificate Authority (CA) certificate (optional) • Environment variable: SCRIBE_PIPELINE_OAUTH_CAFILE• System property: pipeline.oauth.cafile |
--pipeline-oauth-endpoint uri | Token endpoint URL (optional) • Environment variable: SCRIBE_PIPELINE_OAUTH_ENDPOINT• System property: pipeline.oauth.endpoint |
--pipeline-oauth-issuer uri | OIDC-compliant issuer URL (optional) • Environment variable: SCRIBE_PIPELINE_OAUTH_ISSUER• System property: pipeline.oauth.issuer |
--pipeline-oauth-clientsecret string | Client’s secret (optional) • Environment variable: SCRIBE_PIPELINE_OAUTH_CLIENTSECRET• System property: pipeline.oauth.clientSecret |
--pipeline-filter-parties string | Filter expression determining Daml party identifiers to filter on (default: *) • Environment variable: SCRIBE_PIPELINE_FILTER_PARTIES• System property: pipeline.filter.parties |
--pipeline-filter-metadata string | Filter expression determining which templates and interfaces to capture metadata for (default: !*) • Environment variable: SCRIBE_PIPELINE_FILTER_METADATA• System property: pipeline.filter.metadata |
--pipeline-filter-contracts string | Filter expression determining which templates and interfaces to include (default: *) • Environment variable: SCRIBE_PIPELINE_FILTER_CONTRACTS• System property: pipeline.filter.contracts |
--pipeline-ledger-start [enum | string] | Start offset (default: Latest) • Environment variable: SCRIBE_PIPELINE_LEDGER_START• System property: pipeline.ledger.start• Enumeration values: Genesis, Oldest, Latest |
--pipeline-ledger-stop [enum | string] | Stop offset (default: Never) • Environment variable: SCRIBE_PIPELINE_LEDGER_STOP• System property: pipeline.ledger.stop• Enumeration values: Latest, Never |
--retry-backoff-base string | Base time (ISO 8601) for backoff retry strategy (default: PT1S) • Environment variable: SCRIBE_RETRY_BACKOFF_BASE• System property: retry.backoff.base |
--retry-backoff-cap string | Max duration (ISO 8601) between attempts (default: PT1M) • Environment variable: SCRIBE_RETRY_BACKOFF_CAP• System property: retry.backoff.cap |
--retry-backoff-factor double | Factor for backoff retry strategy (default: 2.0) • Environment variable: SCRIBE_RETRY_BACKOFF_FACTOR• System property: retry.backoff.factor |
--retry-counter-attempts int | Max attempts before giving up (optional) • Environment variable: SCRIBE_RETRY_COUNTER_ATTEMPTS• System property: retry.counter.attempts |
--retry-counter-reset string | Reset retry counters after period (ISO 8601) of stability (default: PT10M) • Environment variable: SCRIBE_RETRY_COUNTER_RESET• System property: retry.counter.reset |
--retry-counter-duration string | Time limit (ISO 8601) before giving up (optional) • Environment variable: SCRIBE_RETRY_COUNTER_DURATION• System property: retry.counter.duration |
--health-address string | Hostname or IP to bind HTTP health info service to (default: 127.0.0.1) • Environment variable: SCRIBE_HEALTH_ADDRESS• System property: health.address |
--health-port int | HTTP port to use to expose application health info (default: 8080) • Environment variable: SCRIBE_HEALTH_PORT• System property: health.port |
--logger-level enum | Log level (default: Info) • Environment variable: SCRIBE_LOGGER_LEVEL• System property: logger.level• Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None |
--logger-mappings map | Custom mappings for log levels • Environment variable: SCRIBE_LOGGER_MAPPINGS• System property: logger.mappings |
--logger-format enum | Log output format (default: Plain) • Environment variable: SCRIBE_LOGGER_FORMAT• System property: logger.format• Enumeration values: Plain, Json |
--logger-pattern [enum | string] | Log pattern (default: Plain) • Environment variable: SCRIBE_LOGGER_PATTERN• System property: logger.pattern• Enumeration values: Plain, Standard, Structured |
--target-postgres-host string | Postgres host (default: localhost) • Environment variable: SCRIBE_TARGET_POSTGRES_HOST• System property: target.postgres.host |
--target-postgres-appname string | Application name for Postgres connections (default: scribe) • Environment variable: SCRIBE_TARGET_POSTGRES_APPNAME• System property: target.postgres.appName |
--target-postgres-buffersize int | Buffer size for transactions processing (default: 128) • Environment variable: SCRIBE_TARGET_POSTGRES_BUFFERSIZE• System property: target.postgres.bufferSize |
--target-postgres-tls-mode enum | SSL mode required for Postgres connectivity (default: Disable) • Environment variable: SCRIBE_TARGET_POSTGRES_TLS_MODE• System property: target.postgres.tls.mode• Enumeration values: Disable, Require, VerifyCA, VerifyFull |
--target-postgres-tls-cert file | Client’s certificate (optional) • Environment variable: SCRIBE_TARGET_POSTGRES_TLS_CERT• System property: target.postgres.tls.cert |
--target-postgres-tls-key file | Client’s private key (optional) • Environment variable: SCRIBE_TARGET_POSTGRES_TLS_KEY• System property: target.postgres.tls.key |
--target-postgres-tls-cafile file | Trusted Certificate Authority (CA) certificate (optional) • Environment variable: SCRIBE_TARGET_POSTGRES_TLS_CAFILE• System property: target.postgres.tls.cafile |
--target-postgres-keepalive boolean | Enable/disable TCP keep-alive probe (default: true) • Environment variable: SCRIBE_TARGET_POSTGRES_KEEPALIVE• System property: target.postgres.keepAlive |
--target-postgres-maxconnections int | Maximum number of JDBC connections (default: 16) • Environment variable: SCRIBE_TARGET_POSTGRES_MAXCONNECTIONS• System property: target.postgres.maxConnections |
--target-postgres-password string | Postgres user password (default: ********) • Environment variable: SCRIBE_TARGET_POSTGRES_PASSWORD• System property: target.postgres.password |
--target-postgres-username string | Postgres user name (default: postgres) • Environment variable: SCRIBE_TARGET_POSTGRES_USERNAME• System property: target.postgres.username |
--target-postgres-database string | Postgres database (default: postgres) • Environment variable: SCRIBE_TARGET_POSTGRES_DATABASE• System property: target.postgres.database |
--target-postgres-schema string | Postgres schema (default: public) • Environment variable: SCRIBE_TARGET_POSTGRES_SCHEMA• System property: target.postgres.schema |
--target-postgres-port int | Postgres port (default: 5432) • Environment variable: SCRIBE_TARGET_POSTGRES_PORT• System property: target.postgres.port |
--target-encoding-numericasstring boolean | Encode numeric as string instead of JSON number (default: true) • Environment variable: SCRIBE_TARGET_ENCODING_NUMERICASSTRING • System property: target.encoding.numericAsString |
--target-encoding-excludenulls boolean | Omit fields with NULL values from resulting JSON (default: false) • Environment variable: SCRIBE_TARGET_ENCODING_EXCLUDENULLS • System property: target.encoding.excludeNulls |
--target-encoding-int64asstring boolean | Encode int64 as string instead of JSON number (default: true) • Environment variable: SCRIBE_TARGET_ENCODING_INT64ASSTRING • System property: target.encoding.int64AsString |
--target-schema-autoapply boolean | Apply metadata inferred schema on startup (default: true) • Environment variable: SCRIBE_TARGET_SCHEMA_AUTOAPPLY• System property: target.schema.autoApply |
--target-schema-baseline boolean | Baseline existing database schema during apply (default: false) • Environment variable: SCRIBE_TARGET_SCHEMA_BASELINE• System property: target.schema.baseline |
--source-ledger-host string | Ledger API host (default: localhost) • Environment variable: SCRIBE_SOURCE_LEDGER_HOST• System property: source.ledger.host |
--source-ledger-cachedir file | Cache Directory (default: /tmp/scribe) • Environment variable: SCRIBE_SOURCE_LEDGER_CACHEDIR• System property: source.ledger.cacheDir |
--source-ledger-buffersize int | Buffer size for gRPC channel (default: 128) • Environment variable: SCRIBE_SOURCE_LEDGER_BUFFERSIZE• System property: source.ledger.bufferSize |
--source-ledger-keepalive-time string | Duration (ISO 8601) of interval between ping frames (PT0S to disable) (default: PT40S) • Environment variable: SCRIBE_SOURCE_LEDGER_KEEPALIVE_TIME• System property: source.ledger.keepAlive.time |
--source-ledger-keepalive-timeout string | Duration (ISO 8601) of timeout for a ping frame to be acknowledged (default: PT20S) • Environment variable: SCRIBE_SOURCE_LEDGER_KEEPALIVE_TIMEOUT• System property: source.ledger.keepAlive.timeout |
--source-ledger-auth enum | Authorisation mode (default: NoAuth) • Environment variable: SCRIBE_SOURCE_LEDGER_AUTH• System property: source.ledger.auth• Enumeration values: OAuth, NoAuth |
--source-ledger-tls-cafile file | Trusted Certificate Authority (CA) certificate (optional) • Environment variable: SCRIBE_SOURCE_LEDGER_TLS_CAFILE• System property: source.ledger.tls.cafile |
--source-ledger-tls-cert file | Client’s certificate (leave empty if embedded into private key file) (optional) • Environment variable: SCRIBE_SOURCE_LEDGER_TLS_CERT• System property: source.ledger.tls.cert |
--source-ledger-tls-key file | Client’s private key (leave empty for server-only TLS) (optional) • Environment variable: SCRIBE_SOURCE_LEDGER_TLS_KEY• System property: source.ledger.tls.key |
--source-ledger-port int | Ledger API port (default: 6865) • Environment variable: SCRIBE_SOURCE_LEDGER_PORT• System property: source.ledger.port |
./scribe.jar datastore postgres-document prune parameters
| Parameter | Description |
|---|---|
--config file | Path to configuration overrides via an external HOCON file (optional) • Environment variable: SCRIBE_CONFIG• System property: config |
--prune-target string | Inclusive boundary up to which to prune. Can be an offset, timestamp (ISO 8601) or duration (ISO 8601) • Environment variable: SCRIBE_PRUNE_TARGET• System property: prune.target |
--prune-mode enum | Precomputes effects of pruning through dry-run, or actually runs it (default: DryRun) • Environment variable: SCRIBE_PRUNE_MODE• System property: prune.mode• Enumeration values: DryRun, Force |
--logger-destination file | Log output file (default: output.log) • Environment variable: SCRIBE_LOGGER_DESTINATION• System property: logger.destination |
--logger-mappings map | Custom mappings for log levels • Environment variable: SCRIBE_LOGGER_MAPPINGS• System property: logger.mappings |
--logger-format enum | Log output format (default: Plain) • Environment variable: SCRIBE_LOGGER_FORMAT• System property: logger.format• Enumeration values: Plain, PlainAsync, Json, JsonAsync |
--logger-pattern [enum | string] | Log pattern (default: Plain) • Environment variable: SCRIBE_LOGGER_PATTERN• System property: logger.pattern• Enumeration values: Plain, Standard, Structured |
--logger-level enum | Log level (default: Info) • Environment variable: SCRIBE_LOGGER_LEVEL• System property: logger.level• Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None |
--postgres-host string | Postgres host (default: localhost) • Environment variable: SCRIBE_POSTGRES_HOST• System property: postgres.host |
--postgres-appname string | Application name for Postgres connections (default: scribe) • Environment variable: SCRIBE_POSTGRES_APPNAME• System property: postgres.appName |
--postgres-buffersize int | Buffer size for transactions processing (default: 128) • Environment variable: SCRIBE_POSTGRES_BUFFERSIZE• System property: postgres.bufferSize |
--postgres-tls-mode enum | SSL mode required for Postgres connectivity (default: Disable) • Environment variable: SCRIBE_POSTGRES_TLS_MODE• System property: postgres.tls.mode• Enumeration values: Disable, Require, VerifyCA, VerifyFull |
--postgres-tls-cert file | Client’s certificate (optional) • Environment variable: SCRIBE_POSTGRES_TLS_CERT• System property: postgres.tls.cert |
--postgres-tls-key file | Client’s private key (optional) • Environment variable: SCRIBE_POSTGRES_TLS_KEY• System property: postgres.tls.key |
--postgres-tls-cafile file | Trusted Certificate Authority (CA) certificate (optional) • Environment variable: SCRIBE_POSTGRES_TLS_CAFILE• System property: postgres.tls.cafile |
--postgres-keepalive boolean | Enable/disable TCP keep-alive probe (default: true) • Environment variable: SCRIBE_POSTGRES_KEEPALIVE• System property: postgres.keepAlive |
--postgres-maxconnections int | Maximum number of JDBC connections (default: 16) • Environment variable: SCRIBE_POSTGRES_MAXCONNECTIONS• System property: postgres.maxConnections |
--postgres-password string | Postgres user password (default: ********) • Environment variable: SCRIBE_POSTGRES_PASSWORD• System property: postgres.password |
--postgres-username string | Postgres user name (default: postgres) • Environment variable: SCRIBE_POSTGRES_USERNAME• System property: postgres.username |
--postgres-schema string | Postgres schema (default: public) • Environment variable: SCRIBE_POSTGRES_SCHEMA• System property: postgres.schema |
--postgres-database string | Postgres database (default: postgres) • Environment variable: SCRIBE_POSTGRES_DATABASE• System property: postgres.database |
--postgres-port int | Postgres port (default: 5432) • Environment variable: SCRIBE_POSTGRES_PORT• System property: postgres.port |
./scribe.jar datastore postgres-document schema show parameters
| Parameter | Description |
|---|---|
--config file | Path to configuration overrides via an external HOCON file (optional) • Environment variable: SCRIBE_CONFIG• System property: config |
--ledger-host string | Ledger API host (default: localhost) • Environment variable: SCRIBE_LEDGER_HOST• System property: ledger.host |
--ledger-cachedir file | Cache Directory (default: /tmp/scribe) • Environment variable: SCRIBE_LEDGER_CACHEDIR• System property: ledger.cacheDir |
--ledger-buffersize int | Buffer size for gRPC channel (default: 128) • Environment variable: SCRIBE_LEDGER_BUFFERSIZE• System property: ledger.bufferSize |
--ledger-keepalive-time string | Duration (ISO 8601) of interval between ping frames (PT0S to disable) (default: PT40S) • Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIME• System property: ledger.keepAlive.time |
--ledger-keepalive-timeout string | Duration (ISO 8601) of timeout for a ping frame to be acknowledged (default: PT20S) • Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIMEOUT• System property: ledger.keepAlive.timeout |
--ledger-auth enum | Authorisation mode (default: NoAuth) • Environment variable: SCRIBE_LEDGER_AUTH• System property: ledger.auth• Enumeration values: OAuth, NoAuth |
--ledger-tls-cafile file | Trusted Certificate Authority (CA) certificate (optional) • Environment variable: SCRIBE_LEDGER_TLS_CAFILE• System property: ledger.tls.cafile |
--ledger-tls-cert file | Client’s certificate (leave empty if embedded into private key file) (optional) • Environment variable: SCRIBE_LEDGER_TLS_CERT• System property: ledger.tls.cert |
--ledger-tls-key file | Client’s private key (leave empty for server-only TLS) (optional) • Environment variable: SCRIBE_LEDGER_TLS_KEY• System property: ledger.tls.key |
--ledger-port int | Ledger API port (default: 6865) • Environment variable: SCRIBE_LEDGER_PORT• System property: ledger.port |
--logger-destination file | Log output file (default: output.log) • Environment variable: SCRIBE_LOGGER_DESTINATION• System property: logger.destination |
--logger-mappings map | Custom mappings for log levels • Environment variable: SCRIBE_LOGGER_MAPPINGS• System property: logger.mappings |
--logger-format enum | Log output format (default: Plain) • Environment variable: SCRIBE_LOGGER_FORMAT• System property: logger.format• Enumeration values: Plain, PlainAsync, Json, JsonAsync |
--logger-pattern [enum | string] | Log pattern (default: Plain) • Environment variable: SCRIBE_LOGGER_PATTERN• System property: logger.pattern• Enumeration values: Plain, Standard, Structured |
--logger-level enum | Log level (default: Info) • Environment variable: SCRIBE_LOGGER_LEVEL• System property: logger.level• Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None |
--filter-contracts string | Filter expression determining which templates and interfaces to include (default: *) • Environment variable: SCRIBE_FILTER_CONTRACTS• System property: filter.contracts |
--oauth-clientid string | Client’s identifier (optional) • Environment variable: SCRIBE_OAUTH_CLIENTID• System property: oauth.clientId |
--oauth-accesstoken string | Access token (optional) • Environment variable: SCRIBE_OAUTH_ACCESSTOKEN• System property: oauth.accessToken |
--oauth-scope [enum | string] | Token scope (default: Default) • Environment variable: SCRIBE_OAUTH_SCOPE• System property: oauth.scope• Enumeration values: Default, None |
--oauth-parameters map | Custom parameters • Environment variable: SCRIBE_OAUTH_PARAMETERS• System property: oauth.parameters |
--oauth-preemptexpiry string | The duration (ISO 8601) prior to expiry of current, for a new token to be requested (default: PT1M) • Environment variable: SCRIBE_OAUTH_PREEMPTEXPIRY• System property: oauth.preemptExpiry |
--oauth-cafile file | Trusted Certificate Authority (CA) certificate (optional) • Environment variable: SCRIBE_OAUTH_CAFILE• System property: oauth.cafile |
--oauth-endpoint uri | Token endpoint URL (optional) • Environment variable: SCRIBE_OAUTH_ENDPOINT• System property: oauth.endpoint |
--oauth-issuer uri | OIDC-compliant issuer URL (optional) • Environment variable: SCRIBE_OAUTH_ISSUER• System property: oauth.issuer |
--oauth-clientsecret string | Client’s secret (optional) • Environment variable: SCRIBE_OAUTH_CLIENTSECRET• System property: oauth.clientSecret |
./scribe.jar datastore postgres-document schema apply parameters
| Parameter | Description |
|---|---|
--config file | Path to configuration overrides via an external HOCON file (optional) • Environment variable: SCRIBE_CONFIG• System property: config |
--ledger-host string | Ledger API host (default: localhost) • Environment variable: SCRIBE_LEDGER_HOST• System property: ledger.host |
--ledger-cachedir file | Cache Directory (default: /tmp/scribe) • Environment variable: SCRIBE_LEDGER_CACHEDIR• System property: ledger.cacheDir |
--ledger-buffersize int | Buffer size for gRPC channel (default: 128) • Environment variable: SCRIBE_LEDGER_BUFFERSIZE• System property: ledger.bufferSize |
--ledger-keepalive-time string | Duration (ISO 8601) of interval between ping frames (PT0S to disable) (default: PT40S) • Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIME• System property: ledger.keepAlive.time |
--ledger-keepalive-timeout string | Duration (ISO 8601) of timeout for a ping frame to be acknowledged (default: PT20S) • Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIMEOUT• System property: ledger.keepAlive.timeout |
--ledger-auth enum | Authorisation mode (default: NoAuth) • Environment variable: SCRIBE_LEDGER_AUTH• System property: ledger.auth• Enumeration values: OAuth, NoAuth |
--ledger-tls-cafile file | Trusted Certificate Authority (CA) certificate (optional) • Environment variable: SCRIBE_LEDGER_TLS_CAFILE• System property: ledger.tls.cafile |
--ledger-tls-cert file | Client’s certificate (leave empty if embedded into private key file) (optional) • Environment variable: SCRIBE_LEDGER_TLS_CERT• System property: ledger.tls.cert |
--ledger-tls-key file | Client’s private key (leave empty for server-only TLS) (optional) • Environment variable: SCRIBE_LEDGER_TLS_KEY• System property: ledger.tls.key |
--ledger-port int | Ledger API port (default: 6865) • Environment variable: SCRIBE_LEDGER_PORT• System property: ledger.port |
--logger-destination file | Log output file (default: output.log) • Environment variable: SCRIBE_LOGGER_DESTINATION• System property: logger.destination |
--logger-mappings map | Custom mappings for log levels • Environment variable: SCRIBE_LOGGER_MAPPINGS• System property: logger.mappings |
--logger-format enum | Log output format (default: Plain) • Environment variable: SCRIBE_LOGGER_FORMAT• System property: logger.format• Enumeration values: Plain, PlainAsync, Json, JsonAsync |
--logger-pattern [enum | string] | Log pattern (default: Plain) • Environment variable: SCRIBE_LOGGER_PATTERN• System property: logger.pattern• Enumeration values: Plain, Standard, Structured |
--logger-level enum | Log level (default: Info) • Environment variable: SCRIBE_LOGGER_LEVEL• System property: logger.level• Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None |
--filter-contracts string | Filter expression determining which templates and interfaces to include (default: *) • Environment variable: SCRIBE_FILTER_CONTRACTS• System property: filter.contracts |
--schema-autoapply boolean | Apply metadata inferred schema on startup (default: true) • Environment variable: SCRIBE_SCHEMA_AUTOAPPLY• System property: schema.autoApply |
--schema-baseline boolean | Baseline existing database schema during apply (default: false) • Environment variable: SCRIBE_SCHEMA_BASELINE• System property: schema.baseline |
--postgres-host string | Postgres host (default: localhost) • Environment variable: SCRIBE_POSTGRES_HOST• System property: postgres.host |
--postgres-appname string | Application name for Postgres connections (default: scribe) • Environment variable: SCRIBE_POSTGRES_APPNAME• System property: postgres.appName |
--postgres-buffersize int | Buffer size for transactions processing (default: 128) • Environment variable: SCRIBE_POSTGRES_BUFFERSIZE• System property: postgres.bufferSize |
--postgres-tls-mode enum | SSL mode required for Postgres connectivity (default: Disable) • Environment variable: SCRIBE_POSTGRES_TLS_MODE• System property: postgres.tls.mode• Enumeration values: Disable, Require, VerifyCA, VerifyFull |
--postgres-tls-cert file | Client’s certificate (optional) • Environment variable: SCRIBE_POSTGRES_TLS_CERT• System property: postgres.tls.cert |
--postgres-tls-key file | Client’s private key (optional) • Environment variable: SCRIBE_POSTGRES_TLS_KEY• System property: postgres.tls.key |
--postgres-tls-cafile file | Trusted Certificate Authority (CA) certificate (optional) • Environment variable: SCRIBE_POSTGRES_TLS_CAFILE• System property: postgres.tls.cafile |
--postgres-keepalive boolean | Enable/disable TCP keep-alive probe (default: true) • Environment variable: SCRIBE_POSTGRES_KEEPALIVE• System property: postgres.keepAlive |
--postgres-maxconnections int | Maximum number of JDBC connections (default: 16) • Environment variable: SCRIBE_POSTGRES_MAXCONNECTIONS• System property: postgres.maxConnections |
--postgres-password string | Postgres user password (default: ********) • Environment variable: SCRIBE_POSTGRES_PASSWORD• System property: postgres.password |
--postgres-username string | Postgres user name (default: postgres) • Environment variable: SCRIBE_POSTGRES_USERNAME• System property: postgres.username |
--postgres-schema string | Postgres schema (default: public) • Environment variable: SCRIBE_POSTGRES_SCHEMA• System property: postgres.schema |
--postgres-database string | Postgres database (default: postgres) • Environment variable: SCRIBE_POSTGRES_DATABASE• System property: postgres.database |
--postgres-port int | Postgres port (default: 5432) • Environment variable: SCRIBE_POSTGRES_PORT• System property: postgres.port |
--oauth-clientid string | Client’s identifier (optional) • Environment variable: SCRIBE_OAUTH_CLIENTID• System property: oauth.clientId |
--oauth-accesstoken string | Access token (optional) • Environment variable: SCRIBE_OAUTH_ACCESSTOKEN• System property: oauth.accessToken |
--oauth-scope [enum | string] | Token scope (default: Default) • Environment variable: SCRIBE_OAUTH_SCOPE• System property: oauth.scope• Enumeration values: Default, None |
--oauth-parameters map | Custom parameters • Environment variable: SCRIBE_OAUTH_PARAMETERS• System property: oauth.parameters |
--oauth-preemptexpiry string | The duration (ISO 8601) prior to expiry of current, for a new token to be requested (default: PT1M) • Environment variable: SCRIBE_OAUTH_PREEMPTEXPIRY• System property: oauth.preemptExpiry |
--oauth-cafile file | Trusted Certificate Authority (CA) certificate (optional) • Environment variable: SCRIBE_OAUTH_CAFILE• System property: oauth.cafile |
--oauth-endpoint uri | Token endpoint URL (optional) • Environment variable: SCRIBE_OAUTH_ENDPOINT• System property: oauth.endpoint |
--oauth-issuer uri | OIDC-compliant issuer URL (optional) • Environment variable: SCRIBE_OAUTH_ISSUER• System property: oauth.issuer |
--oauth-clientsecret string | Client’s secret (optional) • Environment variable: SCRIBE_OAUTH_CLIENTSECRET• System property: oauth.clientSecret |
Sharing a database with application tables
An application making use of the PQS datastore may also manage its own database migrations via Flyway - either embedded, command-line, or other supported means. An example of such a scenario is the creation of application specific indexes. With default settings, the application’s Flyway produces an error similar to the one seen below because its view of available/valid migrations is different from PQS:Here, the command-line Flyway was used for demonstration purposes. The same applies to other methods of running Flyway.
Runbooks
Runbooks are recipes that provide instructions for handling common issues or tasks. They are designed to be easy to follow and should include all necessary steps to resolve an issue.PQS does not accept the passed in settings
Check if the argument in question is in the supported list of arguments by re-running the base command with:--help/-hoption for command-line arguments--help-verbose/-Hoption for command-line arguments, environment variables and Java system properties
Adjusting PQS settings dynamically (at runtime)
PQS does not allow one to adjust any of its settings on the fly. Configuration settings along with the dynamically resolved parameters (party filters, packages, templates, etc) are fixed at the start of pipeline execution. Any change requires a restart, which should be fairly cheap under normal circumstances. You might also want to re-visit the configuration warning.There is a suspicion that PQS is stalled
Check for ledger keep-alive output in the logs (frequency configured via--source-ledger-keepalive (default 40s)).
You should at least see this line repeated every 40 seconds, even if there is no new activity on the ledger:
pqs-troubleshoot-runbooks-dont-see-expected-templates-in-pqs).
If all else fails, get your hands on a thread dump (for example, through diagnostics) and analyse it for any deadlocks.
Why might it take a long time before PQS starts processing streams?
The following phases happen during PQS startup:- fetching of all DARs from the ledger
- parsing DARs locally to extract type information (cached locally for subsequent restarts)
- converting type information into codecs
- initializing DB tables and partitions corresponding to templates/interfaces and exercises
- processing ACS if applicable
- pipeline with ongoing processing starts now
- slow network
- excessive number of DARs/packages on ledger (not yet cached by PQS)
- excessive number of new templates (likely caused by Daml upgrade/migration procedures)
- the size of ACS (if applicable)
- processing from early offsets (historical data) on a very lengthy ledger (will influence until PQS catches up to the head for ongoing streaming)
Don’t see expected templates in PQS
Check that your filter’s configuration is not too restrictive. Sanity check the overall count inINFO-level logs
DEBUG level (--logger-level=Debug) will provide more detailed information about specific templates included in the synchronization pipeline:
Is it safe to change PQS --pipeline-datasource against the data store with existing data?
You might want to re-visit the configuration warning.
Debug output is too noisy
To prevent excessive output from Netty when the logging level is set toDEBUG, use the following arguments:
No data for a recently onboarded party
PQS is not notified of new parties, so it needs a restart to acknowledge the new party set. Note that the best approach when onboarding new parties is to:- stop PQS from processing the data
- onboard the new party
- start PQS processing where it left off
- purge the PQS database and re-ingest the data either from
Genesisor fromLatest(seepqs-ledger-streaming-and-recovery), or - perform a reset from a particular offset (before the offset of the first event with the new party involved) by following the instructions
PQS complains it cannot start due to various offset mismatches
PQS may fail to start due to a non-reconcilable gap in the events history (potentially caused by ledger pruning or other factors). Please, refer to these 2 sections for additional insights:pqs-history-slicingpqs-ledger-streaming-and-recovery
Is it safe to restart PQS? Can data get corrupted?
PQS was designed with failure friendliness - it does not require graceful shutdown or draining of active tasks. It is absolutely fine if the JVM process gets killed. On a restart, PQS will perform a clean-up procedure of data beyond the current watermark and then re-subscribe and continue processing from the watermark’s offset onwards (seepqs-recover).
What happens if multiple PQS instances are launched against the same data store?
In case multiple PQS instances are launched against the same data store, no data corruption happens. However, they will be competing among themselves to become the exclusive writer, so it might affect the throughput of ledger stream consumption. It is unadvisable to do so (see alsopqs-high-availability).
Which metrics are available? How to integrate them?
PQS Docker images are published with the preconfigured Prometheus endpoint (seepqs-observe). By default, it listens on 0.0.0.0:9090, so it is expected to be hooked into existing monitoring infrastructure.
To that extent, PQS releases are accompanied by dashboards that can be imported into a Grafana instance for convenient visualisation of application health.
It is highly advised to implement an observability platform in your environment. While logs help troubleshoot correctness issues, metrics are much more suitable for performance related troubleshooting.
PQS processing throughput seems low
PQS had been benchmarked against high throughput scenarios of up to 100K+ events/sec. PQS processing pipeline is just an intermediary between two data systems - ledger (Canton) and relational database (Postgres), so most likely to troubleshoot such a cause, one would need to dig into one of these endpoints. Suggested areas of attention (see alsopqs-optimize):
-
ledger
- host/OS-level metrics - CPU, I/O, RAM, etc (look for resource saturation)
- check with Canton for relevant metrics
-
Postgres
- check minimum resources requirements for Postgres
- check host/OS-level metrics - CPU, I/O, RAM, etc (look for resource saturation)
- configuration settings and non-default overrides
- metrics according to database (
pg_stat_statements,pg_stat_activity)
-
PQS
- check minimum resources requirements for PQS to avoid unexpected imbalance
- check host/OS-level metrics - CPU, I/O, RAM, etc (look for resource saturation)
-
ensure these settings are not set too low (no less than defaults)
--source-ledger-buffersize--target-postgres-buffersize--target-postgres-maxconnections(because parallel processing which affects both throughput and latency is tied to this configuration)- check vital metrics look good (
pqs-troubleshoot-runbooks-pqs-metrics-dashboard-and-how-to-read-it)
Dissecting the logs
PQS emits a healthy volume of relevant information while running intostdout stream. INFO level describes application-level events such as:
- ledger keep-alives
- lifecycle information
- authentication events
- starting conditions - offsets, current watermark, etc
- ingress of ledger events
- conversion of payloads
- watermark advancement
DEBUG and TRACE levels add supplementary troubleshooting information. Caution needs to be exercised since increasing the log level might affect performance negatively along with exposing sensitive data (contract’s contents, for instance).
PQS metrics dashboard and how to read it
PQS Dashboard is designed to read from top to bottom. It provides information from general to more specific, so it is good practice to scan through the dashboard as it goes and spot anomalies along the flow.Contracts > Churn
Per-template activity (creates/archives) on the ledger. This chart may be useful to gauge relative throughputs in business terms.
Contracts > Active
Per-template active contracts count. This chart may be useful to gauge composition of ACS
Throughput > Throughputs
Current throughputs in terms of watermark advancement and stored events
Throughput > Ingested counts
Total counts (as measured in transactions and events dimensions) since latest PQS start
Throughput > Transaction lag
Tracks lag from ledger (delta between command completion determined by transaction’s effective_at attribute and ingestion by PQS pipeline as determined by wall clock). This is latency introduced by upstream processes outside of PQS control (Ledger API, network, etc). This chart indicates, for example, that 100 ms of latency has already been contributed to the overall end-to-end processing latency:
Throughput > Watermark history
Time series of watermark progression throughput. This manifests the rate of ledger transactions becoming available for querying with PQS Read API functions. The typical shape of the chart is shown below. For uniform traffic it should represent smooth curves.
Anomalies might include torn shapes and zigzag patterns with inactivities followed by spikes.
Throughput > Transactions and events
The shape of ingested traffic in terms of transactions and events dimensions. Provides an idea of the coarseness of transaction sizes.
Throughput > Events breakdown
Provides breakdown of event types inside transactions (contents differs depending on pipeline source - flat transaction vs transaction tree)
Throughput > Waitpoints - ACS / streaming
ACS = only during seeding from the ActiveContractSet Ledger API service
streaming = normal processing pipeline
The internal pipeline is composed of distinct stages separated by queues (aka wait points). This chart indicates throughputs of items passing through them. Note that items might be distributed and consolidated at various stages, therefore relative throughputs can differ between the stages even for streamlined flow.
Anomalies here might include change in relative throughputs indicating non-uniformity of neighbouring transaction sizes at certain points. This might indicate noisy neighbours potentially causing latency spikes for other transactions.
Queue sizes
Time-series of histograms (vertical slices) that represent queue size of named wait points. Bottom all-green line indicates queue was empty all the time and this represents healthy situation without queueing or back-pressuring:
Below is a case where queueing was present due to downstream backpressure. This should be a matter of interest and suggests further investigation. Queue sizes are arranged cascadingly and the point at which queue size becomes empty points to a bottleneck, because pushback is propagated upstream.
Latency
Time taken to transfer a unit of work between wait points with different levels of granularity. Provides a percentile-based view as well historical histogram heatmap.
In this chart we can observe from the left panel that the majority of operations take less than 10 ms with some outliers taking up to 30 ms. On the right chart we see more detailed insights, namely, there are two dominating operations with average latencies 1 ms and 5 ms each.
Anomalies might include huge differences between p50 and p95 percentiles. As well as non-uniform spread of latencies in the right part.
Slowly increasing latencies across a lengthy time slice should cause concerns of service degradation.
Latency > Total Transaction Handling Latency
Time taken by the entire PQS pipeline between receipt from Ledger API to being committed to Postgres.
JVM Metrics
Provides a series of metrics that are common across any JVM application in terms of memory management, CPU utilisation and garbage collection activity. The most crucial signals to monitor and interpret are:
Anomalies might include used approaching committed and never decreasing. At the same time garbage collection frequency and time taken are increasing. These are the symptoms that out of memory conditions are imminent. If these parameters look healthy but PQS still exists with 137 exit code, then most likely a supervisor (Docker, Kubernetes) is terminating PQS forcefully - investigate potential configuration imbalance. Make sure that JVM memory-related settings are applied.
SQL queries useful for troubleshooting
It is highly recommended that Postgres metrics are captured through appropriate tools (like postgres-exporter) and shipped into metrics storage (like Prometheus) for historical trends identification and analysis. The following visualisations useful for analysis would be possible for creation:
In the absence of integration into metrics storage, one can run the following queries when necessary for point-in-time view.
Statistics on disk vs index I/O
Currently executing queries
Top 10 queries by run time
This query requirespg_stat_statements extension installed into PostgreSQL.