diff --git a/cmd/builder/RELEASE.md b/cmd/builder/RELEASE.md index b0552500521..0ad589607e0 100644 --- a/cmd/builder/RELEASE.md +++ b/cmd/builder/RELEASE.md @@ -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). \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/security.md b/docs/security.md index f2014b84453..b1f68be03ab 100644 --- a/docs/security.md +++ b/docs/security.md @@ -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 diff --git a/receiver/otlpreceiver/config.md b/receiver/otlpreceiver/config.md index cd8867471e3..3f5ac4b9e1c 100644 --- a/receiver/otlpreceiver/config.md +++ b/receiver/otlpreceiver/config.md @@ -7,14 +7,14 @@ Config defines configuration for OTLP receiver. | Name | Type | Default | Docs | |-----------|---------------------------------------------------|------------|-------------------------------------------------------------------------------------------------------| -| protocols | [otlpreceiver-Protocols](#otlpreceiver-Protocols) | | Protocols is the configuration for the supported protocols, currently gRPC and HTTP (Proto and JSON). | +| protocols | [otlpreceiver-Protocols](#otlpreceiver-protocols) | | 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) | | GRPCServerSettings defines common settings for a gRPC server configuration. | -| http | [confighttp-HTTPServerSettings](#confighttp-HTTPServerSettings) | | HTTPServerSettings defines settings for creating an HTTP server. | +| grpc | [configgrpc-GRPCServerSettings](#configgrpc-grpcserversettings) | | GRPCServerSettings defines common settings for a gRPC server configuration. | +| http | [confighttp-HTTPServerSettings](#confighttp-httpserversettings) | | HTTPServerSettings defines settings for creating an HTTP server. | ### configgrpc-GRPCServerSettings @@ -22,13 +22,13 @@ Config defines configuration for OTLP receiver. |------------------------|-----------------------------------------------------------------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 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) | | 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) | | 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 | | MaxRecvMsgSizeMiB sets the maximum size (in MiB) of messages accepted by the server. | | max_concurrent_streams | uint32 | | 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 | | WriteBufferSize for gRPC server. See grpc.WriteBufferSize (https://godoc.org/google.golang.org/grpc#WriteBufferSize). | -| keepalive | [configgrpc-KeepaliveServerConfig](#configgrpc-KeepaliveServerConfig) | | Keepalive anchor for all the settings related to keepalive. | -| auth | [configauth-Authentication](#configauth-Authentication) | | Auth for this receiver | +| keepalive | [configgrpc-KeepaliveServerConfig](#configgrpc-keepaliveserverconfig) | | Keepalive anchor for all the settings related to keepalive. | +| auth | [configauth-Authentication](#configauth-authentication) | | Auth for this receiver | ### configtls-TLSServerSetting @@ -43,24 +43,24 @@ Config defines configuration for OTLP receiver. | Name | Type | Default | Docs | |--------------------|---------------------------------------------------------------------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| server_parameters | [configgrpc-KeepaliveServerParameters](#configgrpc-KeepaliveServerParameters) | | 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) | | 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) | | 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) | | 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) | | | -| max_connection_age | [time-Duration](#time-Duration) | | | -| max_connection_age_grace | [time-Duration](#time-Duration) | | | -| time | [time-Duration](#time-Duration) | | | -| timeout | [time-Duration](#time-Duration) | | | +| max_connection_idle | [time-Duration](#time-duration) | | | +| max_connection_age | [time-Duration](#time-duration) | | | +| max_connection_age_grace | [time-Duration](#time-duration) | | | +| time | [time-Duration](#time-duration) | | | +| timeout | [time-Duration](#time-duration) | | | ### configgrpc-KeepaliveEnforcementPolicy | Name | Type | Default | Docs | |-----------------------|---------------------------------|------------|------| -| min_time | [time-Duration](#time-Duration) | | | +| min_time | [time-Duration](#time-duration) | | | | permit_without_stream | bool | | | ### configauth-Authentication @@ -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) | | TLSSetting struct exposes TLS client configuration. | -| cors | [confighttp-CORSSettings](#confighttp-CORSSettings) | | CORSSettings configures a receiver for HTTP cross-origin resource sharing (CORS). | +| tls | [configtls-TLSServerSetting](#configtls-tlsserversetting) | | TLSSetting struct exposes TLS client configuration. | +| cors | [confighttp-CORSSettings](#confighttp-corssettings) | | 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