Monitoring and Alerting
Logs, Metrics, and Traces to debug your internal tools
Superblocks sends Logs, Metrics, and Traces to your preferred observability platform so you can easily monitor your internal tools.
For example, in Datadog, visualize the execution of Workflows or Scheduled Jobs broken out by integration and drill into each step for detailed metadata. Configure alerts on error logs to proactively notify for failures and identify root cause of failing steps.


The following monitoring platforms are currently supported.
- Datadog
- Elastic Cloud
- AWS OpenSearch
- Kafka
- Confluent Cloud
info
If you don't see yours listed, join the private beta for early access to additional monitoring vendors
Logs
Logs are generated for certain events inside your Superblocks account. The following is a non-exhaustive list of events that generate a log.
- User logs in or joins organization
- A new user is invited
- A user group is created, modified, or deleted
- An application, Workflow, or Scheduled job is created, viewed, edited, deployed, modified, deleted, or cloned
- An API step (either in an application or in a Scheduled Job or Workflow) is executed, completes successfully, or fails
- An On-Premise Agent is registered, disconnected, or removed/deactivated
Configuration
Navigate to the Observability page and follow the instructions to configure sending logs to your preferred monitoring platform.
- Datadog
- Elastic Cloud
- AWS OpenSearch
- Kafka
- Confluent Cloud
Select the Datadog tile and fill out the form with the following configuration:
- Site - Datadog Site
- API Key - Datadog API key

Select the Elastic Cloud tile and fill out the form with the following configuration:
- Cloud ID - Unique ID for hosted Elasticsearch cluster, found in the Elasticsearch Service web console
- Cloud Auth - <USERNAME>:<PASSWORD>

Select the AWS OpenSearch tile and fill out the form with the following configuration:
- Host - Domain endpoint
- Port - HTTPS port
- Username - HTTPS username
- Password - HTTPS password

Join the private beta for early access to additional authentication options
Select the Kafka tile and fill out the form with the following configuration:
- Bootstrap Server - <HOST>:<PORT> for establishing initial connection to the cluster
- Topic - Topic to send logs
- SASL Username/Password - Authentication method detailed here

Select the Confluent Cloud tile and fill out the form with the following configuration:
- Bootstrap Server - <HOST>:<PORT> for establishing initial connection to the cluster
- Topic - Topic to send logs
- API Key - Cluster API Key
- API Secret - Cluster Secret

Logging Schema
resource-id The resource ID.
resource-type The resource type.
resource-name The resource name.
environment: The Superblocks environment, if any.
organization-id The Superblocks organization ID,
correlation-id The correlation id to group all related lots.
user-email The email of the user that invoked this log.
error The error details.
error-type The error type.
controller-id The controller (a component of the Agent Platform) ID.
worker-id The worker (a component of the Agent Platform) ID.
parent-id The resource ID of the parent resource, if any.
parent-name The resource name of the parent resource, if any.
parent-type The resource type of the parent resource, if any.
plugin The plugin name (e.g. postgres).
integration-id The integration ID.
level The severity level.
msg The message.
time The time of the log.
resource-action The action being taken (i.e. CREATED, DELETED, etc)
Example
{
"level": "info",
"time": 1654567707869,
"remote": "true",
"resource-id": "0fdfb61b-e8e7-4264-8ccb-fbf8fb0e88e0",
"resource-type": "step",
"environment": "staging",
"organization-id": "26c121f6-5315-4d62-8075-1996a544b5e5",
"resource-name": "Step2",
"user-email": "frank@superblockshq.com",
"resource-action": "finished",
"controller-id": "e3dff9c5-0e25-4a92-912f-5c5d1efb10ba",
"parent-id": "0c7f1653-cc9a-48af-b4be-41410a623efd",
"parent-name": "Franks Awesome Workflow",
"parent-type": "workflow",
"plugin": "python",
"integration-id": "80bbd4e7-9031-4a06-a5ad-fd4e19f3397f",
"msg": "The step \"Step2\" has finished."
}
Metrics
Join the private beta for early access to metrics.
Traces
Join the private beta for early access to traces.