Skip to main content

Observability

Superblocks Observability lets you seamlessly send logs to your preferred observability platform, enabling you to efficiently monitor and manage your internal tools. With Observability you can:

  • View actions performed byusers, like app edits, deployments, permission changes, and more
  • View authentications made by your users
  • Capture forensic data for security purposes
  • Identify patterns in usage trends
  • Set up alerts to get immediate notifications about potential failures
  • View errors to determine the root cause of issues
Python code error
Traces and logs within Datadog

Supported vendors​

Log types​

Logs are generated for many different types of events in Superblocks. The following is a non-exhaustive list of events that generate a log.

  • A user logs in to Superblocks
  • An App, Workflow, or Scheduled Job is created, edited, or deployed
  • A deployed Application is viewed or previewed
  • An API is started or finished
  • An API step is started and returned successfully or failed
  • An API step logged to stdout
  • An On-Premise Agent is registered, disconnected, or removed

Log schemas​

agent-id          The id of the Superblocks Cloud or On-Premise Agent executing the request
agent-version     The version of the Superblocks Cloud or On-Premise Agent executing the request
application-id    The id of the parent Application where the API ran (if applicable)
component         The Superblocks agent component (e.g, orchestrator, worker.py, worker.go)
correlation-id    The unique id for aggregating all logs of a single API execution
level             The severity level
message           The log message
organization-id   The Superblocks organization id
profile           The Superblocks profile used during execution
resource-action   The resource action
resource-id       The id of the API executed
resource-name     The resource name
resource-type     The resource type
service           An identifier for Superblocks
source            An identifier for Superblocks
timestamp         The timestamp of the log
user-email        The user who executed the API
user-type         The type of user, either Superblocks or Embed

Example

{
    "agent-id": "018cd5aa-6b42-7f68-9384-e691f254a425",
    "agent-version": "v0.1282.0",
    "component": "orchestrator",
    "correlation-id": "018cda86-2ff2-7f70-b6c9-038b0c4b34a1",
    "level": "info",
    "message": "The api API1 has been started.",
    "organization-id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "profile": "production",
    "resource-action": "started",
    "resource-id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "resource-name": "API1",
    "resource-type": "api",
    "service": "superblocks",
    "source": "superblocks",
    "timestamp": 1701377369695,
    "user-email": "name@company.com",
    "user-type": "superblocks"
  }