Query and Export Audit Logs

Use the AI Studio SDK to read workspace audit logs page by page, write one JSON record per line to a local JSONL file, and query the workspace audit overview.

Task flow

Fetch audit log pages through the workspace member service and write each entry to disk, then query the audit overview to inspect total, succeeded, and failed counts.

Workspace Member Service + Local Output Path
                     │
                     ▼
Read audit logs page by page and write local JSONL lines
                     │
                     ▼
  Read audit overview (total / succeeded / failed)

Prerequisites

  1. Complete the endpoint, personal access token, and workspace setup in Use the SDK.

  2. Audit read permission: confirm that the current identity is authorized to read audit logs in the target workspace.

  3. Local output path: choose a local file path that does not yet exist; when AUDIT_OUTPUT is unset, the example writes to audit-logs.jsonl in the current directory and opens the file in exclusive creation mode so existing files are preserved.

To specify a custom output path, export the environment variable in your terminal:

export AUDIT_OUTPUT='./audit-logs.jsonl'

Read and save audit logs page by page

Fetch workspace audit logs in pages of 100 and serialize each record as a single JSON line in the output file, stopping when an empty page is returned or fetched items reach the total count. If a network error interrupts the export, the file retains only records already written; specify a new file path before retrying.

import json
import os

from google.protobuf.json_format import MessageToDict
import moi_product_sdk as sdk

client = sdk.new_with_personal_access_token(
    os.environ["PRODUCT_API_BASE_URL"],
    os.environ["PRODUCT_API_KEY"],
)
workspace = client.workspace(os.environ["WORKSPACE_ID"])
members = workspace.members()

output = os.environ.get("AUDIT_OUTPUT", "audit-logs.jsonl")
page_number = 1
saved = 0
with open(output, "x", encoding="utf-8") as stream:
    while True:
        page = members.audit_logs(
            sdk.with_page(page_number),
            sdk.with_page_size(100),
        )
        for item in page.items:
            payload = MessageToDict(item, preserving_proto_field_name=True)
            stream.write(json.dumps(payload, ensure_ascii=False) + "\n")
            saved += 1
        if not page.items or page.page * page.page_size >= page.total:
            break
        page_number += 1

print("Saved path:", output, "Record count:", saved)
package main

import (
	"context"
	"fmt"
	"os"

	sdk "github.com/matrixorigin/matrixflow/sdk/go-sdk"
	"google.golang.org/protobuf/encoding/protojson"
)

func main() {
	ctx := context.Background()
	client, err := sdk.NewWithPersonalAccessToken(
		os.Getenv("PRODUCT_API_BASE_URL"),
		os.Getenv("PRODUCT_API_KEY"),
	)
	if err != nil {
		panic(err)
	}
	workspace, err := client.Workspace(os.Getenv("WORKSPACE_ID"))
	if err != nil {
		panic(err)
	}
	members := workspace.Members()

	output := os.Getenv("AUDIT_OUTPUT")
	if output == "" {
		output = "audit-logs.jsonl"
	}
	stream, err := os.OpenFile(output, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0600)
	if err != nil {
		panic(err)
	}
	defer stream.Close()

	saved := 0
	for pageNumber := 1; ; pageNumber++ {
		page, err := members.AuditLogs(ctx, sdk.WithPage(pageNumber), sdk.WithPageSize(100))
		if err != nil {
			panic(err)
		}
		for _, item := range page.GetItems() {
			data, err := (protojson.MarshalOptions{UseProtoNames: true}).Marshal(item)
			if err != nil {
				panic(err)
			}
			if _, err = stream.Write(append(data, '\n')); err != nil {
				panic(err)
			}
			saved++
		}
		if len(page.GetItems()) == 0 || int64(page.GetPage())*int64(page.GetPageSize()) >= page.GetTotal() {
			break
		}
	}

	fmt.Println("Saved path:", output, "Record count:", saved)
}

Read the audit overview

Reuse the same member service to query the workspace audit overview. If new operations occur while paginating through logs, the overview total can exceed the number of records saved to disk.

overview = members.audit_log_overview()
print("Overview total:", overview.total, "Succeeded:", overview.success, "Failed:", overview.failed)
overview, err := members.AuditLogOverview(ctx)
if err != nil {
	panic(err)
}
fmt.Println("Overview total:", overview.GetTotal(), "Succeeded:", overview.GetSuccess(), "Failed:", overview.GetFailed())

Next steps

Last updated on