this class provides a monitoring sink to collecct metrics based on a given metric collector. More...

#include <MonitoringSink.hpp>

Collaboration diagram for NES::MonitoringSink:

Public Member Functions
	MonitoringSink (SinkFormatPtr sinkFormat, Monitoring::MetricStorePtr metricStore, Monitoring::MetricCollectorType collectorType, Runtime::NodeEnginePtr nodeEngine, uint32_t numOfProducers, SharedQueryId sharedQueryId, DecomposedQueryId decomposedQueryId, DecomposedQueryPlanVersion decomposedQueryVersion, uint64_t numberOfOrigins=1)
	Default getSliceIndexByTs for could not find a slice, @Note the default output will be written to cout. More...

	~MonitoringSink () override
	destructor @Note this is required by some tests More...

void	setup () override
	setup method for print sink @Note required due to derivation but does nothing More...

void	shutdown () override
	shutdown method for print sink @Note required due to derivation but does nothing More...

bool	writeData (Runtime::TupleBuffer &inputBuffer, Runtime::WorkerContextRef) override
	method to write the content of a tuple buffer to output console More...

std::string	toString () const override
	override the toString method for the print sink More...

SinkMediumTypes	getSinkMediumType () override
	method to return the type of medium More...

Public Member Functions inherited from NES::SinkMedium
	SinkMedium (SinkFormatPtr sinkFormat, Runtime::NodeEnginePtr nodeEngine, uint32_t numOfProducers, SharedQueryId sharedQueryId, DecomposedQueryId decomposedQueryId, DecomposedQueryPlanVersion decomposedQueryVersion)
	public constructor for data sink More...

	SinkMedium (SinkFormatPtr sinkFormat, Runtime::NodeEnginePtr nodeEngine, uint32_t numOfProducers, SharedQueryId sharedQueryId, DecomposedQueryId decomposedQueryId, DecomposedQueryPlanVersion decomposedQueryVersion, uint64_t numberOfOrigins)
	public constructor for data sink More...

virtual bool	writeData (Runtime::TupleBuffer &inputBuffer, Runtime::WorkerContext &workerContext)=0
	method to write a TupleBuffer More...

SharedQueryId	getSharedQueryId () const
	get the id of the owning plan More...

DecomposedQueryId	getParentPlanId () const
	get the subplan id of the owning plan More...

DecomposedQueryPlanVersion	getParentPlanVersion () const
	get the subplan version of the owning plan More...

uint64_t	getNumberOfWrittenOutBuffers ()
	debug function for testing to get number of written buffers More...

uint64_t	getNumberOfWrittenOutTuples ()
	debug function for testing to get number of written tuples More...

SchemaPtr	getSchemaPtr () const
	method to return the current schema of the sink More...

std::string	getSinkFormat ()
	method to get the format as string More...

void	reconfigure (Runtime::ReconfigurationMessage &message, Runtime::WorkerContext &context) override

void	postReconfigurationCallback (Runtime::ReconfigurationMessage &message) override

OperatorId	getOperatorId () const
	Get operator id. More...

void	setMigrationFlag ()
	Sets that sink is used for state migration. More...

bool	isForMigration () const
	Check whether this sink is used for state migration. More...

Public Member Functions inherited from NES::Runtime::Reconfigurable
	~Reconfigurable () NES_NOEXCEPT(false) override=default

Public Member Functions inherited from NES::detail::virtual_enable_shared_from_this< Reconfigurable, false >
	~virtual_enable_shared_from_this () NES_NOEXCEPT(isNoexceptDestructible) override=default

std::shared_ptr< T1 >	shared_from_this ()

std::weak_ptr< T1 >	weak_from_this ()

Public Member Functions inherited from NES::detail::virtual_enable_shared_from_this_base< isNoexceptDestructible >
virtual	~virtual_enable_shared_from_this_base () NES_NOEXCEPT(isNoexceptDestructible)=default

Additional Inherited Members
Protected Attributes inherited from NES::SinkMedium
SinkFormatPtr	sinkFormat

bool	schemaWritten

Runtime::NodeEnginePtr	nodeEngine

std::atomic< uint32_t >	activeProducers
	termination machinery More...

SharedQueryId	sharedQueryId

DecomposedQueryId	decomposedQueryId

DecomposedQueryPlanVersion	decomposedQueryVersion

uint64_t	numberOfOrigins

uint64_t	sentBuffer {0}

uint64_t	sentTuples {0}

std::recursive_mutex	writeMutex

bool	migration {false}

Detailed Description

this class provides a monitoring sink to collecct metrics based on a given metric collector.

Constructor & Destructor Documentation

◆ MonitoringSink()

NES::MonitoringSink::MonitoringSink	(	SinkFormatPtr	sinkFormat,
		Monitoring::MetricStorePtr	metricStore,
		Monitoring::MetricCollectorType	collectorType,
		Runtime::NodeEnginePtr	nodeEngine,
		uint32_t	numOfProducers,
		SharedQueryId	sharedQueryId,
		DecomposedQueryId	decomposedQueryId,
		DecomposedQueryPlanVersion	decomposedQueryVersion,
		uint64_t	numberOfOrigins = `1`
	)

explicit

Default getSliceIndexByTs for could not find a slice, @Note the default output will be written to cout.

References NES_ASSERT.

◆ ~MonitoringSink()

NES::MonitoringSink::~MonitoringSink ( )

overridedefault

destructor @Note this is required by some tests

Member Function Documentation

◆ getSinkMediumType()

SinkMediumTypes NES::MonitoringSink::getSinkMediumType ( )

overridevirtual

method to return the type of medium

Returns: type of medium

Implements NES::SinkMedium.

References NES::MONITORING_SINK.

◆ setup()

void NES::MonitoringSink::setup ( )

overridevirtual

setup method for print sink @Note required due to derivation but does nothing

Implements NES::SinkMedium.

◆ shutdown()

void NES::MonitoringSink::shutdown ( )

overridevirtual

shutdown method for print sink @Note required due to derivation but does nothing

Implements NES::SinkMedium.

◆ toString()

std::string NES::MonitoringSink::toString ( ) const

overridevirtual

override the toString method for the print sink

Returns: returns string describing the print sink

Implements NES::SinkMedium.

References magic_enum::enum_name(), and NES::SinkMedium::sinkFormat.

Here is the call graph for this function:

◆ writeData()

bool NES::MonitoringSink::writeData	(	Runtime::TupleBuffer &	inputBuffer,
		Runtime::WorkerContextRef
	)

override

method to write the content of a tuple buffer to output console

Parameters

tuple buffer to write

Returns: bool indicating success of the write

References NES::Monitoring::asJson(), NES::Monitoring::MetricUtils::createMetricFromCollectorType(), NES::Runtime::TupleBuffer::getBuffer(), NES::Runtime::TupleBuffer::getNumberOfTuples(), NES::SinkMedium::getSchemaPtr(), apex::memcpy(), backward::details::move(), NES_TRACE, NES::Monitoring::readFromBuffer(), and NES::SinkMedium::writeMutex.

Here is the call graph for this function:

The documentation for this class was generated from the following files:

/nebulastream/nes-runtime/include/Sinks/Mediums/MonitoringSink.hpp
/nebulastream/nes-runtime/src/Sinks/Mediums/MonitoringSink.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MonitoringSink()

◆ ~MonitoringSink()

Member Function Documentation

◆ getSinkMediumType()

◆ setup()

◆ shutdown()

◆ toString()

◆ writeData()