Get stream metrics
Return live consumer metrics for a running stream. Requires the stream to currently be running. Every stream type reports these three SML metrics: | Key | Meaning | |---|---| | `sml.tuples.num` | Records consumed so far | | `sml.tuples.rpms` | Throughput, records per millisecond | | `sml.stream.on` | `"true"` while the consumer task is active | **Kafka streams additionally return the entire underlying Kafka consumer metric set** — roughly 165 extra entries whose keys are the `toString()` of Kafka's own `MetricName` (e.g. `MetricName [name=bytes-consumed-total, group=consumer-fetch-manager-metrics, description=..., tags={client-id=...}]`). These are passed through verbatim from the Kafka client and are not part of SymetryML's contract; treat only the three `sml.*` keys as stable. NATS streams return the three `sml.*` keys alone.
Return live consumer metrics for a running stream. Requires the stream to currently be running.
Every stream type reports these three SML metrics:
| Key | Meaning |
|---|---|
sml.tuples.num | Records consumed so far |
sml.tuples.rpms | Throughput, records per millisecond |
sml.stream.on | "true" while the consumer task is active |
Kafka streams additionally return the entire underlying Kafka consumer
metric set — roughly 165 extra entries whose keys are the toString()
of Kafka's own MetricName (e.g.
MetricName [name=bytes-consumed-total, group=consumer-fetch-manager-metrics, description=..., tags={client-id=...}]).
These are passed through verbatim from the Kafka client and are not part
of SymetryML's contract; treat only the three sml.* keys as stable.
NATS streams return the three sml.* keys alone.
Authorization
SymetryMLAuth HMAC-SHA256 signature-based authentication: requests are signed with
your secret key and sent with the Customer-ID, Sym-date,
Authorization, Content-MD5 and sym-version headers.
See SymetryML REST API Security
for the signature algorithm and a complete example.
In: header
Path Parameters
User/Customer identifier
Project identifier
Data source name
Response Body
application/json
application/json
curl -X GET "https://example.com/c1/projects/nbra_prj_iris/streams/nbra_ds_sftp_iris/metrics"{ "statusCode": 200, "statusString": "OK", "values": { "KSVSMap": { "values": [ { "sml.tuples.num": "10000", "sml.tuples.rpms": "0.49940071913703554", "sml.stream.on": "true" } ] } }}{ "statusCode": 500, "statusString": "Generic Exception [java.lang.Exception: Stream [nosuchstream] is not running existing:kafka_stream_0::c1==prj0]", "values": {}}Get stream error log GET
Return the accumulated list of error messages logged by a running stream's consumer task. Requires the stream to currently be running — a stopped or never-started stream returns a `500`, not an empty log.
Start stream GET
Resume the background consumer task for a `kafka`/`nats` Data Source that was previously stopped (via [Stop stream](/docs/api-reference/streams/projects-project-streams-dsname-stop-get)) or never started, without recreating the Data Source itself.