Skip to content

Commit 5d6cc58

Browse files
docs: improve README instructions for metrics and tracing
1 parent 1bf7277 commit 5d6cc58

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

go/README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,27 @@ To build and run the Go Feature Server locally, create a feature_store.yaml file
66

77
```bash
88
go build -o feast-go ./go/main.go
9-
# start the http server
10-
./feast-go --type=http --port=8080
9+
# start the http server (metrics on port 9090 by default)
10+
./feast-go --type=http --port=8080 --metrics-port=9090
1111
# or start the gRPC server
12-
#./feast-go --type=grpc --port=[your-choice]
12+
#./feast-go --type=grpc --port=[your-choice] --metrics-port=9091
1313
```
14+
## Prometheus Metrics
15+
The server exposes Prometheus metrics at the `/metrics` endpoint on a dedicated port (default `:9090`).
16+
- **HTTP Mode**: Metrics server runs on port `9090` (configurable via `-metrics-port`).
17+
- **gRPC Mode**: Metrics server runs on port `9090` (configurable via `-metrics-port`).
18+
19+
Key metrics include:
20+
- `http_request_duration_seconds`: Histogram of response latency.
21+
- `http_requests_total`: Counter of HTTP requests by status, method, and path.
22+
- Standard Go and Process metrics.
23+
24+
A `/health` endpoint is available on the main application port (default `:8080`) for readiness probes.
25+
1426

1527
## OTEL based observability
1628
The OS level env variable `ENABLE_OTEL_TRACING=="true"/"false"` (string type) is used to enable/disable this service (with Tracing only).
29+
You can also configure the service name using `OTEL_SERVICE_NAME` env variable (defaults to "FeastGoFeatureServer").
1730

1831
The default exporter URL is "http://localhost:4318". The default schema of sending data to collector is **HTTP**. Please refer the following two docs about the configuration of the OTEL exporter:
1932
1. https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/

0 commit comments

Comments
 (0)