Send health data
StackState Self-hosted v4.5.x

Overview

StackState can synchronize health information from your own data sources either via HTTP or the StackState CLI.

StackState Receiver API

The StackState Receiver API accepts topology, telemetry and health data in a common JSON object. By default, the receiver API is hosted at:
Kubernetes
Linux
1
https://<baseUrl>/receiver/stsAgent/intake?api_key=<API_KEY>
Copied!
Both the baseUrl and API_KEY are set during StackState installation, for details see Kubernetes install - configuration parameters.
1
https://<baseUrl>:<receiverPort>/stsAgent/intake?api_key=<API_KEY>
Copied!
Both the baseUrl and API_KEY are set during StackState installation, for details see Linux install - configuration parameters.

Common JSON object

Topology, telemetry and health data are sent to the receiver API via HTTP POST. There is a common JSON object used for all messages.
1
{
2
"collection_timestamp": 1548855554, // the epoch timestamp for the collection
3
"events": {}, // used to send events data
4
"internalHostname": "localdocker.test", // the host that is sending this data
5
"metrics": [], // used to send metrics data
6
"service_checks": [],
7
"topologies": [], // used to send topology data
8
"health" // used for sending health data
9
}
Copied!
StackState accepts health data based on a chosen consistency model. The message that can be sent for each model are described on the pages below:

See also

Last modified 20d ago