Skip to main content

Page Action | Log

Use page.log() to log information to audit logs. Only available on Pro plans.

page.log("Deleted database record in user's table", {
    severity: "info",
    data: {
        userId: 123,
        recordId: 456,
    },
});

Audit Logs​

Collecting logs​

Compose will automatically collect basic system logs, which includes everytime a user runs an app. Due to Compose's tight security model, it's not possible for us to see what a user does within an app.

Hence, for any other logs you want, you can use page.log() to record events to your team's audit logs (e.g. when a resource is edited, a file is downloaded, etc.). All logs are automatically enriched with the user's session, timestamp, the app that was running, and more. Note that Compose may enforce rate limits to prevent abuse. We'll work with you to increase this limit if needed.

Viewing logs​

Logs can be viewed, filtered, and searched via the Compose dashboard.

Exporting logs​

You can request a CSV export of your logs by emailing us at atul@composehq.com. You can also request a custom export to a separate service such as S3, Datadog, etc. Contact us if you'd like to set this up.

Limits​

Compose enforces limits to prevent abuse of the platform.

  • Every organization is rate limited to 200 logs per minute. Reach out to us to increase this limit.
  • Audit log messages are capped at 1024 characters.
  • Audit log metadata is capped at 4 kilobytes.

API reference​

Function signature​

page.log(
    message: string,
    properties?: Partial<{
        severity: "trace" | "debug" | "info" | "warn" | "error" | "fatal",
        data: Record<string, any>
    }>
): void

Parameters​

message

required string
The message to log.

properties.severity

optional string literal
The severity of the log message. Options are trace, debug, info, warn, error, and fatal. Defaults to info.

properties.data

optional object
Optional metadata to log for the message.

Returns​

void