service

Documentation

Overview

Package service is built for querying metadata and to expose it over daemon service.

Package service is built for querying metadata and to expose it over daemon service.

Index

• func BuildUXEdgeWatermarkFetchers(ctx context.Context, pipeline *v1alpha1.Pipeline, ...) (map[v1alpha1.Edge][]fetch.HeadFetcher, error)
• func BuildWatermarkStores(ctx context.Context, pipeline *v1alpha1.Pipeline, ...) (map[v1alpha1.Edge][]store.WatermarkStore, error)
• type HealthChecker
  • func NewHealthChecker(pipeline *v1alpha1.Pipeline, isbSvcClient isbsvc.ISBService) *HealthChecker
• type PipelineMetadataQuery
  • func NewPipelineMetadataQuery(isbSvcClient isbsvc.ISBService, pipeline *v1alpha1.Pipeline, ...) (*PipelineMetadataQuery, error)
  • func (ps *PipelineMetadataQuery) GetBuffer(ctx context.Context, req *daemon.GetBufferRequest) (*daemon.GetBufferResponse, error)
  • func (ps *PipelineMetadataQuery) GetPipelineStatus(ctx context.Context, req *daemon.GetPipelineStatusRequest) (*daemon.GetPipelineStatusResponse, error)
  • func (ps *PipelineMetadataQuery) GetPipelineWatermarks(ctx context.Context, request *daemon.GetPipelineWatermarksRequest) (*daemon.GetPipelineWatermarksResponse, error)
  • func (ps *PipelineMetadataQuery) GetVertexMetrics(ctx context.Context, req *daemon.GetVertexMetricsRequest) (*daemon.GetVertexMetricsResponse, error)
  • func (ps *PipelineMetadataQuery) ListBuffers(ctx context.Context, req *daemon.ListBuffersRequest) (*daemon.ListBuffersResponse, error)
  • func (ps *PipelineMetadataQuery) StartHealthCheck(ctx context.Context)

Functions

func BuildUXEdgeWatermarkFetchers

func BuildUXEdgeWatermarkFetchers(ctx context.Context, pipeline *v1alpha1.Pipeline, wmStores map[v1alpha1.Edge][]store.WatermarkStore) (map[v1alpha1.Edge][]fetch.HeadFetcher, error)

BuildUXEdgeWatermarkFetchers returns a map of the watermark fetchers, where key is the buffer name, value is a list of fetchers to the buffers.

func BuildWatermarkStores

func BuildWatermarkStores(ctx context.Context, pipeline *v1alpha1.Pipeline, isbsvcClient isbsvc.ISBService) (map[v1alpha1.Edge][]store.WatermarkStore, error)

BuildWatermarkStores returns a map of watermark stores per edge.

Types

type HealthChecker

type HealthChecker struct {
	// contains filtered or unexported fields
}

HealthChecker is the struct type for health checker.

func NewHealthChecker

func NewHealthChecker(pipeline *v1alpha1.Pipeline, isbSvcClient isbsvc.ISBService) *HealthChecker

NewHealthChecker creates a new object HealthChecker struct type.

type PipelineMetadataQuery

type PipelineMetadataQuery struct {
	daemon.UnimplementedDaemonServiceServer
	// contains filtered or unexported fields
}

PipelineMetadataQuery has the metadata required for the pipeline queries

func NewPipelineMetadataQuery

func NewPipelineMetadataQuery(
	isbSvcClient isbsvc.ISBService,
	pipeline *v1alpha1.Pipeline,
	wmFetchers map[v1alpha1.Edge][]fetch.HeadFetcher,
	rater rater.Ratable) (*PipelineMetadataQuery, error)

NewPipelineMetadataQuery returns a new instance of pipelineMetadataQuery

func (*PipelineMetadataQuery) GetBuffer

func (ps *PipelineMetadataQuery) GetBuffer(ctx context.Context, req *daemon.GetBufferRequest) (*daemon.GetBufferResponse, error)

GetBuffer is used to obtain one buffer information of a pipeline

func (*PipelineMetadataQuery) GetPipelineStatus

func (ps *PipelineMetadataQuery) GetPipelineStatus(ctx context.Context, req *daemon.GetPipelineStatusRequest) (*daemon.GetPipelineStatusResponse, error)

func (*PipelineMetadataQuery) GetPipelineWatermarks

func (ps *PipelineMetadataQuery) GetPipelineWatermarks(ctx context.Context, request *daemon.GetPipelineWatermarksRequest) (*daemon.GetPipelineWatermarksResponse, error)

GetPipelineWatermarks is used to return the head watermarks for a given pipeline.

func (*PipelineMetadataQuery) GetVertexMetrics

func (ps *PipelineMetadataQuery) GetVertexMetrics(ctx context.Context, req *daemon.GetVertexMetricsRequest) (*daemon.GetVertexMetricsResponse, error)

GetVertexMetrics is used to query the metrics service and is used to obtain the processing rate of a given vertex for 1m, 5m and 15m. Response contains the metrics for each partition of the vertex. In the future maybe latency will also be added here? Should this method live here or maybe another file?

func (*PipelineMetadataQuery) ListBuffers

func (ps *PipelineMetadataQuery) ListBuffers(ctx context.Context, req *daemon.ListBuffersRequest) (*daemon.ListBuffersResponse, error)

ListBuffers is used to obtain the all the edge buffers information of a pipeline

func (*PipelineMetadataQuery) StartHealthCheck

func (ps *PipelineMetadataQuery) StartHealthCheck(ctx context.Context)

StartHealthCheck starts the health check for the pipeline using the health checker