From 3e80bf5932949e86a031a2a0787b6d1ed81f3f49 Mon Sep 17 00:00:00 2001 From: Mike Goldsmth Date: Tue, 30 May 2023 11:09:13 +0100 Subject: [PATCH] Update README with details on forked repo --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 9c5c637fd..27987728c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # Language Independent Interface Types For OpenTelemetry +**NOTE** + +This is a modified version of the Go OpenTelemtry protobuf files to re-add deprecated/removed Metric types (IntSum, IntGuage, IntHistogram) and label type (StringKeyValue). + +You should not depend on these protobuf files directly, instead use the Honeycomb fork of the [opentelemetry-proto-go](https://github.com/honeycombio/opentelemetry-proto-go) package which includes these changes. + +This repo is currently pinned to [v0.19.0](https://github.com/open-telemetry/opentelemetry-proto/tree/v0.19.0) of the upstream repository. + [![Build Check](https://github.com/open-telemetry/opentelemetry-proto/workflows/Build%20Check/badge.svg?branch=main)](https://github.com/open-telemetry/opentelemetry-proto/actions?query=workflow%3A%22Build+Check%22+branch%3Amain) The proto files can be consumed as GIT submodules or copied and built directly in the consumer project.