diff --git a/README.md b/README.md index ac504be95f..ab68e41dc1 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,11 @@   •   Components   •   - Monitoring + Monitoring   •   - Security + Security   •   - Sizing + Sizing   •   Troubleshooting @@ -85,18 +85,18 @@ The following resources are available: - [Architecture](docs/architecture.md): How the Collector can be deployed - [Components](docs/components.md): What the Collector supports with links to documentation -- [Monitoring](docs/monitoring.md): How to ensure the Collector is healthy -- [Security](docs/security.md): How to ensure the Collector is secure -- [Sizing](docs/sizing.md): How to ensure the Collector is properly sized +- [Monitoring](https://docs.splunk.com/observability/en/gdi/opentelemetry/opentelemetry.html#otel-monitoring): How to ensure the Collector is healthy +- [Security](https://docs.splunk.com/Observability/gdi/opentelemetry/security.html): How to ensure the Collector is secure +- [Sizing](https://docs.splunk.com/Observability/gdi/opentelemetry/sizing.html): How to ensure the Collector is properly sized - [Troubleshooting](docs/troubleshooting.md): How to resolve common issues All you need to get started is: - [Splunk Access Token](https://docs.splunk.com/observability/admin/authentication/authentication-tokens/org-tokens.html) - [Splunk Realm](https://dev.splunk.com/observability/docs/realms_in_endpoints/) -- [Agent or Gateway mode](docs/agent-vs-gateway.md) +- [Agent or Gateway mode](https://docs.splunk.com/Observability/gdi/opentelemetry/deployment-modes.html) - [Confirm exposed - ports](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/security.md#exposed-endpoints) + ports](https://docs.splunk.com/Observability/gdi/opentelemetry/exposed-endpoints.html) to make sure your environment doesn't have conflicts and that firewalls are configured properly. Ports can be changed in the collector's configuration. @@ -255,7 +255,7 @@ In order to use the upstream OpenTelemetry Collector: - Properly configure the Collector for your particular metrics, traces, and logs use cases, as only a minimal default configuration is provided by the contrib release. An example configuration for upstream, that ensures [infrastructure -correlation](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/apm-infra-correlation.md) +correlation](https://docs.splunk.com/observability/en/metrics-and-metadata/relatedcontent-collector-apm.html) is properly configured, is available [here](https://github.com/signalfx/splunk-otel-collector/blob/main/cmd/otelcol/config/collector/upstream_agent_config.yaml). diff --git a/deployments/ansible/roles/collector/README.md b/deployments/ansible/roles/collector/README.md index a8da652412..6d29b51b79 100644 --- a/deployments/ansible/roles/collector/README.md +++ b/deployments/ansible/roles/collector/README.md @@ -8,7 +8,7 @@ Observability Cloud](https://www.splunk.com/en_us/observability.html). - [Splunk Access Token](https://docs.splunk.com/observability/admin/authentication/authentication-tokens/org-tokens.html) - [Splunk Realm](https://dev.splunk.com/observability/docs/realms_in_endpoints/) -- [Double-check exposed ports](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/security.md#exposed-endpoints) +- [Double-check exposed ports](https://docs.splunk.com/observability/en/gdi/opentelemetry/exposed-endpoints.html) to make sure your environment doesn't have conflicts. Ports can be changed in the collector's configuration. ## Usage diff --git a/deployments/chef/README.md b/deployments/chef/README.md index 612693eeee..d7b4b22d06 100644 --- a/deployments/chef/README.md +++ b/deployments/chef/README.md @@ -9,7 +9,7 @@ https://www.splunk.com/en_us/observability.html). - [Splunk Access Token](https://docs.splunk.com/observability/admin/authentication/authentication-tokens/org-tokens.html) - [Splunk Realm](https://dev.splunk.com/observability/docs/realms_in_endpoints/) -- [Double-check exposed ports](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/security.md#exposed-endpoints) +- [Double-check exposed ports](https://docs.splunk.com/observability/en/gdi/opentelemetry/exposed-endpoints.html) to make sure your environment doesn't have conflicts. Ports can be changed in the collector's configuration. ## Linux diff --git a/deployments/salt/README.md b/deployments/salt/README.md index a2b6cca81f..20eb8b1384 100644 --- a/deployments/salt/README.md +++ b/deployments/salt/README.md @@ -17,7 +17,7 @@ Currently, the following Linux distributions and versions are supported: - [Splunk Access Token](https://docs.splunk.com/observability/admin/authentication/authentication-tokens/org-tokens.html) - [Splunk Realm](https://dev.splunk.com/observability/docs/realms_in_endpoints/) -- [Double-check exposed ports](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/security.md#exposed-endpoints) +- [Double-check exposed ports](https://docs.splunk.com/observability/en/gdi/opentelemetry/exposed-endpoints.html) to make sure your environment doesn't have conflicts. Ports can be changed in the collector's configuration. ## Usage diff --git a/docs/agent-vs-gateway.md b/docs/agent-vs-gateway.md deleted file mode 100644 index 324df40623..0000000000 --- a/docs/agent-vs-gateway.md +++ /dev/null @@ -1,4 +0,0 @@ -The official Splunk documentation for this page is [Collector deployment modes](https://docs.splunk.com/Observability/gdi/opentelemetry/deployment-modes.html). - -For instructions on how to contribute to the docs, see [CONTRIBUTING.md](https://github.com/splunk/public-o11y-docs/blob/main/CONTRIBUTING.md). - diff --git a/docs/apm-infra-correlation.md b/docs/apm-infra-correlation.md deleted file mode 100644 index aa7721db86..0000000000 --- a/docs/apm-infra-correlation.md +++ /dev/null @@ -1,3 +0,0 @@ -The official Splunk documentation for this page is [Configure the Collector to enable Related Content for Infra and APM](https://docs.splunk.com/observability/en/metrics-and-metadata/relatedcontent-collector-apm.html). - -For instructions on how to contribute to the docs, see [CONTRIBUTING.md](https://github.com/splunk/public-o11y-docs/blob/main/CONTRIBUTING.md). diff --git a/docs/glossary.md b/docs/glossary.md deleted file mode 100644 index c359cc6d8a..0000000000 --- a/docs/glossary.md +++ /dev/null @@ -1,4 +0,0 @@ -The official Splunk documentation for this page is [Overview of the Splunk Distribution of OpenTelemetry Collector](https://docs.splunk.com/observability/en/references/glossary.html). - -For instructions on how to contribute to the docs, see [CONTRIBUTING.md](../CONTRIBUTING#documentation.md). - diff --git a/docs/monitoring.md b/docs/monitoring.md deleted file mode 100644 index d92f1ac3f1..0000000000 --- a/docs/monitoring.md +++ /dev/null @@ -1,4 +0,0 @@ -The official Splunk documentation for this page is [Overview of the Splunk Distribution of OpenTelemetry Collector](https://docs.splunk.com/observability/en/gdi/opentelemetry/opentelemetry.html#otel-monitoring). - -For instructions on how to contribute to the docs, see [CONTRIBUTING.md](../CONTRIBUTING#documentation.md). - diff --git a/docs/security.md b/docs/security.md deleted file mode 100644 index bef0f4a500..0000000000 --- a/docs/security.md +++ /dev/null @@ -1,11 +0,0 @@ -The official Splunk documentation for this page is [Security guidelines, permissions, and dependencies](https://docs.splunk.com/Observability/gdi/opentelemetry/security.html). - -See also official Splunk documentation for [Exposed ports and endpoints](https://docs.splunk.com/Observability/gdi/opentelemetry/exposed-endpoints.html). - -For instructions on how to contribute to the docs, see [CONTRIBUTING.md](../CONTRIBUTING#documentation.md). - -# Reporting Security Issues - -Please *DO NOT* report security vulnerabilities via public GitHub issue -reports. Please [report security issues here]( -https://www.splunk.com/en_us/product-security/report.html). \ No newline at end of file diff --git a/docs/sizing.md b/docs/sizing.md deleted file mode 100644 index b2b88296bd..0000000000 --- a/docs/sizing.md +++ /dev/null @@ -1,4 +0,0 @@ -The official Splunk documentation for this page is [Sizing and scaling](https://docs.splunk.com/Observability/gdi/opentelemetry/sizing.html). - -For instructions on how to contribute to the docs, see [CONTRIBUTING.md](../CONTRIBUTING#documentation.md). -