SDK JavaScript: analytics, DNS e domini

api.apps.network funziona solo con le app web. Ogni metodo accetta come primo argomento l’id dell’app. Gli esempi usano il client api di Creare il client. appId è l’id di una delle tue app: api.account.me() le elenca.

Finestre temporali

analytics, errors, logs e performance accettano uno start e un end, ciascuno una stringa ISO 8601 o un Date. 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.

const end = new Date();
const start = new Date(end.getTime() - 24 * 60 * 60 * 1000); // last 24 h

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(appId, start, end, filters?) restituisce i totali del traffico e le relative suddivisioni. Restituisce null per una finestra senza traffico.

const analytics = await api.apps.network.analytics(appId, start, end);

if (analytics) {
    console.log(analytics.visits);    // [{ visits, requests, bytes, date }]
    console.log(analytics.countries); // [{ type: "BR", visits, requests, bytes }]
}

Le suddivisioni sono countries, devices, os, browsers, protocols, methods, paths, referers, providers, ips, status_codes, bots e content_types. Ogni gruppo ha type, visits, requests e bytes.

Filtri

I filtri restringono ogni suddivisione. Ciascuno accetta il valore type esatto della sua suddivisione:

const brazil = await api.apps.network.analytics(appId, start, end, {
    country: "BR",
    path: "/api",
    provider: "GOOGLE (15169)",
});

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"` significa nessun referer
`provider`	`"NAME (ASN)"`, ad es. `"GOOGLE (15169)"`
`content_type`	Il `type` della suddivisione

Un filtro non valido produce 400 INVALID_FILTER.

Errori

network.errors(appId, start, end, { include_4xx }) restituisce le risposte 5xx della finestra, più le 4xx con include_4xx: true. Restituisce null per una finestra vuota.

const errors = await api.apps.network.errors(appId, start, end, { include_4xx: true });

if (errors) {
    console.log(errors.summary.total, errors.summary.by_class);
    console.log(errors.top_paths);
}

Log delle richieste

network.logs(appId, start, end) restituisce le singole richieste con i dettagli di client, richiesta e risposta. Disponibile nei piani Pro ed Enterprise (altrimenti 403 UPGRADE_REQUIRED).

for (const log of await api.apps.network.logs(appId, start, end)) {
    console.log(log.timestamp, log.request.method, log.request.path, log.response.status);
}

Prestazioni

network.performance(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 null per una finestra vuota. Disponibile nei piani Pro ed Enterprise.

const performance = await api.apps.network.performance(appId, start, end);

if (performance) {
    console.log(performance.summary.edge.p95, performance.summary.origin.p95);
}

DNS

network.dns(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.

for (const { type, name, value, status } of await api.apps.network.dns(appId)) {
    console.log(type, name, value, status); // type: "txt" | "cname"
}

Dominio personalizzato

network.setDomain(appId, domain) associa un dominio personalizzato (dal piano Standard in su). Passa "@" per rimuoverlo.

await api.apps.network.setDomain(appId, "www.example.com");

// Remove it
await api.apps.network.setDomain(appId, "@");

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 di app su questo dominio previsto dal piano
409	`DOMAIN_ALREADY_EXISTS`	Il dominio appartiene a un’app di un altro account
502	`DNS_FAILED`	Il provider edge ha rifiutato il dominio

Svuotare la cache

network.purgeCache(appId) svuota la cache edge dell’app. È limitato a uno svuotamento ogni 60 secondi (429 KEEP_CALM).

await api.apps.network.purgeCache(appId);

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 dei piani 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 edge ha avuto un errore
503	`ANALYTICS_BUSY`	Le analytics dell’edge sono occupate: ripetuto 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 JavaScript: 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