Skip to content

Commit

Permalink
Partial fix for collector config auth links
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin committed Feb 6, 2025
1 parent 8fca694 commit f966a51
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 23 deletions.
4 changes: 4 additions & 0 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,13 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^https://shorturl.at/osHRX$
# TODO move into content/en/blog/2023/contributing-to-otel/index.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
- ^https://shorturl.at/vLYZ0$
# Vendor-specific links
- ^https://qryn.metrico.in/#/support # SPA with query parameters, which htmltest omits from the cache, so we can't check it.

# Temporary until semconv is updated to 1.30.0+
- ^https://cloud.google.com/apis/design/resource_names#full_resource_name
- ^https://cloud.google.com/functions/docs/concepts/exec#function_scope_versus_global_scope
- ^https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902
- ^https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest
- ^https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES
- ^https://www.erlang.org/doc/man/erl_error.html#format_exception-3
27 changes: 12 additions & 15 deletions content/en/docs/collector/building/authenticator-extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,15 @@ room at the [CNCF Slack workspace](https://slack.cncf.io).

## Architecture

Authenticators are regular extensions that also satisfy one or more interfaces
related to the authentication mechanism:

- [go.opentelemetry.io/collector/config/configauth/ServerAuthenticator](https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#ServerAuthenticator)
- [go.opentelemetry.io/collector/config/configauth/GRPCClientAuthenticator](https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#GRPCClientAuthenticator)
- [go.opentelemetry.io/collector/config/configauth/HTTPClientAuthenticator](https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#HTTPClientAuthenticator)

Server authenticators are used with receivers, and are able to intercept HTTP
and gRPC requests, while client authenticators are used with exporters, able to
add authentication data to HTTP and gRPC requests. It is possible for
authenticators to implement both interfaces at the same time, allowing a single
instance of the extension to be used both for the incoming and outgoing
requests. Note that users might still want to have different authenticators for
the incoming and outgoing requests, so, don't make your authenticator required
to be used at both ends.
[Authenticators] are regular extensions that also satisfy one or more interfaces
related to the authentication mechanism. Server authenticators are used with
receivers, and are able to intercept HTTP and gRPC requests, while client
authenticators are used with exporters, able to add authentication data to HTTP
and gRPC requests. It is possible for authenticators to implement both
interfaces at the same time, allowing a single instance of the extension to be
used both for the incoming and outgoing requests. Note that users might still
want to have different authenticators for the incoming and outgoing requests,
so, don't make your authenticator required to be used at both ends.

Once an authenticator extension is available in the collector distribution, it
can be referenced in the configuration file as a regular extension:
Expand Down Expand Up @@ -170,3 +164,6 @@ as part of their own distributions. Fortunately, building a custom distribution
can be done using the
[OpenTelemetry Collector Builder](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder)
utility.

[Authenticators]:
https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth
12 changes: 4 additions & 8 deletions static/refcache.json
Original file line number Diff line number Diff line change
Expand Up @@ -15095,10 +15095,6 @@
"StatusCode": 200,
"LastSeen": "2025-02-06T02:27:59.999Z"
},
"https://pkg.go.dev/go.opentelemetry.io/collector/config/configauth#ServerAuthenticator": {
"StatusCode": 200,
"LastSeen": "2025-02-06T02:27:59.999Z"
},
"https://pkg.go.dev/go.opentelemetry.io/collector/confmap/provider/envprovider": {
"StatusCode": 200,
"LastSeen": "2024-11-19T13:34:41.905691-05:00"
Expand Down Expand Up @@ -15491,6 +15487,10 @@
"StatusCode": 200,
"LastSeen": "2025-02-06T02:29:12.345Z"
},
"https://prometheus.io/docs/prometheus/2.55/feature_flags/#otlp-receiver": {
"StatusCode": 200,
"LastSeen": "2025-02-06T14:42:12.345Z"
},
"https://prometheus.io/docs/prometheus/latest/configuration/configuration/": {
"StatusCode": 206,
"LastSeen": "2024-08-09T10:46:59.171526-04:00"
Expand Down Expand Up @@ -15559,10 +15559,6 @@
"StatusCode": 200,
"LastSeen": "2025-02-01T07:09:55.714191-05:00"
},
"https://qryn.metrico.in/#/support": {
"StatusCode": 206,
"LastSeen": "2025-02-06T02:29:59.999Z"
},
"https://quarkus.io": {
"StatusCode": 206,
"LastSeen": "2025-01-06T11:32:14.820507-05:00"
Expand Down

0 comments on commit f966a51

Please sign in to comment.