kagome::telemetry Namespace Reference

Classes
class	MessagePool
class	TelemetryConnection
class	TelemetryConnectionImpl
class	TelemetryEndpoint
class	TelemetryService
class	TelemetryServiceImpl

Typedefs
using	MessageHandle = std::size_t
using	Telemetry = std::shared_ptr< TelemetryService >

Enumerations
enum	BlockOrigin {   BlockOrigin::kGenesis, BlockOrigin::kNetworkInitialSync, BlockOrigin::kNetworkBroadcast, BlockOrigin::kConsensusBroadcast,   BlockOrigin::kOwn, BlockOrigin::kFile }

Functions
void	setTelemetryService (std::shared_ptr< TelemetryService > service)
std::shared_ptr< TelemetryService >	createTelemetryService ()
	Returns preliminary initialized instance of telemetry service. More...
void	setTelemetryService (Telemetry service)
	Sets an instance of telemetry service for latter usage by reporters. More...

Variables
static constexpr auto	kConnectionTimeout = std::chrono::seconds(30)
	operations' timeout during websocket connection establishing More...
static constexpr auto	kInitialReconnectTimeout = std::chrono::seconds(5)
	starting value for reconnection timeout in case line failure More...
static constexpr auto	kReconnectTimeoutIncrement = std::chrono::seconds(5)
	an addition to to reconnect timeout after failed attempt More...
static constexpr auto	kMaxReconnectTimeout = std::chrono::seconds(60)
	maximum reconnect timeout value despite reconnect attempts number More...
static constexpr auto	kImplementationName = "Kagome Node"
static constexpr auto	kTelemetryReportingInterval = std::chrono::seconds(1)
static constexpr auto	kTelemetrySystemReportInterval
static constexpr auto	kTelemetryMessageMaxLengthBytes = 2 * 1024
static constexpr auto	kTelemetryMessagePoolSize = 1000

Detailed Description

Copyright Soramitsu Co., Ltd. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Typedef Documentation

using kagome::telemetry::MessageHandle = typedef std::size_t

Definition at line 20 of file message_pool.hpp.

using kagome::telemetry::Telemetry = typedef std::shared_ptr<TelemetryService>

Definition at line 86 of file service.hpp.

Enumeration Type Documentation

enum kagome::telemetry::BlockOrigin

strong

Possible block origins enumeration

https://github.com/paritytech/substrate/blob/42b2d623d058197aebc3c737fb44fbbf278a85b4/primitives/consensus/common/src/lib.rs#L64

Enumerator
kGenesis	Genesis block built into the client.
kNetworkInitialSync	Block is part of the initial sync with the network.
kNetworkBroadcast	Block was broadcasted on the network.
kConsensusBroadcast	Block that was received from the network and validated in the consensus process.
kOwn	Block that was collated by this node.
kFile	Block was imported from a file.

Definition at line 20 of file service.hpp.

Function Documentation

Telemetry kagome::telemetry::createTelemetryService

(

)

Returns preliminary initialized instance of telemetry service.

Definition at line 69 of file service.cpp.

void kagome::telemetry::setTelemetryService

(

std::shared_ptr< TelemetryService >

service

)

Definition at line 62 of file service.cpp.

void kagome::telemetry::setTelemetryService

(

Telemetry

service

)

Sets an instance of telemetry service for latter usage by reporters.

Variable Documentation

constexpr auto kagome::telemetry::kConnectionTimeout = std::chrono::seconds(30)

static

operations' timeout during websocket connection establishing

Definition at line 31 of file connection_impl.hpp.

constexpr auto kagome::telemetry::kImplementationName = "Kagome Node"

static

Definition at line 38 of file service_impl.hpp.

constexpr auto kagome::telemetry::kInitialReconnectTimeout = std::chrono::seconds(5)

static

starting value for reconnection timeout in case line failure

Definition at line 34 of file connection_impl.hpp.

constexpr auto kagome::telemetry::kMaxReconnectTimeout = std::chrono::seconds(60)

static

maximum reconnect timeout value despite reconnect attempts number

Definition at line 38 of file connection_impl.hpp.

constexpr auto kagome::telemetry::kReconnectTimeoutIncrement = std::chrono::seconds(5)

static

an addition to to reconnect timeout after failed attempt

Definition at line 36 of file connection_impl.hpp.

constexpr auto kagome::telemetry::kTelemetryMessageMaxLengthBytes = 2 * 1024

static

Definition at line 43 of file service_impl.hpp.

constexpr auto kagome::telemetry::kTelemetryMessagePoolSize = 1000

static

Definition at line 44 of file service_impl.hpp.

constexpr auto kagome::telemetry::kTelemetryReportingInterval = std::chrono::seconds(1)

static

Definition at line 40 of file service_impl.hpp.

constexpr auto kagome::telemetry::kTelemetrySystemReportInterval

static

Initial value:

=
      std::chrono::seconds(5)

Definition at line 41 of file service_impl.hpp.