Decentralize component documentation (#1089)

* Split out processor READMEs

* Split out exporter READMEs

* Split out extension READMEs

* Split out receiver READMEs

* Add new line at end of READMEs

Author: asuresh4

docs/troubleshooting.md

@@ -14,15 +14,15 @@ to the `otelcol` process. See `--help` for more details.
 - [Local exporters](https://github.com/open-telemetry/opentelemetry-collector/tree/master/exporter#local-exporters)
 can be configured to inspect the data being processed by the Collector.
 
-- The [health_check](https://github.com/open-telemetry/opentelemetry-collector/blob/master/extension/README.md#health_check)
+- The [health_check](https://github.com/open-telemetry/opentelemetry-collector/tree/master/extension/healthcheckextension/README.md)
 extension, which by default is on port `13133`, can be used to ensure
 the Collector is functioning properly.
 
-- The [zpages](https://github.com/open-telemetry/opentelemetry-collector/blob/master/extension/README.md#zpages)
+- The [zpages](https://github.com/open-telemetry/opentelemetry-collector/tree/master/extension/zpagesextension/README.md)
 extension, which by default is on port `55679`, can be used to check
 receivers and exporters trace operations via `/debug/tracez`.
 
-- The [pprof](https://github.com/open-telemetry/opentelemetry-collector/blob/master/extension/README.md#pprof)
+- The [pprof](https://github.com/open-telemetry/opentelemetry-collector/tree/master/extension/pprofextension/README.md)
 extension, which by default is on port `1777`, allows you to profile the
 Collector as it runs.
 
@@ -35,7 +35,7 @@ The Collector may exit/restart if it is not
 or configured properly, for example a queue size configured higher than
 available memory. In most cases, restarts are due to memory
 pressure. To mitigate this, we recommend you configure the
-[memory_limiter](https://github.com/open-telemetry/opentelemetry-collector/tree/master/processor#memory-limiter)
+[memory_limiter](https://github.com/open-telemetry/opentelemetry-collector/blob/master/processor/memorylimiter/README.md)
 processor.
 
 Note: restarts may be due to resource limits configured on the Collector.
@@ -48,7 +48,7 @@ Data may be dropped for a variety of reasons, but most commonly because of an:
 - Exporter destination unavailable or accepting the data too slowly.
 
 To mitigate drops, it is highly recommended to configure the
-[queued_retry](https://github.com/open-telemetry/opentelemetry-collector/tree/master/processor#queued-retry)
+[queued_retry](https://github.com/open-telemetry/opentelemetry-collector/blob/master/processor/queuedprocessor/README.md)
 processor.
 
 ### Receiving data not working

exporter/README.md

@@ -5,20 +5,20 @@ exporter translates the internal format into another defined format.
 
 Supported trace exporters (sorted alphabetically):
 
-- [Jaeger](#jaeger)
-- [OpenCensus](#opencensus-traces)
-- [OTLP](#otlp-traces)
-- [Zipkin](#zipkin)
+- [Jaeger](jaegerexporter/README.md)
+- [OpenCensus](opencensusexporter/README.md)
+- [OTLP](otlpexporter/README.md)
+- [Zipkin](zipkinexporter/README.md)
 
 Supported metric exporters (sorted alphabetically):
 
-- [OpenCensus](#opencensus-metrics)
-- [Prometheus](#prometheus)
+- [OpenCensus](opencensusexporter/README.md)
+- [Prometheus](prometheusexporter/README.md)
 
 Supported local exporters (sorted alphabetically):
 
-- [File](#file)
-- [Logging](#logging)
+- [File](fileexporter/README.md)
+- [Logging](loggingexporter/README.md)
 
 The [contributors repository](https://github.com/open-telemetry/opentelemetry-collector-contrib)
  has more exporters that can be added to custom builds of the Collector.
@@ -45,222 +45,5 @@ function is called. Exporters MUST NOT modify the `TraceData`/`MetricsData` argu
 these functions. If the exporter needs to modify the data while performing the exporting
 the exporter can clone the data and perform the modification on the clone or use a
 copy-on-write approach for individual sub-parts of `TraceData`/`MetricsData` argument.
-Any approach that does not mutate the original `TraceData`/`MetricsData` argument 
+Any approach that does not mutate the original `TraceData`/`MetricsData` argument
 (including referenced data, such as `Node`, `Resource`, `Spans`, etc) is allowed.
-
-# <a name="trace-exporters"></a>Trace Exporters
-
-## <a name="jaeger"></a>Jaeger Exporter
-Exports trace data to [Jaeger](https://www.jaegertracing.io/) collectors. The following settings are required:
-
-- `endpoint` (no default): target to which the exporter is going to send Jaeger trace data,
-using the gRPC protocol. The valid syntax is described at
-https://github.com/grpc/grpc/blob/master/doc/naming.md
-
-The following settings can be optionally configured:
-
-- `cert_pem_file`: certificate file for TLS credentials of gRPC client. Should
-only be used if `insecure` is set to false.
-- `keepalive`: keepalive parameters for client gRPC. See
-[grpc.WithKeepaliveParams()](https://godoc.org/google.golang.org/grpc#WithKeepaliveParams).
-- `insecure`: whether to disable client transport security for the exporter's gRPC
-connection. See [grpc.WithInsecure()](https://godoc.org/google.golang.org/grpc#WithInsecure).
-- `server_name_override`: If set to a non empty string, it will override the virtual host name 
-of authority (e.g. :authority header field) in requests (typically used for testing).
-
-Example:
-
-```yaml
-exporters:
-  jaeger:
-    endpoint: jaeger-all-in-one:14250
-    cert_pem_file: /my-cert.pem
-    server_name_override: opentelemetry.io
-```
-
-The full list of settings exposed for this exporter are documented [here](jaegerexporter/config.go)
-with detailed sample configurations [here](jaegerexporter/testdata/config.yaml).
-
-## <a name="opencensus-traces"></a>OpenCensus Exporter
-Exports traces and/or metrics to another Collector via gRPC using OpenCensus format.
-
-The following settings are required:
-
-- `endpoint`: target to which the exporter is going to send traces or metrics,
-using the gRPC protocol. The valid syntax is described at
-https://github.com/grpc/grpc/blob/master/doc/naming.md.
-
-The following settings can be optionally configured:
-
-- `cert_pem_file`: certificate file for TLS credentials of gRPC client. Should
-only be used if `secure` is set to true.
-- `compression`: compression key for supported compression types within
-collector. Currently the only supported mode is `gzip`.
-- `headers`: the headers associated with gRPC requests.
-- `keepalive`: keepalive parameters for client gRPC. See
-[grpc.WithKeepaliveParams()](https://godoc.org/google.golang.org/grpc#WithKeepaliveParams).
-- `num_workers` (default = 2): number of workers that send the gRPC requests. Optional.
-- `reconnection_delay`: time period between each reconnection performed by the
-exporter.
-- `secure`: whether to enable client transport security for the exporter's gRPC
-connection. See [grpc.WithInsecure()](https://godoc.org/google.golang.org/grpc#WithInsecure).
-
-Example:
-
-```yaml
-exporters:
-  opencensus:
-    endpoint: localhost:14250
-    reconnection_delay: 60s
-    secure: false
-```
-
-The full list of settings exposed for this exporter are documented [here](opencensusexporter/config.go)
-with detailed sample configurations [here](opencensusexporter/testdata/config.yaml).
-
-## <a name="otlp-traces"></a>OTLP Exporter
-Exports traces and/or metrics to another Collector via gRPC using OTLP format.
-
-The following settings are required:
-
-- `endpoint`: target to which the exporter is going to send traces or metrics,
-using the gRPC protocol. The valid syntax is described at
-https://github.com/grpc/grpc/blob/master/doc/naming.md.
-
-The following settings can be optionally configured:
-
-- `cert_pem_file`: certificate file for TLS credentials of gRPC client. Should
-only be used if `secure` is set to true.
-- `compression`: compression key for supported compression types within
-collector. Currently the only supported mode is `gzip`.
-- `headers`: the headers associated with gRPC requests.
-- `keepalive`: keepalive parameters for client gRPC. See
-[grpc.WithKeepaliveParams()](https://godoc.org/google.golang.org/grpc#WithKeepaliveParams).
-- `num_workers` (default = 2): number of workers that send the gRPC requests. Optional.
-- `reconnection_delay`: time period between each reconnection performed by the
-exporter.
-- `secure`: whether to enable client transport security for the exporter's gRPC
-connection. See [grpc.WithInsecure()](https://godoc.org/google.golang.org/grpc#WithInsecure).
-
-Example:
-
-```yaml
-exporters:
-  otlp:
-    endpoint: localhost:14250
-    reconnection_delay: 60s
-    secure: false
-```
-
-The full list of settings exposed for this exporter are documented [here](otlpexporter/config.go)
-with detailed sample configurations [here](otlpexporter/testdata/config.yaml).
-
-## <a name="zipkin"></a>Zipkin Exporter
-Exports trace data to a [Zipkin](https://zipkin.io/) back-end.
-
-The following settings are required:
-
-- `format` (default = JSON): The format to sent events in. Can be set to JSON or proto.
-- `url` (no default): URL to which the exporter is going to send Zipkin trace data.
-
-The following settings can be optionally configured:
-
-- (temporary flag) `export_resource_labels` (default = true): Whether Resource labels are going to be merged with span attributes
-Note: this flag was added to aid the migration to new (fixed and symmetric) behavior and is going to be 
-removed soon. See https://github.com/open-telemetry/opentelemetry-collector/issues/595 for more details
-- `defaultservicename` (no default): What to name services missing this information
-
-Example:
-
-```yaml
-exporters:
-  zipkin:
-    url: "http://some.url:9411/api/v2/spans"
-```
-
-The full list of settings exposed for this exporter are documented [here](zipkinexporter/config.go)
-with detailed sample configurations [here](zipkinexporter/testdata/config.yaml).
-
-## <a name="opencensus-metrics"></a>OpenCensus Exporter
-The OpenCensus exporter supports both traces and metrics. Configuration
-information can be found under the trace section [here](#opencensus-traces).
-
-## <a name="prometheus"></a>Prometheus Exporter
-Exports metric data to a [Prometheus](https://prometheus.io/) back-end.
-
-The following settings are required:
-
-- `endpoint` (no default): Where to send metric data
-
-The following settings can be optionally configured:
-
-- `constlabels` (no default): key/values that are applied for every exported metric.
-- `namespace` (no default): if set, exports metrics under the provided value.
-
-Example:
-
-```yaml
-exporters:
-  prometheus:
-    endpoint: "1.2.3.4:1234"
-    namespace: test-space
-    const_labels:
-      label1: value1
-      "another label": spaced value
-```
-
-The full list of settings exposed for this exporter are documented [here](prometheusexporter/config.go)
-with detailed sample configurations [here](prometheusexporter/testdata/config.yaml).
-
-# <a name="local-exporters"></a>Local Exporters
-
-Local exporters send data to a local endpoint such as the console or a log file.
-
-## <a name="file"></a>File Exporter
-This exporter will write the pipeline data to a JSON file.
-The data is written in Protobuf JSON encoding
-(https://developers.google.com/protocol-buffers/docs/proto3#json).
-Note that there are no compatibility guarantees for this format, since it
-just a dump of internal structures which can be changed over time.
-This intended for primarily for debugging Collector without setting up backends.
-
-The following settings are required:
-
-- `path` (no default): where to write information.
-
-Example:
-
-```yaml
-exporters:
-  file:
-    path: ./filename.json
-```
-
-The full list of settings exposed for this exporter are documented [here](fileexporter/config.go)
-with detailed sample configurations [here](fileexporter/testdata/config.yaml).
-
-## <a name="logging"></a>Logging Exporter
-Exports traces and/or metrics to the console via zap.Logger. This includes generic information
-about the package (with `info` loglevel) or details of the trace (when `debug` is set)
-
-The following settings can be configured:
-
-- `loglevel`: the log level of the logging export (debug|info|warn|error). Default is `info`. When it is set to `debug`, 
-the trace related data (e.g. node, attributes, spans, metadata) are verbosely logged.
-- `sampling_initial`: number of messages initially logged each second. Default is 2. 
-- `sampling_thereafter`: sampling rate after the initial messages are logged (every Mth message 
-is logged). Default is 500.  Refer to [Zap docs](https://godoc.org/go.uber.org/zap/zapcore#NewSampler) for 
-more details on how sampling parameters impact number of messages.
-
-Example:
-
-```yaml
-exporters:
-  logging:
-    loglevel: info
-    sampling_initial: 5
-    sampling_thereafter: 200
-```
-
-The full list of settings exposed for this exporter are documented [here](loggingexporter/config.go)
-with detailed sample configurations [here](loggingexporter/testdata/config.yaml).

exporter/fileexporter/README.md

@@ -0,0 +1,23 @@
+# File Exporter
+
+This exporter will write the pipeline data to a JSON file.
+The data is written in Protobuf JSON encoding
+(https://developers.google.com/protocol-buffers/docs/proto3#json).
+Note that there are no compatibility guarantees for this format, since it
+just a dump of internal structures which can be changed over time.
+This intended for primarily for debugging Collector without setting up backends.
+
+The following settings are required:
+
+- `path` (no default): where to write information.
+
+Example:
+
+```yaml
+exporters:
+  file:
+    path: ./filename.json
+```
+
+The full list of settings exposed for this exporter are documented [here](./config.go)
+with detailed sample configurations [here](./testdata/config.yaml).

exporter/jaegerexporter/README.md

@@ -0,0 +1,31 @@
+# Jaeger Exporter
+
+Exports trace data to [Jaeger](https://www.jaegertracing.io/) collectors. The following settings are required:
+
+- `endpoint` (no default): target to which the exporter is going to send Jaeger trace data,
+using the gRPC protocol. The valid syntax is described at
+https://github.com/grpc/grpc/blob/master/doc/naming.md
+
+The following settings can be optionally configured:
+
+- `cert_pem_file`: certificate file for TLS credentials of gRPC client. Should
+only be used if `insecure` is set to false.
+- `keepalive`: keepalive parameters for client gRPC. See
+[grpc.WithKeepaliveParams()](https://godoc.org/google.golang.org/grpc#WithKeepaliveParams).
+- `insecure`: whether to disable client transport security for the exporter's gRPC
+connection. See [grpc.WithInsecure()](https://godoc.org/google.golang.org/grpc#WithInsecure).
+- `server_name_override`: If set to a non empty string, it will override the virtual host name 
+of authority (e.g. :authority header field) in requests (typically used for testing).
+
+Example:
+
+```yaml
+exporters:
+  jaeger:
+    endpoint: jaeger-all-in-one:14250
+    cert_pem_file: /my-cert.pem
+    server_name_override: opentelemetry.io
+```
+
+The full list of settings exposed for this exporter are documented [here](./config.go)
+with detailed sample configurations [here](./testdata/config.yaml).

exporter/loggingexporter/README.md

@@ -0,0 +1,26 @@
+# Logging Exporter
+
+Exports traces and/or metrics to the console via zap.Logger. This includes generic information
+about the package (with `info` loglevel) or details of the trace (when `debug` is set)
+
+The following settings can be configured:
+
+- `loglevel`: the log level of the logging export (debug|info|warn|error). Default is `info`. When it is set to `debug`, 
+the trace related data (e.g. node, attributes, spans, metadata) are verbosely logged.
+- `sampling_initial`: number of messages initially logged each second. Default is 2. 
+- `sampling_thereafter`: sampling rate after the initial messages are logged (every Mth message 
+is logged). Default is 500.  Refer to [Zap docs](https://godoc.org/go.uber.org/zap/zapcore#NewSampler) for 
+more details on how sampling parameters impact number of messages.
+
+Example:
+
+```yaml
+exporters:
+  logging:
+    loglevel: info
+    sampling_initial: 5
+    sampling_thereafter: 200
+```
+
+The full list of settings exposed for this exporter are documented [here](./config.go)
+with detailed sample configurations [here](./testdata/config.yaml).