mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-16 10:19:23 +02:00
694c9a413d
* Interface stability documentation * Update versioning policy * Update CONTRIBUTING * Document how to extend immutable interfaces * Markdown format VERSIONING changes
55 lines
2.3 KiB
Go
55 lines
2.3 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package otlptrace // import "go.opentelemetry.io/otel/exporters/otlp/otlptrace"
|
|
|
|
import (
|
|
"context"
|
|
|
|
tracepb "go.opentelemetry.io/proto/otlp/trace/v1"
|
|
)
|
|
|
|
// Client manages connections to the collector, handles the
|
|
// transformation of data into wire format, and the transmission of that
|
|
// data to the collector.
|
|
type Client interface {
|
|
// DO NOT CHANGE: any modification will not be backwards compatible and
|
|
// must never be done outside of a new major release.
|
|
|
|
// Start should establish connection(s) to endpoint(s). It is
|
|
// called just once by the exporter, so the implementation
|
|
// does not need to worry about idempotence and locking.
|
|
Start(ctx context.Context) error
|
|
// DO NOT CHANGE: any modification will not be backwards compatible and
|
|
// must never be done outside of a new major release.
|
|
|
|
// Stop should close the connections. The function is called
|
|
// only once by the exporter, so the implementation does not
|
|
// need to worry about idempotence, but it may be called
|
|
// concurrently with UploadTraces, so proper
|
|
// locking is required. The function serves as a
|
|
// synchronization point - after the function returns, the
|
|
// process of closing connections is assumed to be finished.
|
|
Stop(ctx context.Context) error
|
|
// DO NOT CHANGE: any modification will not be backwards compatible and
|
|
// must never be done outside of a new major release.
|
|
|
|
// UploadTraces should transform the passed traces to the wire
|
|
// format and send it to the collector. May be called
|
|
// concurrently.
|
|
UploadTraces(ctx context.Context, protoSpans []*tracepb.ResourceSpans) error
|
|
// DO NOT CHANGE: any modification will not be backwards compatible and
|
|
// must never be done outside of a new major release.
|
|
}
|