-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for proxy support.
- Loading branch information
Showing
2 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
Proxy Support | ||
============= | ||
|
||
The telemetry SDK includes support for HTTP proxies via environment variables and on MacOS / Windows via operating system registry as described in the Python `getproxies <https://docs.python.org/3/library/urllib.request.html#urllib.request.getproxies>`_ documentation. | ||
|
||
|
||
HTTP Proxy | ||
---------- | ||
|
||
The telemetry SDK only supports HTTPS over HTTP proxies. Therefore, the proxy must be configured using the ``https_proxy`` environment variable and the configured URL must have the scheme ``http``. | ||
|
||
Example | ||
^^^^^^^ | ||
|
||
.. code-block:: bash | ||
export https_proxy="http://myproxy.localhost:3128" | ||
Authenticated HTTP Proxy | ||
------------------------ | ||
|
||
The telemetry SDK supports proxy credentials sent over `basic auth <https://tools.ietf.org/html/rfc7617>`_. To use proxy authentication, the credentials should be specified in the ``https_proxy`` environment variable URL. | ||
|
||
.. DANGER:: | ||
|
||
Proxy credentials are sent in plaintext via an HTTP header. Any attacker with access to the network transporting the proxy credentials will be able to observe the proxy credentials. New Relic credentials are never sent in plaintext. | ||
|
||
Example | ||
^^^^^^^ | ||
|
||
.. code-block:: bash | ||
export https_proxy="http://username:password@myproxy.localhost:3128" |