Skip to content

Commit 27c3e81

Browse files
committed
Link to new collector config auth headings
1 parent f771abd commit 27c3e81

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

content/en/docs/collector/building/authenticator-extension.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ room at the [CNCF Slack workspace](https://slack.cncf.io).
3030
## Architecture
3131

3232
[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
3434
receivers, and are able to intercept HTTP and gRPC requests, while client
3535
authenticators are used with exporters, able to add authentication data to HTTP
3636
and gRPC requests. It is possible for authenticators to implement both
@@ -123,7 +123,7 @@ service:
123123

124124
### Server authenticators
125125

126-
A server authenticator is essentially an extension with an `Authenticate`
126+
A [server authenticator][sa] is essentially an extension with an `Authenticate`
127127
function, receiving the payload headers as parameter. If the authenticator is
128128
able to authenticate the incoming connection, it should return a `nil` error, or
129129
the concrete error if it can't. As an extension, the authenticator should make
@@ -141,11 +141,8 @@ debug specific failures.
141141

142142
### Client authenticators
143143

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].
149146

150147
Similar to server authenticators, they are essentially extensions with extra
151148
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.
161158
When building your own authenticator, you'll likely have to build a custom
162159
distribution as well, or provide means for your users to consume your extension
163160
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.
167162

168-
[Authenticators]:
163+
[authenticators]:
169164
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

static/refcache.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -15087,13 +15087,13 @@
1508715087
"StatusCode": 200,
1508815088
"LastSeen": "2025-01-06T11:32:23.675071-05:00"
1508915089
},
15090-
"https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#GRPCClientAuthenticator": {
15090+
"https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#client-authenticators": {
1509115091
"StatusCode": 200,
15092-
"LastSeen": "2025-02-06T02:27:59.999Z"
15092+
"LastSeen": "2025-02-06T22:27:59.999Z"
1509315093
},
15094-
"https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#HTTPClientAuthenticator": {
15094+
"https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#server-authenticators": {
1509515095
"StatusCode": 200,
15096-
"LastSeen": "2025-02-06T02:27:59.999Z"
15096+
"LastSeen": "2025-02-06T22:27:59.999Z"
1509715097
},
1509815098
"https://pkg.go.dev/go.opentelemetry.io/collector/confmap/provider/envprovider": {
1509915099
"StatusCode": 200,

0 commit comments

Comments
 (0)