Skip to main content
hitspec can export test execution metrics to external monitoring systems. This is especially useful for stress testing, where you want to track latency, error rates, and throughput over time.

​
Supported Formats

FormatFlagDescription
Prometheus--metrics prometheusExposes metrics on an HTTP endpoint
DataDog--metrics datadogSends metrics to DataDog API
JSON--metrics jsonWrites metrics to a file or stdout

​
Prometheus

Exposes metrics on an HTTP endpoint (default port 9090) for Prometheus to scrape. 
hitspec run api.http --stress -d 5m -r 100 \
  --metrics prometheus \
  --metrics-port 9090
Metrics are available at http://localhost:9090/metrics while the test runs.
FlagEnv VarDefaultDescription
--metrics-portHITSPEC_METRICS_PORT9090Port for the metrics endpoint

​
DataDog

Sends metrics directly to the DataDog API. 
hitspec run api.http --stress -d 5m -r 100 \
  --metrics datadog \
  --datadog-api-key "$DD_API_KEY"
FlagEnv VarDefaultDescription
--datadog-api-keyDD_API_KEYDataDog API key (required)
--datadog-siteDD_SITEdatadoghq.comDataDog site
--datadog-tagsDD_TAGSComma-separated tags
hitspec run api.http --stress -d 5m -r 100 \
  --metrics datadog \
  --datadog-api-key "$DD_API_KEY" \
  --datadog-site "datadoghq.eu" \
  --datadog-tags "env:staging,service:api"

​
JSON

Writes aggregate metrics to a file or stdout. 
# Write to file
hitspec run api.http --stress -d 1m -r 50 \
  --metrics json \
  --metrics-file metrics.json

# Write to stdout
hitspec run api.http --stress -d 1m -r 50 \
  --metrics json
FlagEnv VarDescription
--metrics-fileHITSPEC_METRICS_FILEOutput file (defaults to stdout)

​
Multiple Exporters

Export to multiple formats simultaneously: 
hitspec run api.http --stress -d 5m -r 100 \
  --metrics prometheus,json \
  --metrics-port 9090 \
  --metrics-file metrics.json

​
Exported Metrics

The metrics include:
MetricDescription
Total requestsNumber of requests sent
Success countNumber of successful responses
Failure countNumber of failed responses
Total durationOverall test duration
Min/Max/Avg latencyLatency statistics
P50/P95/P99 latencyPercentile latencies
Status codesBreakdown by HTTP status code
Per-test breakdownMetrics for each named request