Go SDK: live logs and status

package main

import (
	"context"
	"errors"
	"fmt"
	"io"
	"log"
	"os"

	"github.com/squarecloudofc/sdk-api-go/v3"
)

func main() {
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
	c := squarecloud.New(os.Getenv("SQUARECLOUD_API_KEY"))
	appID := "abc123def456abc123def456"

	r, err := c.Apps.Realtime(ctx, appID)
	if err != nil {
		log.Fatal(err)
	}
	defer r.Close()

	for {
		ev, err := r.Next()
		if err != nil {
			if errors.Is(err, io.EOF) || ctx.Err() != nil {
				break // the stream ended, or ctx was canceled
			}
			log.Fatal(err)
		}

		switch ev.Event {
		case "logs":
			fmt.Println(ev.Stream, ev.Line) // "stdout" | "stderr"
		case "status":
			fmt.Println(ev.Status.CPU, ev.Status.RAM) // never nil: always the full, merged state
		default:
			fmt.Println(ev.Event, ev.Data) // "system", "error" or "message"
		}
	}
}

​

Events

​

The Status struct

​

Ending the stream

• the server closes the connection cleanly (each connection lasts up to 10 minutes);
• the server sent REALTIME_DISCONNECTED (the event is delivered first, then io.EOF);
• you called Close.

​

Reconnection

• up to 3 times in a row; any logs or status event resets the count;
• each reopen at least 5.5 s after the previous open, to stay under the API’s pace of one open per 5 seconds per app.

​

Limits and errors

• 5 concurrent connections per account and 30 per app, across all users. Going over is 429 REALTIME_MAX_CONNECTIONS or REALTIME_MAX_CONNECTIONS_APP.
• The HTTP status is checked before streaming, so these errors (and 404 for an unknown app) are returned by Realtime itself, before the first Next.
• When ctx has no deadline, the WithTimeout deadline only covers the open, until the response headers arrive (TIMEOUT if they don’t). The stream itself has no deadline besides ctx.

​

Next steps