1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-12 10:04:29 +02:00
opentelemetry-go/schema
Tyler Yahn de94fafd17
Do no silently drop unknown schema data (#3743)
* Do no silently drop unknown schema data

* Add entry to changelog

* Add PR number to changelog

---------

Co-authored-by: Chester Cheung <cheung.zhy.csu@gmail.com>
Co-authored-by: Aaron Clawson <3766680+MadVikingGod@users.noreply.github.com>
2023-02-21 08:39:38 -08:00
..
internal Introduce "split" metric schema transformation (#2999) 2022-07-25 08:30:23 -07:00
v1.0 Introduce "split" metric schema transformation (#2999) 2022-07-25 08:30:23 -07:00
v1.1 Do no silently drop unknown schema data (#3743) 2023-02-21 08:39:38 -08:00
go.mod Bump github.com/Masterminds/semver/v3 from 3.1.1 to 3.2.0 in /schema (#3511) 2022-12-04 09:41:44 -08:00
go.sum Bump github.com/Masterminds/semver/v3 from 3.1.1 to 3.2.0 in /schema (#3511) 2022-12-04 09:41:44 -08:00
README.md Introduce "split" metric schema transformation (#2999) 2022-07-25 08:30:23 -07:00

Telemetry Schema Files

The schema module contains packages that help to parse and validate schema files.

Each major.minor schema file format version is implemented as a separate package, with the name of the package in the vmajor.minor form.

To parse a schema file, first decide what file format version you want to parse, then import the corresponding package and use the Parse or ParseFile functions like this:

import schema "go.opentelemetry.io/otel/schema/v1.1"

// Load the schema from a file in v1.1.x file format.
func loadSchemaFromFile() error {
	telSchema, err := schema.ParseFile("schema-file.yaml")
	if err != nil {
		return err
	}
	// Use telSchema struct here.
}

// Alternatively use schema.Parse to read the schema file from io.Reader.
func loadSchemaFromReader(r io.Reader) error {
	telSchema, err := schema.Parse(r)
	if err != nil {
		return err
	}
	// Use telSchema struct here.
}