schema

module
v0.0.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 29, 2025 License: Apache-2.0, BSD-3-Clause

README

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.
}

Directories

Path Synopsis
Package internal provides internal functionality for the schema package.
Package internal provides internal functionality for the schema package.
Package schema provides functionality and types for OpenTelemetry schemas.
Package schema provides functionality and types for OpenTelemetry schemas.
ast
Package ast provides abstract syntax tree parsing for the OpenTelemetry schema.
Package ast provides abstract syntax tree parsing for the OpenTelemetry schema.
types
Package types provides types for the OpenTelemetry schema.
Package types provides types for the OpenTelemetry schema.
Package schema provides functionality and types for OpenTelemetry schemas.
Package schema provides functionality and types for OpenTelemetry schemas.
ast
Package ast provides abstract syntax tree parsing for the OpenTelemetry schema.
Package ast provides abstract syntax tree parsing for the OpenTelemetry schema.
types
Package types provides types for the OpenTelemetry schema.
Package types provides types for the OpenTelemetry schema.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL