Merge pull request #450 from weaviate/docs/debug-endpoints-disabled-by-default

Document DEBUG_ENDPOINTS_ENABLED (debug endpoints disabled by default in v1.37.9)

Author: g-despot

docs/deploy/configuration/env-vars/index.md

@@ -57,6 +57,7 @@ import APITable from '@site/src/components/APITable';
 | `INVERTED_SORTER_DISABLED` | Forces the "objects bucket" strategy and doesn't consider inverted sorting. Most users should never set this flag; it exists for benchmarking and as a safety net. Default: `false` | `boolean` | `false` |
 | `GO_PROFILING_DISABLE` | If `true`, disables Go profiling. Default: `false`. | `boolean` | `false` |
 | `GO_PROFILING_PORT` | Sets the port for the Go profiler. Default: `6060` | `integer` | `6060` |
+| `DEBUG_ENDPOINTS_ENABLED` | Gate for the debug HTTP listener (the profiling port set by `GO_PROFILING_PORT`, default `6060`), which serves Weaviate's **unauthenticated** internal debug and profiling endpoints — `/debug/config`, Go profiling (`/debug/pprof/*`, `/debug/fgprof`), and various maintenance and diagnostic routes. [Runtime-configurable](/deploy/configuration/env-vars/runtime-config.md) via the `debug_endpoints_enabled` override. Default: `false`. `GO_PROFILING_DISABLE` still controls whether the listener binds at all. <br/>Added in `v1.37.9` | `boolean` | `true` |
 | `GRPC_MAX_MESSAGE_SIZE` | Maximum gRPC message size in bytes. Default: 10MB | `string - number` | `2000000000` |
 | `GRPC_PORT` | The port on which Weaviate's gRPC server listens for incoming requests. Default: `50051` | `string - number` | `50052` |
 | `HNSW_GEO_INDEX_EF` | Balance geo index search speed and recall. This value controls the search depth for geo-based queries. Default: `800`<br/>Added in `v1.31.22` | `string - number` | `1000` |

docs/deploy/configuration/env-vars/runtime-config.md

@@ -61,6 +61,7 @@ The following overrides are currently supported:
 | `async_replication_hashtree_init_concurrency`    | `ASYNC_REPLICATION_HASHTREE_INIT_CONCURRENCY`|
 | `async_replication_cluster_max_workers` _(removed in `v1.38`)_ | `ASYNC_REPLICATION_CLUSTER_MAX_WORKERS` _(removed in `v1.38`)_ |
 | `autoschema_enabled`                             | `AUTOSCHEMA_ENABLED`                         |
+| `debug_endpoints_enabled`                        | `DEBUG_ENDPOINTS_ENABLED`                    |
 | `default_quantization`                           | `DEFAULT_QUANTIZATION`                       |
 | `default_sharding_count`                         | `DEFAULT_SHARDING_COUNT`                     |
 | `default_vector_index`                           | `DEFAULT_VECTOR_INDEX`                       |

docs/weaviate/best-practices/index.md

@@ -168,6 +168,10 @@ If `go` is available to your system, you can view the heap profile with golang's
 - Have a go runtime installed, or start a Go-based docker container
 - Expose port 6060 if running in docker/k8s
 
+:::caution `DEBUG_ENDPOINTS_ENABLED` required in `v1.37.9`+
+As of `v1.37.9`, the debug HTTP listener (including the `/debug/pprof/*` endpoints) is disabled by default. Set [`DEBUG_ENDPOINTS_ENABLED=true`](/deploy/configuration/env-vars/index.md) to serve these endpoints before profiling.
+:::
+
 To view the profile visually:
 
 ```bash