Package: go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc/internal/observ

package observ Import Path go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc/internal/observ (on go.dev) Dependency Relation imports 18 packages, and imported by one package

Involved Source Files d doc.go Package observ provides experimental observability instrumentation for the otlptracegrpc exporter. instrumentation.go target.go

Package-Level Type Names (total 2)

/* sort by: alphabet | popularity */

type ExportOp (struct) ExportOp tracks the operation being observed by [Instrumentation.ExportSpans]. Methods (only one) ( ExportOp) End(err error, code codes.Code) End completes the observation of the operation being observed by a call to [Instrumentation.ExportSpans]. Any error that is encountered is provided as err. If err is not nil, all spans will be recorded as failures unless error is of type [internal.PartialSuccess]. In the case of a PartialSuccess, the number of successfully exported spans will be determined by inspecting the RejectedItems field of the PartialSuccess. As Outputs Of (at least one exported) func (*Instrumentation).ExportSpans(ctx context.Context, nSpans int) ExportOp

type Instrumentation (struct) Instrumentation is experimental instrumentation for the exporter. Methods (only one) (*Instrumentation) ExportSpans(ctx context.Context, nSpans int) ExportOp ExportSpans instruments the ExportSpans method of the exporter. It returns an [ExportOp] that must have its [ExportOp.End] method called when the ExportSpans method returns. As Outputs Of (at least one exported) func NewInstrumentation(id int64, target string) (*Instrumentation, error)

Package-Level Functions (total 4)

func BaseAttrs(id int64, target string) []attribute.KeyValue BaseAttrs returns the base attributes for the exporter with the provided ID and target. The id should be the unique exporter instance ID. It is used to set the "component.name" attribute. The target is the gRPC target the exporter is exporting to. It is expected to be the output of the Client's CanonicalTarget method.

func ComponentName(id int64) string ComponentName returns the component name for the exporter with the provided ID.

func NewInstrumentation(id int64, target string) (*Instrumentation, error) NewInstrumentation returns instrumentation for an OTLP over gPRC trace exporter with the provided ID using the global MeterProvider. The id should be the unique exporter instance ID. It is used to set the "component.name" attribute. The target is the endpoint the exporter is exporting to. If the experimental observability is disabled, nil is returned.

func ParseCanonicalTarget(target string) (string, int, error) ParseCanonicalTarget parses a target string and returns the extracted host (domain address or IP), the target port, or an error. If no port is specified, -1 is returned. If no host is specified, an empty string is returned. The target string is expected to always have the form "<scheme>://[authority]/<endpoint>". For example: - "dns:///example.com:42" - "dns://8.8.8.8/example.com:42" - "unix:///path/to/socket" - "unix-abstract:///socket-name" - "passthrough:///192.34.2.1:42" The target is expected to come from the CanonicalTarget method of a gRPC Client.

Package-Level Constants (total 3)

const SchemaURL = "https://opentelemetry.io/schemas/1.40.0" SchemaURL is the schema URL of the metrics produced by this instrumentation.

const ScopeName = "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc/inte... ScopeName is the unique name of the meter used for instrumentation.

const Version = "1.42.0" Version is the current version of this instrumentation. This matches the version of the exporter.