server

Documentation

Index

• Variables
• func SetupMetrics(ctx context.Context, cfg *config.Settings, serviceName string) (*sdkmetric.MeterProvider, error)
• type AbandonOpError
  • func (w *AbandonOpError) Error() string
• type Exporter
• type MockExporter
  • func NewMockExporter(t interface{ ... }) *MockExporter
  • func (_m *MockExporter) EXPECT() *MockExporter_Expecter
  • func (_m *MockExporter) ExportSpans(ctx context.Context, spans []trace.ReadOnlySpan) error
• type MockExporter_Expecter
  • func (_e *MockExporter_Expecter) ExportSpans(ctx interface{}, spans interface{}) *MockExporter_ExportSpans_Call
• type MockExporter_ExportSpans_Call
  • func (_c *MockExporter_ExportSpans_Call) Return(_a0 error) *MockExporter_ExportSpans_Call
  • func (_c *MockExporter_ExportSpans_Call) Run(run func(ctx context.Context, spans []trace.ReadOnlySpan)) *MockExporter_ExportSpans_Call
  • func (_c *MockExporter_ExportSpans_Call) RunAndReturn(run func(context.Context, []trace.ReadOnlySpan) error) *MockExporter_ExportSpans_Call
• type Server
  • func New(ctx context.Context, nc *nats.Conn, js jetstream.JetStream, ...) *Server
  • func (s *Server) Listen() error

Variables

var (
	VersionTag string
	CommitHash string
	BuildDate  string
)

The following variables are set by -ldflags at build time.

var NatsConfig string

NatsConfig holds the current configuration of the SHAR Telemetry Server

Functions

func SetupMetrics

func SetupMetrics(ctx context.Context, cfg *config.Settings, serviceName string) (*sdkmetric.MeterProvider, error)

SetupMetrics initialises metrics

Types

type AbandonOpError

type AbandonOpError struct {
	Err error
}

AbandonOpError signifies an operation should trigger abandoning the active task.

func (*AbandonOpError) Error

func (w *AbandonOpError) Error() string

type Exporter

type Exporter interface {
	ExportSpans(ctx context.Context, spans []tracesdk.ReadOnlySpan) error
}

Exporter represents an interface to the span exporter

type MockExporter

type MockExporter struct {
	mock.Mock
}

MockExporter is an autogenerated mock type for the Exporter type

func NewMockExporter

func NewMockExporter(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockExporter

NewMockExporter creates a new instance of MockExporter. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockExporter) EXPECT

func (_m *MockExporter) EXPECT() *MockExporter_Expecter

func (*MockExporter) ExportSpans

func (_m *MockExporter) ExportSpans(ctx context.Context, spans []trace.ReadOnlySpan) error

ExportSpans provides a mock function with given fields: ctx, spans

type MockExporter_Expecter

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

func (*MockExporter_Expecter) ExportSpans

func (_e *MockExporter_Expecter) ExportSpans(ctx interface{}, spans interface{}) *MockExporter_ExportSpans_Call

ExportSpans is a helper method to define mock.On call

• ctx context.Context
• spans []trace.ReadOnlySpan

type MockExporter_ExportSpans_Call

type MockExporter_ExportSpans_Call struct {
	*mock.Call
}

MockExporter_ExportSpans_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'ExportSpans'

func (*MockExporter_ExportSpans_Call) Return

func (_c *MockExporter_ExportSpans_Call) Return(_a0 error) *MockExporter_ExportSpans_Call

func (*MockExporter_ExportSpans_Call) Run

func (_c *MockExporter_ExportSpans_Call) Run(run func(ctx context.Context, spans []trace.ReadOnlySpan)) *MockExporter_ExportSpans_Call

func (*MockExporter_ExportSpans_Call) RunAndReturn

func (_c *MockExporter_ExportSpans_Call) RunAndReturn(run func(context.Context, []trace.ReadOnlySpan) error) *MockExporter_ExportSpans_Call

type Server

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

Server is the shar server type responsible for hosting the telemetry server.

func New

func New(ctx context.Context, nc *nats.Conn, js jetstream.JetStream, storageType jetstream.StorageType, exp Exporter, cfg *config.Settings) *Server

New creates a new telemetry server.

func (*Server) Listen

func (s *Server) Listen() error

Listen starts the telemetry server.