convert

Documentation

Index

• Variables
• func FromMetric(id ident.ID, tags ident.Tags) (doc.Document, error)
• func FromMetricIter(id ident.ID, tags ident.TagIterator) (doc.Document, error)
• func FromMetricIterNoClone(id ident.ID, tags ident.TagIterator) (doc.Document, error)
• func FromMetricNoClone(id ident.ID, tags ident.Tags) (doc.Document, error)
• func TagsFromTagsIter(seriesID ident.ID, iter ident.TagIterator, idPool ident.Pool) (ident.Tags, error)
• func ToMetric(d doc.Document, opts Opts) (ident.ID, ident.TagIterator, error)
• func ToMetricTags(d doc.Document, opts Opts) ident.TagIterator
• func ValidateSeries(id ident.ID, tags ident.Tags) error
• func ValidateSeriesTag(tag ident.Tag) error
• type Opts

Variables

var (
	// ReservedFieldNameID is the field name used to index the ID in the
	// m3ninx subsytem.
	ReservedFieldNameID = doc.IDReservedFieldName

	// ErrUsingReservedFieldName is the error returned when a metric
	// cannot be parsed due to using a resereved field name
	ErrUsingReservedFieldName = errors.New(
		"unable to parse metric using reserved field name: " +
			string(ReservedFieldNameID))
)

Functions

func FromMetric

func FromMetric(id ident.ID, tags ident.Tags) (doc.Document, error)

FromMetric converts the provided metric id+tags into a document. FOLLOWUP(r): Rename FromMetric to FromSeries (metric terminiology is not common in the codebase)

func FromMetricIter

func FromMetricIter(id ident.ID, tags ident.TagIterator) (doc.Document, error)

FromMetricIter converts the provided metric id+tags into a document. FOLLOWUP(r): Rename FromMetric to FromSeries (metric terminiology is not common in the codebase)

func FromMetricIterNoClone

func FromMetricIterNoClone(id ident.ID, tags ident.TagIterator) (doc.Document, error)

FromMetricIterNoClone converts the provided metric id+tags iterator into a document without cloning.

func FromMetricNoClone

func FromMetricNoClone(id ident.ID, tags ident.Tags) (doc.Document, error)

FromMetricNoClone converts the provided metric id+tags into a document without cloning.

func TagsFromTagsIter

func TagsFromTagsIter(
	seriesID ident.ID,
	iter ident.TagIterator,
	idPool ident.Pool,
) (ident.Tags, error)

TagsFromTagsIter returns an ident.Tags from a TagIterator. It also tries to re-use bytes from the seriesID if they're also present in the tags instead of re-allocating them. This requires that the ident.Tags that is returned will have the same (or shorter) life time as the seriesID, otherwise the operation is unsafe.

func ToMetric

func ToMetric(d doc.Document, opts Opts) (ident.ID, ident.TagIterator, error)

ToMetric converts the provided doc to metric id+tags.

func ToMetricTags

func ToMetricTags(d doc.Document, opts Opts) ident.TagIterator

ToMetricTags converts the provided doc to metric tags.

func ValidateSeries

func ValidateSeries(id ident.ID, tags ident.Tags) error

ValidateSeries will validate a metric for use with m3ninx.

func ValidateSeriesTag

func ValidateSeriesTag(tag ident.Tag) error

ValidateSeriesTag validates a series tag for use with m3ninx.

Types

type Opts

type Opts struct {
	IdentPool        ident.Pool
	CheckedBytesPool pool.CheckedBytesPool
	NoClone          bool
}

Opts are the pools required for conversions.