@@ -30,7 +30,7 @@ room at the [CNCF Slack workspace](https://slack.cncf.io).
30
30
## Architecture
31
31
32
32
[ Authenticators] are regular extensions that also satisfy one or more interfaces
33
- related to the authentication mechanism. Server authenticators are used with
33
+ related to the authentication mechanism. [ Server authenticators] are used with
34
34
receivers, and are able to intercept HTTP and gRPC requests, while client
35
35
authenticators are used with exporters, able to add authentication data to HTTP
36
36
and gRPC requests. It is possible for authenticators to implement both
@@ -123,7 +123,7 @@ service:
123
123
124
124
# ## Server authenticators
125
125
126
- A server authenticator is essentially an extension with an `Authenticate`
126
+ A [ server authenticator][sa] is essentially an extension with an `Authenticate`
127
127
function, receiving the payload headers as parameter. If the authenticator is
128
128
able to authenticate the incoming connection, it should return a `nil` error, or
129
129
the concrete error if it can't. As an extension, the authenticator should make
@@ -141,11 +141,8 @@ debug specific failures.
141
141
142
142
# ## Client authenticators
143
143
144
- A client authenticator is one that implements one or more of the following
145
- interfaces :
146
-
147
- - [go.opentelemetry.io/collector/config/configauth/GRPCClientAuthenticator](https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#GRPCClientAuthenticator)
148
- - [go.opentelemetry.io/collector/config/configauth/HTTPClientAuthenticator](https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#HTTPClientAuthenticator)
144
+ A _client authenticator_ is one that implements one or more of the interfaces
145
+ defined in [Client authenticators].
149
146
150
147
Similar to server authenticators, they are essentially extensions with extra
151
148
functions, each receiving an object that gives the authenticator an opportunity
@@ -161,9 +158,13 @@ Custom authenticators have to be part of the same binary as the main collector.
161
158
When building your own authenticator, you'll likely have to build a custom
162
159
distribution as well, or provide means for your users to consume your extension
163
160
as part of their own distributions. Fortunately, building a custom distribution
164
- can be done using the
165
- [OpenTelemetry Collector Builder](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder)
166
- utility.
161
+ can be done using the [OpenTelemetry Collector Builder][builder] utility.
167
162
168
- [Authenticators ] :
163
+ [authenticators ] :
169
164
https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth
165
+ [builder] :
166
+ https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder
167
+ [client authenticators] :
168
+ https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#client-authenticators
169
+ [sa] :
170
+ https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#server-authenticators
0 commit comments