etl::SystemState Struct Reference

Represents the state of the ETL subsystem. More...

#include <SystemState.hpp>

Public Attributes
util::prometheus::Bool	isReadOnly
	Whether the process is in strict read-only mode.
util::prometheus::Bool	isWriting
	Whether the process is writing to the database.
std::atomic_bool	isStopping = false
	Whether the software is stopping.
std::atomic_bool	writeConflict = false
	Whether a write conflict was detected.
util::prometheus::Bool	isAmendmentBlocked
	Whether clio detected an amendment block.
util::prometheus::Bool	isCorruptionDetected
	Whether clio detected a corruption that needs manual attention.

Detailed Description

Represents the state of the ETL subsystem.

Member Data Documentation

isAmendmentBlocked

util::prometheus::Bool etl::SystemState::isAmendmentBlocked

Initial value:

= PrometheusService::boolMetric(
        "etl_amendment_blocked",
        util::prometheus::Labels{},
        "Whether clio detected an amendment block"
    )

Whether clio detected an amendment block.

Being amendment blocked means that Clio was compiled with libxrpl that does not yet support some field that arrived from rippled and therefore can't extract the ledger diff. When this happens, Clio can't proceed with ETL and should log this error and only handle RPC requests.

isCorruptionDetected

util::prometheus::Bool etl::SystemState::isCorruptionDetected

Initial value:

= PrometheusService::boolMetric(
        "etl_corruption_detected",
        util::prometheus::Labels{},
        "Whether clio detected a corruption that needs manual attention"
    )

Whether clio detected a corruption that needs manual attention.

When corruption is detected, Clio should disable cache and stop the cache loading process in order to prevent further corruption.

isReadOnly

util::prometheus::Bool etl::SystemState::isReadOnly

Initial value:

= PrometheusService::boolMetric(
        "read_only",
        util::prometheus::Labels{},
        "Whether the process is in strict read-only mode"
    )

Whether the process is in strict read-only mode.

In strict read-only mode, the process will never attempt to become the ETL writer, and will only publish ledgers as they are written to the database.

isWriting

util::prometheus::Bool etl::SystemState::isWriting

Initial value:

= PrometheusService::boolMetric(
        "etl_writing",
        util::prometheus::Labels{},
        "Whether the process is writing to the database"
    )

Whether the process is writing to the database.

---

The documentation for this struct was generated from the following file:

• /__w/clio/clio/src/etl/SystemState.hpp