diff --git a/DEBUGGING.md b/DEBUGGING.md new file mode 100644 index 000000000..25c8f349d --- /dev/null +++ b/DEBUGGING.md @@ -0,0 +1,35 @@ +Debugging virtual-kubelet +========================= + +## Metrics + +Not implemented. + +## Tracing + +virtual-kubelet uses [OpenCensus](https://www.opencensus.io) to record traces. These traces include requests on the HTTP API as well as the reconciliation loop which reconciles virtual-kubelet pods with what's in the Kubernetes API server. + +The granularity of traces may depend on the provider being used. + +### Tracing Exporters + +Traces are collected and then exportered to any configured exporter. Built-in exporters currently include: + +- `jaeger` - [Jaeger Tracing](https://www.jaegertracing.io), supports configuration through environment variables. + - `JAEGER_ENDPOINT` - Jaeger HTTP Thrift endpoint, e.g. `http://localhost:14268` + - `JAGER_AGENT_ENDPOINT` - Jaeger agent address, e.g. `localhost:6831` + - `JAEGER_USER` + - `JAEGER_PASSWORD` +- `zpages` - [OpenCensus Zpages](https://opencensus.io/core-concepts/z-pages/). Currently supports configuration through environment variables, but this interface is **not** considered stable. + - ZPAGES_PORT - e.g. `localhost:8080` sets the address to setup the HTTP server to serve zpages on. Will be available at `http://
: