Add information about security documentation to exporter README

Attempts to address: - open-telemetry#2230 - open-telemetry#2231 - open-telemetry#2232 - open-telemetry#2233
flands · Feb 13, 2021 · 41e45ba · 41e45ba
1 parent 723ee26
commit 41e45ba
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/exporter/datadogexporter/README.md b/exporter/datadogexporter/README.md
@@ -2,6 +2,11 @@
 
 This exporter sends metric and trace data to [Datadog](https://datadoghq.com).
 
+> Please review the Collector's [security
+> documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security.md),
+> which contains recommendations on securing sensitive information such as the
+> API key required by this exporter.
+
 ## Configuration
 
 The only required setting is a [Datadog API key](https://app.datadoghq.com/account/settings#api).

diff --git a/exporter/dynatraceexporter/README.md b/exporter/dynatraceexporter/README.md
@@ -6,6 +6,11 @@ This enables Dynatrace to receive metrics collected by the OpenTelemetry Collect
 
 The requests sent to Dynatrace are authenticated using an API token mechanism documented [here](https://www.dynatrace.com/support/help/dynatrace-api/basics/dynatrace-api-authentication/).
 
+> Please review the Collector's [security
+> documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security.md),
+> which contains recommendations on securing sensitive information such as the
+> API key required by this exporter.
+
 ## Configuration
 
 A Dynatrace API Token and metrics ingest endpoint are required.

diff --git a/exporter/newrelicexporter/README.md b/exporter/newrelicexporter/README.md
@@ -2,6 +2,11 @@
 
 This exporter supports sending trace and metric data to [New Relic](https://newrelic.com/)
 
+> Please review the Collector's [security
+> documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security.md),
+> which contains recommendations on securing sensitive information such as the
+> API key required by this exporter.
+
 ## Configuration
 
 The following configuration options are supported:

diff --git a/exporter/sapmexporter/README.md b/exporter/sapmexporter/README.md
@@ -6,6 +6,11 @@ and some useful related utilities can be found [here](https://github.com/signalf
 
 Supported pipeline types: traces
 
+> Please review the Collector's [security
+> documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security.md),
+> which contains recommendations on securing sensitive information such as the
+> API key required by this exporter.
+
 ## Configuration
 
 The following configuration options are required: