graphqlmetrics

Documentation

Index

• func AggregateSchemaUsageInfoBatch(batch []*graphqlmetrics.SchemaUsageInfo) *graphqlmetrics.PublishAggregatedGraphQLRequestMetricsRequest
• type Exporter
  • func NewExporter(logger *zap.Logger, client graphqlmetricsv1connect.GraphQLMetricsServiceClient, ...) (*Exporter, error)
  • func (e *Exporter) RecordUsage(usageInfo *graphqlmetrics.SchemaUsageInfo, synchronous bool) (ok bool)
  • func (e *Exporter) Shutdown(ctx context.Context) error
• type ExporterSettings
  • func NewDefaultExporterSettings() *ExporterSettings
• type RetryOptions

Functions

func AggregateSchemaUsageInfoBatch

func AggregateSchemaUsageInfoBatch(batch []*graphqlmetrics.SchemaUsageInfo) *graphqlmetrics.PublishAggregatedGraphQLRequestMetricsRequest

Types

type Exporter

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

func NewExporter

func NewExporter(logger *zap.Logger, client graphqlmetricsv1connect.GraphQLMetricsServiceClient, apiToken string, settings *ExporterSettings) (*Exporter, error)

NewExporter creates a new GraphQL metrics exporter. The collectorEndpoint is the endpoint to which the metrics are sent. The apiToken is the token used to authenticate with the collector. The collector supports Brotli compression and retries on failure. Underling queue implementation sends batches of metrics at the specified interval and batch size.

func (*Exporter) RecordUsage

func (e *Exporter) RecordUsage(usageInfo *graphqlmetrics.SchemaUsageInfo, synchronous bool) (ok bool)

func (*Exporter) Shutdown

func (e *Exporter) Shutdown(ctx context.Context) error

Shutdown the exporter but waits until all export jobs has been finished or timeout. If the context is canceled, the exporter will be shutdown immediately.

type ExporterSettings

type ExporterSettings struct {
	// BatchSize is the maximum number of items to be sent in a single batch.
	BatchSize int
	// QueueSize is the maximum number of batches allowed in queue at a given time.
	QueueSize int
	// Interval is the interval at which the queue is flushed.
	Interval time.Duration
	// Retry is the retry options for the exporter.
	RetryOptions RetryOptions
	// ExportTimeout is the timeout for the export request.
	ExportTimeout time.Duration
}

func NewDefaultExporterSettings

func NewDefaultExporterSettings() *ExporterSettings

type RetryOptions

type RetryOptions struct {
	Enabled     bool
	MaxDuration time.Duration
	Interval    time.Duration
	MaxRetry    int
}