Canton developer docs / Reference

Complete documentation page mirrored and translated for learning. Attribution is shown at the bottom of each article.

阅读中文版

referenceadmin-apiprotobufpackages

com.digitalasset.canton.admin.health.v30

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.

com.digitalasset.canton.admin.health.v30

Package-level overview for com.digitalasset.canton.admin.health.v30.

Back to overview

Protobuf Package

com.digitalasset.canton.admin.health.v30

1 services, 2 endpoints, 9 messages, 1 enums

gRPC
Files
1
<div class="x2mdx-ref-meta-item">
  <dt>Services</dt>
  <dd>1</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Endpoints</dt>
  <dd>2</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Messages</dt>
  <dd>9</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Enums</dt>
  <dd>1</dd>
</div>

Source Files

community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status\_service.proto

<p class="x2mdx-ref-card-summary">Current source file in the latest published descriptor snapshot.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>8</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Source</dt>
    <dd><a href="https://github.com/DACH-NY/canton/blob/v3.5.1/community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status_service.proto">community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status\_service.proto</a></dd>
  </div>
</dl>

StatusService

Source file
community/admin-api/src/main/protobuf/com/digitalasset/canton/admin/health/v30/status\_service.proto
Operations
2

StatusService.HealthDump

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.0</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc StatusService.HealthDump(com.digitalasset.canton.admin.health.v30.HealthDumpRequest) returns (stream com.digitalasset.canton.admin.health.v30.HealthDumpResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.digitalasset.canton.admin.health.v30.HealthDumpRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.digitalasset.canton.admin.health.v30.HealthDumpResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>Yes</dd>
  </div>
</dl>

StatusService.SetLogLevel

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.0</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc StatusService.SetLogLevel(com.digitalasset.canton.admin.health.v30.SetLogLevelRequest) returns (com.digitalasset.canton.admin.health.v30.SetLogLevelResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.digitalasset.canton.admin.health.v30.SetLogLevelRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.digitalasset.canton.admin.health.v30.SetLogLevelResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

Type Inventory

These are the package-level message and enum shapes in the publish-version snapshot.

com.digitalasset.canton.admin.health.v30.ComponentStatus

<p class="x2mdx-ref-schema-summary">5 fields</p>
name string 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">ok</code>
    <span class="x2mdx-ref-type-badge">StatusData</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">degraded</code>
    <span class="x2mdx-ref-type-badge">StatusData</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">failed</code>
    <span class="x2mdx-ref-type-badge">StatusData</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">fatal</code>
    <span class="x2mdx-ref-type-badge">StatusData</span>
  </div>
</div>

com.digitalasset.canton.admin.health.v30.ComponentStatus.StatusData

<p class="x2mdx-ref-schema-summary">1 fields</p>
description string

com.digitalasset.canton.admin.health.v30.HealthDumpRequest

<p class="x2mdx-ref-schema-summary">1 fields</p>
chunk\_size uint32

com.digitalasset.canton.admin.health.v30.HealthDumpResponse

<p class="x2mdx-ref-schema-summary">1 fields</p>
chunk bytes

com.digitalasset.canton.admin.health.v30.NotInitialized

<p class="x2mdx-ref-schema-summary">3 fields</p>
active bool 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">waiting\_for\_external\_input</code>
    <span class="x2mdx-ref-type-badge">WaitingForExternalInput</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">version</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

com.digitalasset.canton.admin.health.v30.NotInitialized.WaitingForExternalInput

<p class="x2mdx-ref-schema-summary">4 values</p>
  • WAITING\_FOR\_EXTERNAL\_INPUT\_UNSPECIFIED
    • <li><code>WAITING\_FOR\_EXTERNAL\_INPUT\_ID</code></li>

<li><code>WAITING\_FOR\_EXTERNAL\_INPUT\_NODE\_TOPOLOGY</code></li>

<li><code>WAITING\_FOR\_EXTERNAL\_INPUT\_INITIALIZATION</code></li>

com.digitalasset.canton.admin.health.v30.SetLogLevelRequest

<p class="x2mdx-ref-schema-summary">1 fields</p>
level string

com.digitalasset.canton.admin.health.v30.SetLogLevelResponse

<p class="x2mdx-ref-schema-summary">0 fields</p>

com.digitalasset.canton.admin.health.v30.Status

<p class="x2mdx-ref-schema-summary">7 fields</p>
uid string 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">uptime</code>
    <span class="x2mdx-ref-type-badge">Duration</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">ports</code>
    <span class="x2mdx-ref-type-badge">repeated map</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">active</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">topology\_queues</code>
    <span class="x2mdx-ref-type-badge">TopologyQueueStatus</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">components</code>
    <span class="x2mdx-ref-type-badge">repeated ComponentStatus</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">version</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

com.digitalasset.canton.admin.health.v30.TopologyQueueStatus

<p class="x2mdx-ref-schema-summary">3 fields</p>
manager uint32 
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">dispatcher</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">clients</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.