SDK Go: analytics, DNS e domini

c.Apps.Network funziona solo con le app web. Ogni metodo accetta prima ctx e l’id dell’app. Ogni snippet qui sotto funziona da solo all’interno di questo programma: incollane uno alla volta in main ed esegui goimports (vedi Eseguire gli esempi).

package main

import (
	"context"
	"os"
	"time"

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

var (
	ctx   = context.Background()
	c     = squarecloud.New(os.Getenv("SQUARECLOUD_API_KEY"))
	appID = "abc123def456abc123def456"
	end   = time.Now()
	start = end.Add(-24 * time.Hour) // the last 24 hours
)

func main() {
	// Paste one snippet here, then run goimports.
}

Finestre temporali

Analytics, Errors, Logs e Performance accettano uno start e un end, ciascuno un time.Time (inviato in RFC 3339 in UTC). Il programma qui sopra li imposta sulle ultime 24 ore. Una finestra è al massimo di 7 giorni, e start viene limitato alla data di creazione dell’app. Una finestra non valida produce 400 INVALID_TIME_RANGE. I risultati vengono messi in cache in intervalli di 5 minuti. I cache miss di questi quattro metodi condividono un limite di 20 richieste ogni 60 secondi per account: superarlo produce 429 RATE_LIMITED.

Analytics

Network.Analytics(ctx, appID, start, end, filters) restituisce i totali del traffico e le relative suddivisioni come *NetworkAnalytics. Restituisce nil (e un errore nil) per una finestra senza traffico. Passa un squarecloud.AnalyticsFilters{} vuoto per non applicare filtri.

analytics, err := c.Apps.Network.Analytics(ctx, appID, start, end, squarecloud.AnalyticsFilters{})
if err != nil {
	log.Fatal(err)
}

if analytics != nil {
	fmt.Println(analytics.Visits)    // []AnalyticsTimeBucket: Date, Visits, Requests, Bytes
	fmt.Println(analytics.Countries) // []AnalyticsBucket: Type ("BR"), Visits, Requests, Bytes
}

Le suddivisioni sono Countries, Devices, OS, Browsers, Protocols, Methods, Paths, Referers, Providers, IPs, StatusCodes, Bots e ContentTypes (in JSON countries, …, status_codes, bots, content_types). Ogni gruppo ha Type, Visits, Requests e Bytes (int64).

Filtri

I filtri restringono ogni suddivisione. Ciascuno accetta il valore esatto di Type della sua suddivisione. Un campo vuoto non viene inviato:

brazil, err := c.Apps.Network.Analytics(ctx, appID, start, end, squarecloud.AnalyticsFilters{
	Country:  "BR",
	Path:     "/api",
	Provider: "GOOGLE (15169)",
})
if err != nil {
	log.Fatal(err)
}

if brazil != nil {
	fmt.Println(brazil.Paths)
}

Filtro	Esempio
`Country`	`"BR"` (codice di 2 lettere)
`IP`	`"203.0.113.7"`
`Path`	`"/api"` (prefisso del percorso)
`Status`	`"404"`
`OS`, `Browser`, `Protocol`, `Bot`	Il `Type` della suddivisione
`Referer`	`"Direct"` indica nessun referer
`Provider`	`"NAME (ASN)"`, ad es. `"GOOGLE (15169)"`
`ContentType`	Il `Type` della suddivisione

Un filtro non valido produce 400 INVALID_FILTER.

Errori

Network.Errors(ctx, appID, start, end, include4xx) restituisce le risposte 5xx della finestra, più le 4xx quando include4xx è true. Restituisce nil per una finestra vuota.

errs, err := c.Apps.Network.Errors(ctx, appID, start, end, true)
if err != nil {
	log.Fatal(err)
}

if errs != nil {
	fmt.Println(errs.Summary.Total, errs.Summary.ByClass) // ByClass: map[string]int64 with "4xx", "5xx"
	fmt.Println(errs.TopPaths)
}

Log delle richieste

Network.Logs(ctx, appID, start, end) restituisce le singole richieste con i dettagli del client, della richiesta e della risposta. Disponibile nei piani Pro ed Enterprise (altrimenti 403 UPGRADE_REQUIRED).

logs, err := c.Apps.Network.Logs(ctx, appID, start, end)
if err != nil {
	log.Fatal(err)
}
for _, l := range logs {
	fmt.Println(l.Timestamp, l.Request.Method, l.Request.Path, l.Response.Status)
}

I campi che l’API può inviare come null sono puntatori (Client.IP, Client.Country, Request.Query, Request.Referer, Response.Cache, …).

Prestazioni

Network.Performance(ctx, appID, start, end) restituisce i percentili di latenza (P50, P95, P99, in ms) all’edge e all’origine, per paese, per località e per i percorsi più lenti. Restituisce nil per una finestra vuota. Disponibile nei piani Pro ed Enterprise. Ogni percentile è un *float64, nil quando non c’erano richieste da misurare:

performance, err := c.Apps.Network.Performance(ctx, appID, start, end)
if err != nil {
	log.Fatal(err)
}

if performance != nil {
	if p95 := performance.Summary.Edge.P95; p95 != nil {
		fmt.Println("edge p95", *p95)
	}
	if p95 := performance.Summary.Origin.P95; p95 != nil {
		fmt.Println("origin p95", *p95)
	}
}

DNS

Network.DNS(ctx, appID) restituisce i record DNS di cui ha bisogno il tuo dominio personalizzato, con il loro stato. Senza un dominio personalizzato produce 400 NO_CUSTOM_DOMAIN.

records, err := c.Apps.Network.DNS(ctx, appID)
if err != nil {
	log.Fatal(err)
}
for _, r := range records {
	fmt.Println(r.Type, r.Name, r.Value, r.Status) // Type: "txt" | "cname"
}

Dominio personalizzato

Network.SetDomain(ctx, appID, domain) associa un dominio personalizzato (piano Standard o superiore). Passa "@" per rimuoverlo.

if err := c.Apps.Network.SetDomain(ctx, appID, "www.example.com"); err != nil {
	log.Fatal(err)
}

// Remove it
if err := c.Apps.Network.SetDomain(ctx, appID, "@"); err != nil {
	log.Fatal(err)
}

Status	Codice	Quando
400	`INVALID_DOMAIN`	Non è un nome di dominio valido
400	`RESERVED_DOMAIN`	Un dominio di Square Cloud
403	`UPGRADE_REQUIRED`	Il piano non include domini personalizzati
403	`LOAD_BALANCER_LIMIT_REACHED`	È stato raggiunto il limite del piano di app su questo dominio
409	`DOMAIN_ALREADY_EXISTS`	Il dominio appartiene a un’app di un altro account
502	`DNS_FAILED`	Il provider dell’edge ha rifiutato il dominio

Svuotare la cache

Network.PurgeCache(ctx, appID) svuota la cache dell’edge dell’app. È limitato a uno svuotamento ogni 60 secondi (429 KEEP_CALM).

if err := c.Apps.Network.PurgeCache(ctx, appID); err != nil {
	log.Fatal(err)
}

Errori dei metodi di analytics

Status	Codice	Quando
400	`INVALID_TIME_RANGE`	`start`/`end` mancanti, malformati o invertiti
400	`INVALID_FILTER`	Un filtro non rispetta il suo formato (`Analytics`)
403	`UPGRADE_REQUIRED`	`Logs` e `Performance` al di fuori di Pro ed Enterprise
429	`RATE_LIMITED`	Raggiunto il limite condiviso di cache miss
500	`UNABLE_TO_FETCH_ANALYTICS`, `UNABLE_TO_FETCH_ERRORS`, `UNABLE_TO_FETCH_PERFORMANCE`	Il provider dell’edge ha avuto un errore
503	`ANALYTICS_BUSY`	Le analytics dell’edge sono occupate: ritentato automaticamente

Prossimi passi

Realtime

Log e stato in tempo reale, in streaming.

Riferimento API di rete

Gli endpoint REST dietro questi metodi.

Analytics edge dalla CLI

Le stesse azioni dal terminale.

CLI

VS Code

SDKs

SDK Go: analytics, DNS e domini

Finestre temporali

Analytics

Filtri

Errori

Log delle richieste

Prestazioni

DNS

Dominio personalizzato

Svuotare la cache

Errori dei metodi di analytics

Prossimi passi

Realtime

Riferimento API di rete

Analytics edge dalla CLI

​Finestre temporali

​Analytics

​Filtri

​Errori

​Log delle richieste

​Prestazioni

​DNS

​Dominio personalizzato

​Svuotare la cache

​Errori dei metodi di analytics

​Prossimi passi

Realtime

Riferimento API di rete

Analytics edge dalla CLI

Finestre temporali

Analytics

Filtri

Errori

Log delle richieste

Prestazioni

DNS

Dominio personalizzato

Svuotare la cache

Errori dei metodi di analytics

Prossimi passi