From e1d6639de0ef2e3c07f7de99130acfd9cf2df326 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 16 Feb 2021 18:58:56 -0500 Subject: [PATCH] Add information about security documentation to exporter README (#2341) Attempts to address: - open-telemetry/opentelemetry-collector-contrib#2230 - open-telemetry/opentelemetry-collector-contrib#2231 - open-telemetry/opentelemetry-collector-contrib#2232 - open-telemetry/opentelemetry-collector-contrib#2233 --- exporter/datadogexporter/README.md | 5 +++++ exporter/dynatraceexporter/README.md | 5 +++++ exporter/newrelicexporter/README.md | 5 +++++ exporter/sapmexporter/README.md | 5 +++++ 4 files changed, 20 insertions(+) diff --git a/exporter/datadogexporter/README.md b/exporter/datadogexporter/README.md index 333de3d271c7..b2fe7eee651f 100644 --- 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 index de467a31ce95..1319b9c4ad76 100644 --- 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 index 82bf8a8460c4..e25972c8a53c 100644 --- 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 index 276cdf14cd62..73043d7fda79 100644 --- 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: