From 8e544c044367525b72386725532b3ee563a0e782 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Fri, 26 Jul 2024 16:47:27 +0200 Subject: [PATCH] Document that only tracing is supported (#964) * Document that only tracing is supported * Fix typo --- COMPATIBILITY.md | 20 ++++++++++---------- README.md | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md index f0614f6bc..d93532b9e 100644 --- a/COMPATIBILITY.md +++ b/COMPATIBILITY.md @@ -3,7 +3,7 @@ ## Default `otel` Global Providers Compatibility Auto-instrumentation can be configured to capture the telemetry sent to the -[`otel`] default global providers. +[`otel`] default global tracer provider. Supported versions of [`otel`]: @@ -13,18 +13,18 @@ Supported versions of [`otel`]: ## Instrumented Library Compatibility -Instrumentation is provided for the following Go libraries. +Tracing instrumentation is provided for the following Go libraries. -- [`database/sql`](#database/sql) -- [`github.com/segmentio/kafka-go`](#github.com/segmentio/kafka-go) -- [`google.golang.org/grpc`](#google.golang.org/grpc) -- [`net/http`](#net/http) +- [`database/sql`](#databasesql) +- [`github.com/segmentio/kafka-go`](#githubcomsegmentiokafka-go) +- [`google.golang.org/grpc`](#googlegolangorggrpc) +- [`net/http`](#nethttp) ### database/sql [Package documentation](https://pkg.go.dev/database/sql) -Supported version ranges: +Supported version ranges: - `go1.12` to `go1.22.5` @@ -32,7 +32,7 @@ Supported version ranges: [Package documentation](https://pkg.go.dev/github.com/segmentio/kafka-go) -Supported version ranges: +Supported version ranges: - `v0.4.1` to `v0.4.47` @@ -40,7 +40,7 @@ Supported version ranges: [Package documentation](https://pkg.go.dev/google.golang.org/grpc) -Supported version ranges: +Supported version ranges: - `v1.14.0` to `v1.66.0` @@ -48,6 +48,6 @@ Supported version ranges: [Package documentation](https://pkg.go.dev/net/http) -Supported version ranges: +Supported version ranges: - `go1.12` to `go1.22.5` diff --git a/README.md b/README.md index 629bfb1ea..9fe443acf 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/auto)](https://pkg.go.dev/go.opentelemetry.io/auto) -This repository provides [OpenTelemetry] instrumentation for [Go] libraries using [eBPF]. +This repository provides [OpenTelemetry] tracing instrumentation for [Go] libraries using [eBPF]. :construction: This project is currently work in progress.