# Protocol Documentation ## Table of Contents - [state/service.proto](#state/service.proto) - Services - [Status](#state.Status) - Messages - [HealthRequest](#state.HealthRequest) - [HealthResponse](#state.HealthResponse) - [MetricsRequest](#state.MetricsRequest) - [MetricsResponse](#state.MetricsResponse) - [NetmapRequest](#state.NetmapRequest) - [Scalar Value Types](#scalar-value-types)

Top

## state/service.proto ### Service "state.Status" Status service provides node's healthcheck and status info ``` rpc Netmap(NetmapRequest) returns (.bootstrap.SpreadMap); rpc Metrics(MetricsRequest) returns (MetricsResponse); rpc HealthCheck(HealthRequest) returns (HealthResponse); ``` #### Method Netmap Netmap request allows to receive current [bootstrap.SpreadMap](bootstrap.md#bootstrap.SpreadMap) | Name | Input | Output | | ---- | ----- | ------ | | Netmap | [NetmapRequest](#state.NetmapRequest) | [.bootstrap.SpreadMap](#bootstrap.SpreadMap) | #### Method Metrics Metrics request allows to receive metrics in prometheus format | Name | Input | Output | | ---- | ----- | ------ | | Metrics | [MetricsRequest](#state.MetricsRequest) | [MetricsResponse](#state.MetricsResponse) | #### Method HealthCheck HealthCheck request allows to check health status of the node. If node unhealthy field Status would contains detailed info. | Name | Input | Output | | ---- | ----- | ------ | | HealthCheck | [HealthRequest](#state.HealthRequest) | [HealthResponse](#state.HealthResponse) | ### Message HealthRequest HealthRequest message to check current state ### Message HealthResponse HealthResponse message with current state | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Healthy | [bool](#bool) | | Healthy is true when node alive and healthy | | Status | [string](#string) | | Status contains detailed information about health status | ### Message MetricsRequest MetricsRequest message to request node metrics ### Message MetricsResponse MetricsResponse contains [][]byte, every []byte is marshaled MetricFamily proto message from github.com/prometheus/client_model/metrics.proto | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Metrics | [bytes](#bytes) | repeated | | ### Message NetmapRequest NetmapRequest message to request current node netmap ## Scalar Value Types | .proto Type | Notes | C++ Type | Java Type | Python Type | | ----------- | ----- | -------- | --------- | ----------- | | double | | double | double | float | | float | | float | float | float | | int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | | int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | | uint32 | Uses variable-length encoding. | uint32 | int | int/long | | uint64 | Uses variable-length encoding. | uint64 | long | int/long | | sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | | sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | | fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | | fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | | sfixed32 | Always four bytes. | int32 | int | int | | sfixed64 | Always eight bytes. | int64 | long | int/long | | bool | | bool | boolean | boolean | | string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | | bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |