sumologicmock

Documentation

Index

• type Labels
  • func (labels Labels) DiffLabelNames(requested Labels, skipRegex *regexp.Regexp) (extra []string, missing []string)
  • func (labels Labels) Match(label, value string) bool
  • func (labels Labels) MatchAll(requested Labels) bool
  • func (labels Labels) MatchRegex(label string, re *regexp.Regexp) bool
• type LogsCountResponse
• type MetadataFilters
• type MetricCounts
• type MetricSample
• type MetricsSamplesByTime
  • func (m MetricsSamplesByTime) Len() int
  • func (m MetricsSamplesByTime) Less(i, j int) bool
  • func (m MetricsSamplesByTime) Swap(i, j int)
• type Span
• type SpanId
• type SumologicMockClient
  • func NewClient(t *testing.T, baseUrl url.URL) *SumologicMockClient
  • func NewClientWithK8sTunnel(ctx context.Context, envConf *envconf.Config, t *testing.T, serviceName string) (*SumologicMockClient, func())
  • func (client *SumologicMockClient) GetLogsCount(t *testing.T, metadataFilters MetadataFilters) (uint, error)
  • func (client *SumologicMockClient) GetMetricCounts(t *testing.T) (MetricCounts, error)
  • func (client *SumologicMockClient) GetMetricsSamples(metadataFilters MetadataFilters) ([]MetricSample, error)
  • func (client *SumologicMockClient) GetSpansCount(t *testing.T, metadataFilters MetadataFilters) (uint, error)
  • func (client *SumologicMockClient) GetTracesCounts(t *testing.T, metadataFilters MetadataFilters) ([]uint, error)
• type TraceId

Types

type Labels

type Labels map[string]string

Labels represent a key value mapping of labels names and their values. An empty label value indicates that we're interested in a label being present but we don't care about it's value.

func (Labels) DiffLabelNames

func (labels Labels) DiffLabelNames(requested Labels, skipRegex *regexp.Regexp) (extra []string, missing []string)

DiffLabelNames calculates the difference in label names between the two label sets. It returns two slices of strings: the names of labels from origin not in `requested`, and the names of labels from requested not in origin

func (Labels) Match

func (labels Labels) Match(label, value string) bool

func (Labels) MatchAll

func (labels Labels) MatchAll(requested Labels) bool

MatchAll matches returns whether all the requested labels are present and (if a corresponding value has been provided) that all values match matching is done via regex if the value is a valid regex, otherwise via strict equality the special value "" matches everything for historical reasons

func (Labels) MatchRegex

func (labels Labels) MatchRegex(label string, re *regexp.Regexp) bool

type LogsCountResponse

type LogsCountResponse struct {
	Count uint
}

type MetadataFilters

type MetadataFilters map[string]string

type MetricCounts

type MetricCounts map[string]int

Mapping of metric names to the number of times the metric was observed

type MetricSample

type MetricSample struct {
	Metric    string  `json:"metric,omitempty"`
	Value     float64 `json:"value,omitempty"`
	Labels    Labels  `json:"labels,omitempty"`
	Timestamp uint64  `json:"timestamp,omitempty"`
}

type MetricsSamplesByTime

type MetricsSamplesByTime []MetricSample

func (MetricsSamplesByTime) Len

func (m MetricsSamplesByTime) Len() int

func (MetricsSamplesByTime) Less

func (m MetricsSamplesByTime) Less(i, j int) bool

func (MetricsSamplesByTime) Swap

func (m MetricsSamplesByTime) Swap(i, j int)

type Span

type Span struct {
	Name         string  `json:"name,omitempty"`
	Id           SpanId  `json:"id,omitempty"`
	TraceId      TraceId `json:"trace_id,omitempty"`
	ParentSpanId SpanId  `json:"parent_span_id,omitempty"`
	Labels       Labels  `json:"attributes,omitempty"`
}

type SpanId

type SpanId string

type SumologicMockClient

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

A HTTP client for the sumologic-mock API

func NewClient

func NewClient(t *testing.T, baseUrl url.URL) *SumologicMockClient

func NewClientWithK8sTunnel

func NewClientWithK8sTunnel(
	ctx context.Context,
	envConf *envconf.Config,
	t *testing.T,
	serviceName string,
) (*SumologicMockClient, func())

NewClientWithK8sTunnel creates a client for sumologic-mock. It return the client itself and a tunnel teardown func which should be called by the caller when they're done with it.

func (*SumologicMockClient) GetLogsCount

func (client *SumologicMockClient) GetLogsCount(t *testing.T, metadataFilters MetadataFilters) (uint, error)

GetLogsCount returns the numbers of logs received by sumologic-mock that pass the provided metadata filter. Note that in the filter semantics, empty strings match any value

func (*SumologicMockClient) GetMetricCounts

func (client *SumologicMockClient) GetMetricCounts(t *testing.T) (MetricCounts, error)

GetMetricCounts returns the number of times each metric was received by sumologic-mock

func (*SumologicMockClient) GetMetricsSamples

func (client *SumologicMockClient) GetMetricsSamples(
	metadataFilters MetadataFilters,
) ([]MetricSample, error)

GetMetricSamples returns metric samples received by sumologic-mock that pass the provided metadata filter. Note that in the filter semantics, empty strings match any value

func (*SumologicMockClient) GetSpansCount

func (client *SumologicMockClient) GetSpansCount(t *testing.T, metadataFilters MetadataFilters) (uint, error)

func (*SumologicMockClient) GetTracesCounts

func (client *SumologicMockClient) GetTracesCounts(t *testing.T, metadataFilters MetadataFilters) ([]uint, error)

type TraceId

type TraceId string