Skip to content

Commit

Permalink
[chore] Fix dead links (open-telemetry#5730)
Browse files Browse the repository at this point in the history 
* Fix dead links

* updated docs/security.md links

* Update release.md

Co-authored-by: Bogdan Drutu <[email protected]>
  • Loading branch information
@TylerHelmuth
TylerHelmuth and Bogdan Drutu authored Jul 25, 2022
1 parent 3005b97 commit 5ab00fc
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion cmd/builder/RELEASE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ git tag -a v0.1.1 -m "Release v0.1.1"
git push upstream v0.1.1
```

A new GitHub workflow should be started, and at the end, a GitHub release should have been created, similar with the ["Release v0.1.0"](https://github.com/open-telemetry/opentelemetry-collector-builder/releases/tag/v0.1.0).
A new GitHub workflow should be started, and at the end, a GitHub release should have been created, similar with the ["Release v0.56.0"](https://github.com/open-telemetry/opentelemetry-collector/releases/tag/cmd%2Fbuilder%2Fv0.56.0).
4 changes: 2 additions & 2 deletions docs/security.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ vectors including resource exhaustion.
Component developers MUST default to encrypted connections (via the `insecure:
false` configuration setting) and SHOULD leverage
[receiver](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/receiverhelper)
[gRPC](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/configgrpc)
and
[exporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/exporterhelper)
[http](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp)
helper functions.

## Processors
Expand Down
32 changes: 16 additions & 16 deletions receiver/otlpreceiver/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,28 @@ Config defines configuration for OTLP receiver.

| Name | Type | Default | Docs |
|-----------|---------------------------------------------------|------------|-------------------------------------------------------------------------------------------------------|
| protocols | [otlpreceiver-Protocols](#otlpreceiver-Protocols) | <no value> | Protocols is the configuration for the supported protocols, currently gRPC and HTTP (Proto and JSON). |
| protocols | [otlpreceiver-Protocols](#otlpreceiver-protocols) | <no value> | Protocols is the configuration for the supported protocols, currently gRPC and HTTP (Proto and JSON). |

### otlpreceiver-Protocols

| Name | Type | Default | Docs |
|------|-----------------------------------------------------------------|------------|-----------------------------------------------------------------------------|
| grpc | [configgrpc-GRPCServerSettings](#configgrpc-GRPCServerSettings) | <no value> | GRPCServerSettings defines common settings for a gRPC server configuration. |
| http | [confighttp-HTTPServerSettings](#confighttp-HTTPServerSettings) | <no value> | HTTPServerSettings defines settings for creating an HTTP server. |
| grpc | [configgrpc-GRPCServerSettings](#configgrpc-grpcserversettings) | <no value> | GRPCServerSettings defines common settings for a gRPC server configuration. |
| http | [confighttp-HTTPServerSettings](#confighttp-httpserversettings) | <no value> | HTTPServerSettings defines settings for creating an HTTP server. |

### configgrpc-GRPCServerSettings

| Name | Type | Default | Docs |
|------------------------|-----------------------------------------------------------------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| endpoint | string | 0.0.0.0:4317 | Endpoint configures the address for this network connection. For TCP and UDP networks, the address has the form "host:port". The host must be a literal IP address, or a host name that can be resolved to IP addresses. The port must be a literal port number or a service name. If the host is a literal IPv6 address it must be enclosed in square brackets, as in "[2001:db8::1]:80" or "[fe80::1%zone]:80". The zone specifies the scope of the literal IPv6 address as defined in RFC 4007. |
| transport | string | tcp | Transport to use. Known protocols are "tcp", "tcp4" (IPv4-only), "tcp6" (IPv6-only), "udp", "udp4" (IPv4-only), "udp6" (IPv6-only), "ip", "ip4" (IPv4-only), "ip6" (IPv6-only), "unix", "unixgram" and "unixpacket". |
| tls | [configtls-TLSServerSetting](#configtls-TLSServerSetting) | <no value> | Configures the protocol to use TLS. The default value is nil, which will cause the protocol to not use TLS. |
| tls | [configtls-TLSServerSetting](#configtls-tlsserversetting) | <no value> | Configures the protocol to use TLS. The default value is nil, which will cause the protocol to not use TLS. |
| max_recv_msg_size_mib | uint64 | <no value> | MaxRecvMsgSizeMiB sets the maximum size (in MiB) of messages accepted by the server. |
| max_concurrent_streams | uint32 | <no value> | MaxConcurrentStreams sets the limit on the number of concurrent streams to each ServerTransport. It has effect only for streaming RPCs. |
| read_buffer_size | int | 524288 | ReadBufferSize for gRPC server. See grpc.ReadBufferSize (https://godoc.org/google.golang.org/grpc#ReadBufferSize). |
| write_buffer_size | int | <no value> | WriteBufferSize for gRPC server. See grpc.WriteBufferSize (https://godoc.org/google.golang.org/grpc#WriteBufferSize). |
| keepalive | [configgrpc-KeepaliveServerConfig](#configgrpc-KeepaliveServerConfig) | <no value> | Keepalive anchor for all the settings related to keepalive. |
| auth | [configauth-Authentication](#configauth-Authentication) | <no value> | Auth for this receiver |
| keepalive | [configgrpc-KeepaliveServerConfig](#configgrpc-keepaliveserverconfig) | <no value> | Keepalive anchor for all the settings related to keepalive. |
| auth | [configauth-Authentication](#configauth-authentication) | <no value> | Auth for this receiver |

### configtls-TLSServerSetting

Expand All @@ -43,24 +43,24 @@ Config defines configuration for OTLP receiver.

| Name | Type | Default | Docs |
|--------------------|---------------------------------------------------------------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| server_parameters | [configgrpc-KeepaliveServerParameters](#configgrpc-KeepaliveServerParameters) | <no value> | KeepaliveServerParameters allow configuration of the keepalive.ServerParameters. The same default values as keepalive.ServerParameters are applicable and get applied by the server. See https://godoc.org/google.golang.org/grpc/keepalive#ServerParameters for details. |
| enforcement_policy | [configgrpc-KeepaliveEnforcementPolicy](#configgrpc-KeepaliveEnforcementPolicy) | <no value> | KeepaliveEnforcementPolicy allow configuration of the keepalive.EnforcementPolicy. The same default values as keepalive.EnforcementPolicy are applicable and get applied by the server. See https://godoc.org/google.golang.org/grpc/keepalive#EnforcementPolicy for details. |
| server_parameters | [configgrpc-KeepaliveServerParameters](#configgrpc-keepaliveserverparameters) | <no value> | KeepaliveServerParameters allow configuration of the keepalive.ServerParameters. The same default values as keepalive.ServerParameters are applicable and get applied by the server. See https://godoc.org/google.golang.org/grpc/keepalive#ServerParameters for details. |
| enforcement_policy | [configgrpc-KeepaliveEnforcementPolicy](#configgrpc-keepaliveenforcementpolicy) | <no value> | KeepaliveEnforcementPolicy allow configuration of the keepalive.EnforcementPolicy. The same default values as keepalive.EnforcementPolicy are applicable and get applied by the server. See https://godoc.org/google.golang.org/grpc/keepalive#EnforcementPolicy for details. |

### configgrpc-KeepaliveServerParameters

| Name | Type | Default | Docs |
|--------------------------|---------------------------------|------------|------|
| max_connection_idle | [time-Duration](#time-Duration) | <no value> | |
| max_connection_age | [time-Duration](#time-Duration) | <no value> | |
| max_connection_age_grace | [time-Duration](#time-Duration) | <no value> | |
| time | [time-Duration](#time-Duration) | <no value> | |
| timeout | [time-Duration](#time-Duration) | <no value> | |
| max_connection_idle | [time-Duration](#time-duration) | <no value> | |
| max_connection_age | [time-Duration](#time-duration) | <no value> | |
| max_connection_age_grace | [time-Duration](#time-duration) | <no value> | |
| time | [time-Duration](#time-duration) | <no value> | |
| timeout | [time-Duration](#time-duration) | <no value> | |

### configgrpc-KeepaliveEnforcementPolicy

| Name | Type | Default | Docs |
|-----------------------|---------------------------------|------------|------|
| min_time | [time-Duration](#time-Duration) | <no value> | |
| min_time | [time-Duration](#time-duration) | <no value> | |
| permit_without_stream | bool | <no value> | |

### configauth-Authentication
Expand All @@ -74,8 +74,8 @@ Config defines configuration for OTLP receiver.
| Name | Type | Default | Docs |
|-----------------------|-----------------------------------------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| endpoint | string | 0.0.0.0:4318 | Endpoint configures the listening address for the server. |
| tls | [configtls-TLSServerSetting](#configtls-TLSServerSetting) | <no value> | TLSSetting struct exposes TLS client configuration. |
| cors | [confighttp-CORSSettings](#confighttp-CORSSettings) | <no value> | CORSSettings configures a receiver for HTTP cross-origin resource sharing (CORS). |
| tls | [configtls-TLSServerSetting](#configtls-tlsserversetting) | <no value> | TLSSetting struct exposes TLS client configuration. |
| cors | [confighttp-CORSSettings](#confighttp-corssettings) | <no value> | CORSSettings configures a receiver for HTTP cross-origin resource sharing (CORS). |
| max_request_body_size | int | 0 | MaxRequestBodySize configures the maximum allowed body size in bytes for a single request. The default `0` means there's no restriction |

### confighttp-CORSSettings
Expand Down

0 comments on commit 5ab00fc

Please sign in to comment.