From ceef4941be9e7e77136afb80888973f2e9984f9a Mon Sep 17 00:00:00 2001 From: ericksoen Date: Tue, 31 Aug 2021 09:48:42 -0500 Subject: [PATCH] docs: migrate extension links to opentelemetry-collector-contrib repo reference (#3934) --- config/configgrpc/README.md | 2 +- docs/troubleshooting.md | 10 +++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/config/configgrpc/README.md b/config/configgrpc/README.md index 4f5c878eb6b..a2d28d2f6af 100644 --- a/config/configgrpc/README.md +++ b/config/configgrpc/README.md @@ -26,7 +26,7 @@ README](../configtls/README.md). - [`read_buffer_size`](https://godoc.org/google.golang.org/grpc#ReadBufferSize) - [`write_buffer_size`](https://godoc.org/google.golang.org/grpc#WriteBufferSize) -Please note that [`per_rpc_auth`](https://pkg.go.dev/google.golang.org/grpc#PerRPCCredentials) which allows the credentials to send for every RPC is now moved to become an [extension](https://github.com/open-telemetry/opentelemetry-collector/tree/main/extension/bearertokenauthextension). Note that this feature isn't about sending the headers only during the initial connection as an `authorization` header under the `headers` would do: this is sent for every RPC performed during an established connection. +Please note that [`per_rpc_auth`](https://pkg.go.dev/google.golang.org/grpc#PerRPCCredentials) which allows the credentials to send for every RPC is now moved to become an [extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/bearertokenauthextension). Note that this feature isn't about sending the headers only during the initial connection as an `authorization` header under the `headers` would do: this is sent for every RPC performed during an established connection. Example: diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 290b151589d..b612b30d377 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -168,7 +168,7 @@ Attributes: ### Health Check The -[health_check](https://github.com/open-telemetry/opentelemetry-collector/tree/main/extension/healthcheckextension/README.md) +[health_check](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/healthcheckextension/README.md) extension, which by default is available on all interfaces on port `13133`, can be used to ensure the Collector is functioning properly. @@ -182,13 +182,17 @@ service: It returns a response like the following: ```json -{"status":"Server available","upSince":"2020-11-11T04:12:31.6847174Z","uptime":"49.0132518s"} +{ + "status": "Server available", + "upSince": "2020-11-11T04:12:31.6847174Z", + "uptime": "49.0132518s" +} ``` ### pprof The -[pprof](https://github.com/open-telemetry/opentelemetry-collector/tree/main/extension/pprofextension/README.md) +[pprof](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/pprofextension/README.md) extension, which by default is available locally on port `1777`, allows you to profile the Collector as it runs. This is an advanced use-case that should not be needed in most circumstances.