Event Data Formats
The data formats to use when sending data to Stroom.
Stroom and Stroom Proxy have a simple HTTP POST interface that requires HTTP header arguments to be supplied as described here.
Files are posted to Stroom and Stroom Proxy as described here.
Stroom will return a response code indicating the success or failure status of the post as described here
Data can be sent from any operating systems or applications. Some examples to aid in sending data can be found here
Unless Stroom or Stroom-Proxy has been configured to receive data without it, the client must also authenticate. There are four ways to do so, and which are available depends on how the receiving system has been configured. The first three identify a Stroom user or an identity at the Identity Provider (IDP) Identity Provider (IDP) An Identity Provider is a system or service that can authenticate a user and assert their identity. Identity providers can support single sign on (SSO), which allows the user to sign in once to the Identity Provider so they are then authenticated to all systems using that IDP.Click to see more details...; the fourth is specific to data receipt and also sets meta data on the data it receives.
| Credential | How it is sent | See |
|---|---|---|
| A client certificate | The TLS handshake | SSL Configuration |
| An API Key API Key API Keys are a form of authentication token that are created within Stroom for use by Stroom-Proxy instances or other clients that want to use Stroom’s API. It is an encrypted string that contains details of the user and the expiration date of the token. Possession of a valid API Key for a user account means that you can do anything that the user can do in the user interface via the API.Click to see more details... created in Stroom | Authorization: Bearer ... |
API Key Authentication |
| An Identity Provider (IDP) Identity Provider (IDP) An Identity Provider is a system or service that can authenticate a user and assert their identity. Identity providers can support single sign on (SSO), which allows the user to sign in once to the Identity Provider so they are then authenticated to all systems using that IDP.Click to see more details... token | Authorization: Bearer ... |
Token Authentication |
| A Data Feed Identity | Authorization: Bearer ... for a Data Feed Key, or the TLS handshake for a Certificate Identity |
Data Feed Identities |
It is common practice for the developers/admins of a client system to write the translation to normalise their data as they’re in the best position to understand their logging and to generate specific events as required. See here for further details.
The data formats to use when sending data to Stroom.
The various HTTP headers that can be sent with data.
The HTTP response codes returned by stroom.
Description of the format of the payloads when sending event (and optionally context data) data to stroom.
Configuring SSL with cURL.
How to send data using an API Key created in Stroom.
A collection of example client applications for sending data to Stroom or one of its proxies.
How to send data using token based authentication.
How to create java key/trust stores for use with Java client applications.