class ParticipantHealthAdministration extends HealthAdministration[ParticipantStatus] with FeatureFlagFilter with ParticipantHealthAdministrationCommon
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- ParticipantHealthAdministration
- ParticipantHealthAdministrationCommon
- FeatureFlagFilter
- HealthAdministration
- NamedLogging
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new ParticipantHealthAdministration(runner: AdminCommandRunner, consoleEnvironment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def active: Boolean
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Check if the node is running and is the active instance (mediator, participant)", flag = console.this.Help.Summary.<init>$default$2)
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def cantonConfig: CantonConfig
- Attributes
- protected
- Definition Classes
- FeatureFlagFilter
- def check[T](flag: FeatureFlag)(command: => T): T
- Attributes
- protected
- Definition Classes
- FeatureFlagFilter
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val consoleEnvironment: ConsoleEnvironment
- Definition Classes
- ParticipantHealthAdministration → FeatureFlagFilter
- def count_in_flight(synchronizerAlias: SynchronizerAlias): InFlightCount
- Annotations
- @Summary(s = "Counts pending command submissions and transactions on a synchronizer.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This command finds the current number of pending command submissions and transactions on a selected synchronizer.
|
|There is no synchronization between pending command submissions and transactions. And the respective
|counts are an indication only!
|
|This command is in particular useful to re-assure oneself that there are currently no in-flight submissions
|or transactions present for the selected synchronizer. Such re-assurance is then helpful to proceed with repair
|operations, for example.""")
- def dump(outputFile: File = CantonHealthAdministration.defaultHealthDumpName, timeout: NonNegativeDuration = timeouts.unbounded, chunkSize: Option[Int] = None): String
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Creates a zip file containing diagnostic information about the canton process running this node", flag = console.this.Help.Summary.<init>$default$2)
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def has_identity(): Boolean
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Returns true if the node has an identity", flag = console.this.Help.Summary.<init>$default$2)
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- Annotations
- @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- def initialized(): Boolean
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Returns true if node has been initialized.", flag = console.this.Help.Summary.<init>$default$2)
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def is_ready_for_id(): Boolean
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Check if the node is ready for setting the node's id", flag = console.this.Help.Summary.<init>$default$2)
- def is_ready_for_initialization(): Boolean
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Check if the node is ready for initialization", flag = console.this.Help.Summary.<init>$default$2)
- def is_ready_for_node_topology(): Boolean
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Check if the node is ready for uploading the node's identity topology", flag = console.this.Help.Summary.<init>$default$2)
- def is_running(): Boolean
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Check if the node is running", flag = console.this.Help.Summary.<init>$default$2)
- def last_error_trace(traceId: String): Seq[String]
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Show all messages logged with the given traceId in a recent interval", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "Returns a list of buffered log messages associated to a given trace-id. Usually, the trace-id is taken from last_errors()")
- def last_errors(): Map[String, String]
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Show the last errors logged", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Returns a map with the trace-id as key and the most recent error messages as value. Requires that --log-last-errors is enabled (and not turned off).""")
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Definition Classes
- ParticipantHealthAdministration → NamedLogging
- def maybe_ping(participantId: ParticipantId, timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.ping, synchronizerId: Option[SynchronizerId] = None, id: String = ""): Option[Duration]
- Definition Classes
- ParticipantHealthAdministrationCommon
- Annotations
- @Summary(s = "Sends a ping to the target participant over the ledger. Yields Some(duration) in case of success and None in case of failure.", flag = FeatureFlag.Testing)
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- def nodeStatusCommand: GrpcAdminCommand[_, _, NodeStatus[ParticipantStatus]]
- Attributes
- protected
- Definition Classes
- ParticipantHealthAdministration → HealthAdministration
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def ping(participantId: ParticipantId, timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.ping, synchronizerId: Option[SynchronizerId] = None, id: String = ""): Duration
- Definition Classes
- ParticipantHealthAdministrationCommon
- Annotations
- @Summary(s = "Sends a ping to the target participant over the ledger. " +
"Yields the duration in case of success and throws a RuntimeException in case of failure.", flag = console.this.Help.Summary.<init>$default$2)
- val runner: AdminCommandRunner
- Definition Classes
- ParticipantHealthAdministration → ParticipantHealthAdministrationCommon
- def set_log_level(level: Level): Unit
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Change the log level of the process", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "If the default logback configuration is used, this will change the log level of the process.")
- def status: NodeStatus[ParticipantStatus]
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Get human (and machine) readable status information", flag = console.this.Help.Summary.<init>$default$2)
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def waitFor(condition: => Boolean): Unit
- Attributes
- protected
- Definition Classes
- HealthAdministration
- def wait_for_identity(): Unit
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Wait for the node to have an identity", flag = console.this.Help.Summary.<init>$default$2)
- def wait_for_initialized(): Unit
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Wait for the node to be initialized", flag = console.this.Help.Summary.<init>$default$2)
- def wait_for_ready_for_id(): Unit
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Wait for the node to be ready for setting the node's id", flag = console.this.Help.Summary.<init>$default$2)
- def wait_for_ready_for_initialization(): Unit
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Wait for the node to be ready for initialization", flag = console.this.Help.Summary.<init>$default$2)
- def wait_for_ready_for_node_topology(): Unit
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Wait for the node to be ready for uploading the node's identity topology", flag = console.this.Help.Summary.<init>$default$2)
- def wait_for_running(): Unit
- Definition Classes
- HealthAdministration
- Annotations
- @Summary(s = "Wait for the node to be running", flag = console.this.Help.Summary.<init>$default$2)