ast

README

Schema v1.0 AST

Documentation

Index

• type AttributeChange
• type AttributeMap
• type AttributeMapForMetrics
• type AttributeMapForSpans
• type Attributes
• type Logs
• type LogsChange
• type Metrics
• type MetricsChange
• type RenameAttributes
• type RenameSpanEventAttributes
• type RenameSpanEvents
• type Schema
• type SpanEvents
• type SpanEventsChange
• type Spans
• type SpansChange
• type VersionDef

Types

type AttributeChange

type AttributeChange struct {
	RenameAttributes *RenameAttributes `yaml:"rename_attributes"`
}

AttributeChange corresponds to a section representing attribute changes.

type AttributeMap

type AttributeMap map[string]string

AttributeMap corresponds to a section representing a mapping of attribute names. The keys are the old attribute name used in the previous version, the values are the new attribute name starting from this version.

type AttributeMapForMetrics

type AttributeMapForMetrics struct {
	ApplyToMetrics []types.MetricName `yaml:"apply_to_metrics"`
	AttributeMap   AttributeMap       `yaml:"attribute_map"`
}

AttributeMapForMetrics corresponds to a section representing a translation of attributes for specific metrics.

type AttributeMapForSpans

type AttributeMapForSpans struct {
	ApplyToSpans []types.SpanName `yaml:"apply_to_spans"`
	AttributeMap AttributeMap     `yaml:"attribute_map"`
}

AttributeMapForSpans corresponds to a section representing a translation of attributes for specific spans.

type Attributes

type Attributes struct {
	Changes []AttributeChange
}

Attributes corresponds to a section representing a list of changes that happened in a particular version.

type Logs

type Logs struct {
	Changes []LogsChange
}

Logs corresponds to a section representing a list of changes that happened to logs schema in a particular version.

type LogsChange

type LogsChange struct {
	RenameAttributes *RenameAttributes `yaml:"rename_attributes"`
}

LogsChange corresponds to a section representing logs change.

type Metrics

type Metrics struct {
	Changes []MetricsChange
}

Metrics corresponds to a section representing a list of changes that happened to metrics schema in a particular version.

type MetricsChange

type MetricsChange struct {
	RenameMetrics    map[types.MetricName]types.MetricName `yaml:"rename_metrics"`
	RenameAttributes *AttributeMapForMetrics               `yaml:"rename_attributes"`
}

MetricsChange corresponds to a section representing metrics change.

type RenameAttributes

type RenameAttributes struct {
	AttributeMap AttributeMap `yaml:"attribute_map"`
}

RenameAttributes corresponds to a section that describes attribute renaming.

type RenameSpanEventAttributes

type RenameSpanEventAttributes struct {
	ApplyToSpans  []types.SpanName  `yaml:"apply_to_spans"`
	ApplyToEvents []types.EventName `yaml:"apply_to_events"`
	AttributeMap  AttributeMap      `yaml:"attribute_map"`
}

RenameSpanEventAttributes corresponds to section representing a renaming of attributes of span events.

type RenameSpanEvents

type RenameSpanEvents struct {
	EventNameMap map[string]string `yaml:"name_map"`
}

RenameSpanEvents corresponds to section representing a renaming of span events.

type Schema

type Schema struct {
	// Schema file format. SHOULD be 1.0.0 for the current specification version.
	// See https://github.com/open-telemetry/oteps/blob/main/text/0152-telemetry-schemas.md#schema-file-format-number
	FileFormat string `yaml:"file_format"`

	// Schema URL is an identifier of a Schema. The URL specifies a location of this
	// Schema File that can be retrieved (so it is a URL and not just a URI) using HTTP
	// or HTTPS protocol.
	// See https://github.com/open-telemetry/oteps/blob/main/text/0152-telemetry-schemas.md#schema-url
	SchemaURL string `yaml:"schema_url"`

	// Versions section that lists changes that happened in each particular version.
	Versions map[types.TelemetryVersion]VersionDef
}

Schema represents a Schema file in FileFormat 1.0.0 as defined in https://github.com/open-telemetry/oteps/blob/main/text/0152-telemetry-schemas.md

type SpanEvents

type SpanEvents struct {
	Changes []SpanEventsChange
}

SpanEvents corresponds to a section representing a list of changes that happened to span events schema in a particular version.

type SpanEventsChange

type SpanEventsChange struct {
	RenameEvents     *RenameSpanEvents          `yaml:"rename_events"`
	RenameAttributes *RenameSpanEventAttributes `yaml:"rename_attributes"`
}

SpanEventsChange corresponds to a section representing span events change.

type Spans

type Spans struct {
	Changes []SpansChange
}

Spans corresponds to a section representing a list of changes that happened to spans schema in a particular version.

type SpansChange

type SpansChange struct {
	RenameAttributes *AttributeMapForSpans `yaml:"rename_attributes"`
}

SpansChange corresponds to a section representing spans change.

type VersionDef

type VersionDef struct {
	All        Attributes
	Resources  Attributes
	Spans      Spans
	SpanEvents SpanEvents `yaml:"span_events"`
	Logs       Logs
	Metrics    Metrics
}

VersionDef corresponds to a section representing one version under the "versions" top-level key.