GRPC C++  1.80.0
Public Member Functions
grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo Class Referenceabstract

#include <event_engine.h>

Public Member Functions

virtual ~TelemetryInfo ()=default
 
virtual std::vector< size_t > AllWriteMetrics () const =0
 Returns the list of write metrics that the endpoint supports. More...
 
virtual std::optional< absl::string_view > GetMetricName (size_t key) const =0
 Returns the name of the write metric with the given key. More...
 
virtual std::optional< size_t > GetMetricKey (absl::string_view name) const =0
 Returns the key of the write metric with the given name. More...
 
virtual std::shared_ptr< MetricsSetGetMetricsSet (absl::Span< const size_t > keys) const =0
 Returns a MetricsSet with all the keys from keys set. More...
 
virtual std::shared_ptr< MetricsSetGetFullMetricsSet () const =0
 Returns a MetricsSet with all supported keys set. More...
 

Constructor & Destructor Documentation

◆ ~TelemetryInfo()

virtual grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::~TelemetryInfo ( )
virtualdefault

Member Function Documentation

◆ AllWriteMetrics()

virtual std::vector<size_t> grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::AllWriteMetrics ( ) const
pure virtual

Returns the list of write metrics that the endpoint supports.

The keys are used to identify the metrics in the GetMetricName and GetMetricKey APIs. The current value of the metric can be queried by adding a WriteEventSink to the WriteArgs of a Write call.

◆ GetFullMetricsSet()

virtual std::shared_ptr<MetricsSet> grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::GetFullMetricsSet ( ) const
pure virtual

Returns a MetricsSet with all supported keys set.

◆ GetMetricKey()

virtual std::optional<size_t> grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::GetMetricKey ( absl::string_view  name) const
pure virtual

Returns the key of the write metric with the given name.

If the name is not found, returns std::nullopt.

◆ GetMetricName()

virtual std::optional<absl::string_view> grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::GetMetricName ( size_t  key) const
pure virtual

Returns the name of the write metric with the given key.

If the key is not found, returns std::nullopt.

◆ GetMetricsSet()

virtual std::shared_ptr<MetricsSet> grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::GetMetricsSet ( absl::Span< const size_t >  keys) const
pure virtual

Returns a MetricsSet with all the keys from keys set.


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