Utilisation du service de statistiques de téléchargement

Utilisation du service de statistiques de téléchargement

Principe général

Le SEDOO met à disposition:

  1. Un service sécurisé permettant d’enregistrer les informations de téléchargement. Ces informations sont les suivantes:
  • Uuid du produit
  • Nom du projet
  • Nom du catalogue
  • Pays de provenance de la demande
  • Volume téléchargé
  • Date du téléchargement
  1. Un bloc de visualisation dans le template par défaut afin de permettre de visualiser au sein d’une fiche de métadonnées les téléchargements liés.
  1. Un composant de visualisation pour un projet/catalogue destiné à être intégré dans un site web afin de permettre de visualiser l’ensemble des activités pour le projet/catalogue

Alimentation du service

Authentification

Les méthodes permettant de consulter les statistiques sont publiques.

La méthode permettant d’enregistrer une information de téléchargement nécessite de s’authentifier via un token présentent le rôle STAT_MANAGER dans le client stat-manager.

Alimentation via API

Le service peut être utilisé directement via son API (https://api.sedoo.fr/sedoo-benchmark-rest/swagger-ui/index.html).

La méthode save permet de stocker les informations concernant un téléchargement. Si elle n’est pas présente, la date est calculée au moment de l’appel.

Alimentation via la librairie Java

Le SEDOO met à dispo une librairie Java permettant de simplifier l’alimentation du service.

Dépendance

...
<dependency>
  <groupId>fr.sedoo</groupId>
  <artifactId>sedoo-stats-utils</artifactId>
  <version>0.0.1-SNAPSHOT</version>
</dependency>
...
<repository>
  <id>sedoorepo</id>
  <url>https://api.sedoo.fr/aeris-cdn-rest/mavenrepo</url>
  <snapshots>
    <enabled>true</enabled>
  </snapshots>
</repository>

Exemple d’appel

String token ="";
try {
  log.info("Sending stat request");
  token = TokenProvider.getToken(config.getStatManagerLogin(), config.getStatManagerPassword());
  StatsUtils.saveDownloadInfos(collectionId, BicocConfig.PROJECT_NAME, CommonConfig.CATALOGUE_NAME, request, volume, null, token);
  log.info("Stat request completed");
}
catch (Exception e ) {
  log.error("An error has occured while generating SSO token: {}", ExceptionUtils.getStackTrace(e));
}

Bloc de métadonnées

Le bloc de métadonnées s’appelle: aeris-metadata-stat

Rendu

Composant de visualisation par projet/catalogue

Le catalogue inclut un composant web avec un rendu identique permettant d’afficher les statistiques de téléchargement pour un projet ou pour un catalogue

Syntaxe pour un projet

...
<script src="https://api.sedoo.fr/aeris-cdn-rest/jsrepo/v1_0/download/sandbox/release/aeris-catalogue-component/3.0.0"></script>
...
<sedoo-stat-by-project project="SPATIAL.IASI-SOFRID" catalogue="aeris" />
...

Remarque: le nom du projet à indiquer est le nom complet.

Syntaxe pour un catalogue

...
<script src="https://api.sedoo.fr/aeris-cdn-rest/jsrepo/v1_0/download/sandbox/release/aeris-catalogue-component/3.0.0"></script>
...
<sedoo-stat-by-catalogue catalogue="aeris" />
...

Rechercher