Skip to content

Commit a4ebdf6

Browse files
authored
Add 'Building' section to collector docs (#3680)
1 parent 1e5aa04 commit a4ebdf6

File tree

6 files changed

+29
-15
lines changed

6 files changed

+29
-15
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Building custom components
3+
description: Instructions on how to build your own collector components
4+
weight: 90
5+
---
6+
7+
The OpenTelemetry Collector can not only be extended by existing components, but
8+
also by custom components, that you develop and build on your own. Here you will
9+
find instructions on how to build some of those components. For additional
10+
details take a look into the documents contained within the
11+
[opentelemetry-collector-contrib repository](http://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/README.md).

content/en/docs/collector/custom-auth.md renamed to content/en/docs/collector/building/authenticator-extension.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: Building a custom authenticator
3-
weight: 30
2+
title: Building an authenticator extension
3+
weight: 40
4+
aliases: [/docs/collector/custom-auth/]
45
cSpell:ignore: configauth oidc
56
---
67

content/en/docs/collector/build-connector.md renamed to content/en/docs/collector/building/connector.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
title: Building a Connector
3+
aliases: [/docs/collector/build-connector/]
4+
weight: 30
35
# prettier-ignore
46
cSpell:ignore: batchprocessor debugexporter Errorf exampleconnector gomod gord Jaglowski loggingexporter mapstructure mapstructure otlpreceiver pdata pmetric ptrace servicegraph spanmetrics struct uber
57
---
@@ -51,11 +53,11 @@ following links:
5153

5254
### The Old Architecture:
5355

54-
![Before picture of how processors emitted data directly to another pipelines exporter](../img/otel-collector-before-connector.png)
56+
![Before picture of how processors emitted data directly to another pipelines exporter](../../img/otel-collector-before-connector.png)
5557

5658
### New Architecture Using a Connector:
5759

58-
![How the pipeline should work using the connector component](../img/otel-collector-after-connector.png)
60+
![How the pipeline should work using the connector component](../../img/otel-collector-after-connector.png)
5961

6062
## Building Example Connector
6163

content/en/docs/collector/trace-receiver.md renamed to content/en/docs/collector/building/receiver.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: Building a Trace Receiver
3-
weight: 98
2+
title: Building a receiver
3+
weight: 20
4+
aliases: [/docs/collector/trace-receiver/]
45
# prettier-ignore
56
cSpell:ignore: amzn atmxph backendsystem batchprocessor chicago comcast crand debugexporter devs Errorf gogl Intn ispnetwork loggingexporter loglevel mapstructure mcrsft otelcontribcol otlpexporter otlpreceiver pcommon pdata protogen ptrace Rcvr rquedas sanfrancisco serialnumber slrs stateid struct structs Subchannel tailtracer uber wndws zapgrpc
67
---

content/en/docs/collector/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -698,15 +698,15 @@ Each authentication extension has two possible usages:
698698
For a list of known authenticators, see the
699699
[Registry](/ecosystem/registry/?s=authenticator&component=extension). If you're
700700
interested in developing a custom authenticator, see
701-
[Building a custom authenticator](../custom-auth).
701+
[Building an authenticator extension](../building/authenticator-extension).
702702

703703
To add a server authenticator to a receiver in the Collector, follow these
704704
steps:
705705

706706
1. Add the authenticator extension and its configuration under `.extensions`.
707-
1. Add a reference to the authenticator to `.services.extensions`, so that it's
707+
2. Add a reference to the authenticator to `.services.extensions`, so that it's
708708
loaded by the Collector.
709-
1. Add a reference to the authenticator under
709+
3. Add a reference to the authenticator under
710710
`.receivers.<your-receiver>.<http-or-grpc-config>.auth`.
711711

712712
The following example uses the OIDC authenticator on the receiver side, making

content/en/docs/collector/distributions.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,8 @@ the `manifest.yaml` of each distribution.
1919
For various reasons the existing distributions provided by the OpenTelemetry
2020
project may not meet your needs. Whether you want a smaller version, or have the
2121
need to implement custom functionality like
22-
[custom authenticators](../custom-auth), receivers, processors, or exporters.
23-
The tool used to build distributions [ocb][] (OpenTelemetry Collector Builder)
24-
is available to build your own distributions.
25-
26-
[ocb]:
27-
http://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder
22+
[authenticator extensions](../building/authenticator-extension),
23+
[receivers](../building/receiver), processors, exporters or
24+
[connectors](../building/connector). The tool used to build distributions
25+
[ocb](../custom-collector) (OpenTelemetry Collector Builder) is available to
26+
build your own distributions.

0 commit comments

Comments
 (0)