SDK JavaScript : analytics, DNS et domaines

api.apps.network fonctionne uniquement sur les applications web. Chaque méthode prend d’abord l’identifiant de l’application. Les exemples utilisent le client api présenté dans Créer le client. appId est l’identifiant de l’une de vos applications : api.account.me() les liste.

Fenêtres temporelles

analytics, errors, logs et performance prennent un start et un end, chacun étant une chaîne ISO 8601 ou une Date. Une fenêtre dure au maximum 7 jours, et start est ramené à la date de création de l’application. Une fenêtre invalide donne 400 INVALID_TIME_RANGE.

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

Les résultats sont mis en cache par tranches de 5 minutes. Les défauts de cache de ces quatre méthodes partagent une limite de 20 requêtes par 60 secondes et par compte : la dépasser donne 429 RATE_LIMITED.

Analytics

network.analytics(appId, start, end, filters?) renvoie les totaux et les répartitions du trafic. Elle renvoie null pour une fenêtre sans trafic.

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 }]
}

Les répartitions sont countries, devices, os, browsers, protocols, methods, paths, referers, providers, ips, status_codes, bots et content_types. Chaque groupe a type, visits, requests et bytes.

Filtres

Les filtres restreignent chaque répartition. Chacun prend la valeur type exacte de sa répartition :

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

Filtre	Exemple
`country`	`"BR"` (code à 2 lettres)
`ip`	`"203.0.113.7"`
`path`	`"/api"` (préfixe de chemin)
`status`	`"404"`
`os`, `browser`, `protocol`, `bot`	Le `type` de la répartition
`referer`	`"Direct"` signifie aucun referer
`provider`	`"NAME (ASN)"`, par ex. `"GOOGLE (15169)"`
`content_type`	Le `type` de la répartition

Un filtre invalide donne 400 INVALID_FILTER.

Erreurs

network.errors(appId, start, end, { include_4xx }) renvoie les réponses 5xx de la fenêtre, plus les 4xx avec include_4xx: true. Elle renvoie null pour une fenêtre vide.

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);
}

Logs de requêtes

network.logs(appId, start, end) renvoie les requêtes individuelles avec les détails du client, de la requête et de la réponse. Disponible sur les plans Pro et Enterprise (403 UPGRADE_REQUIRED sinon).

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);
}

Performances

network.performance(appId, start, end) renvoie les percentiles de latence (p50, p95, p99, en ms) en périphérie et à l’origine, par pays, par emplacement et pour les chemins les plus lents. Elle renvoie null pour une fenêtre vide. Disponible sur les plans Pro et 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) renvoie les enregistrements DNS dont votre domaine personnalisé a besoin, avec leur statut. Sans domaine personnalisé, elle donne 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"
}

Domaine personnalisé

network.setDomain(appId, domain) associe un domaine personnalisé (plan Standard et supérieurs). Passez "@" pour le supprimer.

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

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

Statut	Code	Quand
400	`INVALID_DOMAIN`	Nom de domaine invalide
400	`RESERVED_DOMAIN`	Un domaine de Square Cloud
403	`UPGRADE_REQUIRED`	Le plan n’inclut pas de domaines personnalisés
403	`LOAD_BALANCER_LIMIT_REACHED`	La limite d’applications du plan sur ce domaine a été atteinte
409	`DOMAIN_ALREADY_EXISTS`	Le domaine appartient à une application d’un autre compte
502	`DNS_FAILED`	Le fournisseur edge a refusé le domaine

Purger le cache

network.purgeCache(appId) vide le cache edge de l’application. Elle est limitée à une purge toutes les 60 secondes (429 KEEP_CALM).

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

Erreurs des méthodes d’analytics

Statut	Code	Quand
400	`INVALID_TIME_RANGE`	`start`/`end` manquant, mal formé ou inversé
400	`INVALID_FILTER`	Un filtre ne respecte pas son format (`analytics`)
403	`UPGRADE_REQUIRED`	`logs` et `performance` en dehors de Pro et Enterprise
429	`RATE_LIMITED`	Limite partagée de défauts de cache atteinte
500	`UNABLE_TO_FETCH_ANALYTICS`, `UNABLE_TO_FETCH_ERRORS`, `UNABLE_TO_FETCH_PERFORMANCE`	Le fournisseur edge a échoué
503	`ANALYTICS_BUSY`	Les analytics edge sont occupées : nouvelle tentative automatique

Prochaines étapes

Temps réel

Diffusez les logs et le statut en direct.

Référence de l'API réseau

Les endpoints REST derrière ces méthodes.

Analytics edge depuis la CLI

Les mêmes actions depuis le terminal.

CLI

VS Code

SDKs

SDK JavaScript : analytics, DNS et domaines

Fenêtres temporelles

Analytics

Filtres

Erreurs

Logs de requêtes

Performances

DNS

Domaine personnalisé

Purger le cache

Erreurs des méthodes d’analytics

Prochaines étapes

Temps réel

Référence de l'API réseau

Analytics edge depuis la CLI

​Fenêtres temporelles

​Analytics

​Filtres

​Erreurs

​Logs de requêtes

​Performances

​DNS

​Domaine personnalisé

​Purger le cache

​Erreurs des méthodes d’analytics

​Prochaines étapes

Temps réel

Référence de l'API réseau

Analytics edge depuis la CLI

Fenêtres temporelles

Analytics

Filtres

Erreurs

Logs de requêtes

Performances

DNS

Domaine personnalisé

Purger le cache

Erreurs des méthodes d’analytics

Prochaines étapes