docs: add troubleshooting step for clickhouse and aquasec - #628
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a troubleshooting section to the LangSmith self-hosted documentation to help users resolve ClickHouse startup issues when running in environments with AquaSec security software.
- Adds a new troubleshooting section for ClickHouse and AquaSec compatibility issues
- Provides configuration solutions for both Kubernetes and Docker environments
- Documents the use of
AQUA_SKIP_LD_PRELOADenvironment variable to bypass AquaSec interference
|
Preview ID generated: preview-infraa-1758641348-47d5dbf |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| docker compose up | ||
| ``` | ||
|
|
||
| ### *ClickHouse Fails to Startup when running a Cluster with AquaSec* |
There was a problem hiding this comment.
The heading uses inconsistent formatting with asterisks around the title. Remove the asterisks to match the standard heading format used elsewhere in the documentation.
| ### *ClickHouse Fails to Startup when running a Cluster with AquaSec* | |
| ### ClickHouse Fails to Startup when running a Cluster with AquaSec |
| ``` | ||
|
|
||
| #### Docker | ||
| 1. Edit your `docker-compose.yaml` and set the `AQUA_SKIP_LD_PRELOAD` environment variable. This might look something like this: |
There was a problem hiding this comment.
Missing space after the numbered list marker. Should be '1. Edit' with proper spacing for consistency with the Kubernetes section above.
|
Preview ID generated: preview-infraa-1758642275-05c410c |
Kathryn May (katmayb)
left a comment
Kathryn May (katmayb)
left a comment
There was a problem hiding this comment.
Made a few suggestions, but looks good!
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
| ### *ClickHouse fails to start up when running a cluster with AquaSec* | ||
|
|
||
| In some environments, AquaSec may prevent ClickHouse from starting up correctly. This may manifest as the ClickHouse pod not emitting any logs and failing to get marked as ready. | ||
| Generally this is due to `LD_PRELOAD` being set by AquaSec, which interferes with ClickHouse. To resolve this, you can add the following environment variable to your ClickHouse deployment: |
There was a problem hiding this comment.
[nitpick] The explanation could be clearer about what AquaSec is and why this conflict occurs. Consider adding a brief explanation that AquaSec is a security platform that uses LD_PRELOAD to inject security monitoring, which conflicts with ClickHouse's startup process.
| Generally this is due to `LD_PRELOAD` being set by AquaSec, which interferes with ClickHouse. To resolve this, you can add the following environment variable to your ClickHouse deployment: | |
| This issue is generally caused by AquaSec, a security platform that uses the `LD_PRELOAD` environment variable to inject security monitoring libraries into running processes. ClickHouse's startup process is incompatible with this kind of dynamic library injection, which can prevent it from starting correctly. To resolve this, you can add the following environment variable to your ClickHouse deployment: |
|
Preview ID generated: preview-infraa-1758642841-8609d75 |
Overview
Update langsmith self hosted documentation with a troubleshooting guide when running in environments with AquaSec.
Type of change
Type: [Replace with: New documentation page / Update existing documentation / Fix typo/bug/link/formatting / Remove outdated content / Other]
Related issues/PRs
Checklist
docs devsrc/docs.jsonif neededAdditional notes