[env variable] Pluggable component env variables #3554
Conversation
Signed-off-by: Hannah Hunter <[email protected]>
|
I said there were other env var. Need to determine if there are any! |
checking on this! |
| | OTEL_EXPORTER_OTLP_PROTOCOL | OpenTelemetry Tracing | The OTLP protocol to use Transport protocol. (`grpc`, `http/protobuf`, `http/json`) | | ||
| | DAPR_COMPONENTS_SOCKET_FOLDER | Pluggable component | The location for the `.sock` file for the shared directory location socket | |
There was a problem hiding this comment.
DAPR_COMPONENTS_SOCKET_FOLDER is apparently an older environment variable that's been replaced by DAPR_COMPONENTS_SOCKETS_FOLDER.
This new environment variable is used by the Dapr runtime as well as the .NET, Go, & Java pluggable components SDKs.
The .NET and Java SDKs also support DAPR_COMPONENTS_SOCKETS_EXTENSION environment variable, which indicates the default file extension applied to socket files created by the SDKs. This value defaults to .sock for .NET and sock for Java.
There was a problem hiding this comment.
The .NET and Java SDKs also support
DAPR_COMPONENTS_SOCKETS_EXTENSIONenvironment variable,
I don't know if would make sense to add those to the main Dapr docs. I guess mentioning them with the caveat it is a per-SDK configuration and not a Dapr enforced behaviour.
Aside this, I don't really recall any other env. var. besides DAPR_COMPONENTS_SOCKETS_FOLDER (notice the socketS vs socket diff).
There was a problem hiding this comment.
We could be a bit more verbose on this explanation, as in:
| | DAPR_COMPONENTS_SOCKET_FOLDER | Pluggable component | The location for the `.sock` file for the shared directory location socket | | |
| | DAPR_COMPONENTS_SOCKET_FOLDER | Pluggable component | The location or path where Dapr will look for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` | |
Notice that we don't mention the .sock extension: the code in dapr/dapr doesn't really care about it, it tests all files that that location for their kind (socket or regular), regardless of their extension. Even for SDKs, adding those extensions to the UDS they create is more decorative than functional.
The proposed text neither puts a limit to the number of such files that might exist (vs singular "the sock file")
Signed-off-by: Hannah Hunter <[email protected]>
Signed-off-by: Hannah Hunter <[email protected]>
|
@philliphoff @tmacam thanks for your review! |
Description
Add env variables for the pluggable component
Need to confirm what others to add - @philliphoff @tmacam
Issue reference
PR will close: #3239