From b0cf0efe370ee56bde11421bff67b9caa50b1eab Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 19 Nov 2019 10:30:13 -0800 Subject: [PATCH 1/4] Update README to list proxy support. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 5fbf33a28ff..124e7a7965f 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ recommended you use the - [Exporters](#config-exporters) - [Extensions](#config-extensions) - [Service](#config-service) + - [Other](#config-other) ## Introduction @@ -306,6 +307,19 @@ service: exporters: [opencensus, zipkin] ``` +### Other + +Beyond standard YAML configuration of the Collector, the Collector also +respects additional configuration parameters such as certain environment +variables. This section captures these additionally respected configuration +options. + +*HTTP_PROXY / HTTPS_PROXY* + +The Collector respects the `HTTP_PROXY` and `HTTPS_PROXY` environment +variables. If set at Collector start time then both REST and gRPC exporters +will proxy traffic as defined by these environment variables. + [travis-image]: https://travis-ci.org/open-telemetry/opentelemetry-service.svg?branch=master [travis-url]: https://travis-ci.org/open-telemetry/opentelemetry-service [godoc-image]: https://godoc.org/github.com/open-telemetry/opentelemetry-collector?status.svg From 9f308d68fd236ab8254993c64e52841874747e46 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 19 Nov 2019 10:32:43 -0800 Subject: [PATCH 2/4] Make section bold --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 124e7a7965f..86f254ee104 100644 --- a/README.md +++ b/README.md @@ -314,7 +314,7 @@ respects additional configuration parameters such as certain environment variables. This section captures these additionally respected configuration options. -*HTTP_PROXY / HTTPS_PROXY* +**HTTP_PROXY / HTTPS_PROXY** The Collector respects the `HTTP_PROXY` and `HTTPS_PROXY` environment variables. If set at Collector start time then both REST and gRPC exporters From 7837350d68c77cde3ade3b092f49d6703a700603 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Fri, 22 Nov 2019 09:56:20 -0500 Subject: [PATCH 3/4] Move proxy documentation to exporters README --- README.md | 14 -------------- exporter/README.md | 13 +++++++++++++ 2 files changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 86f254ee104..5fbf33a28ff 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,6 @@ recommended you use the - [Exporters](#config-exporters) - [Extensions](#config-extensions) - [Service](#config-service) - - [Other](#config-other) ## Introduction @@ -307,19 +306,6 @@ service: exporters: [opencensus, zipkin] ``` -### Other - -Beyond standard YAML configuration of the Collector, the Collector also -respects additional configuration parameters such as certain environment -variables. This section captures these additionally respected configuration -options. - -**HTTP_PROXY / HTTPS_PROXY** - -The Collector respects the `HTTP_PROXY` and `HTTPS_PROXY` environment -variables. If set at Collector start time then both REST and gRPC exporters -will proxy traffic as defined by these environment variables. - [travis-image]: https://travis-ci.org/open-telemetry/opentelemetry-service.svg?branch=master [travis-url]: https://travis-ci.org/open-telemetry/opentelemetry-service [godoc-image]: https://godoc.org/github.com/open-telemetry/opentelemetry-collector?status.svg diff --git a/exporter/README.md b/exporter/README.md index d21c134d8a3..4a89b2c28ae 100644 --- a/exporter/README.md +++ b/exporter/README.md @@ -11,6 +11,19 @@ Below is the list of exporters directly supported by the OpenTelemetry Collector The [contributors repository](https://github.com/open-telemetry/opentelemetry-service-contrib) has more exporters that can be added to custom builds of the service. +## Proxy Support + +Beyond standard YAML configuration as outlined in the sections that follow, +exporters that leverage the net/http package (all do today) also respects the +following proxy environment variables: + +* HTTP_PROXY +* HTTPS_PROXY +* NO_PROXY + +If set at Collector start time then exporters regardless of protocol +will or will not proxy traffic as defined by these environment variables. + ## Data Ownership When multiple exporters are configured to send the same data (e.g. by configuring multiple From 75292dfb6890ac407b66be2557b2050b6f59a155 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Fri, 22 Nov 2019 09:58:18 -0500 Subject: [PATCH 4/4] Update wording --- exporter/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/exporter/README.md b/exporter/README.md index 4a89b2c28ae..20c90c8041d 100644 --- a/exporter/README.md +++ b/exporter/README.md @@ -14,14 +14,14 @@ The [contributors repository](https://github.com/open-telemetry/opentelemetry-se ## Proxy Support Beyond standard YAML configuration as outlined in the sections that follow, -exporters that leverage the net/http package (all do today) also respects the +exporters that leverage the net/http package (all do today) also respect the following proxy environment variables: * HTTP_PROXY * HTTPS_PROXY * NO_PROXY -If set at Collector start time then exporters regardless of protocol +If set at Collector start time then exporters, regardless of protocol, will or will not proxy traffic as defined by these environment variables. ## Data Ownership