Guide d'utilisation de la page de statut
Présentation
La page de statut est une fonctionnalité dédiée au sein du portail de documentation ellocharlie, offrant à vos utilisateurs finaux une visibilité sur la santé de vos services. Elle s'intègre à votre page d'accueil, vos articles et votre journal des modifications, et hérite automatiquement de l'identité visuelle de votre portail (logo, nom de l'entreprise, couleur de marque) pour s'inscrire naturellement dans l'expérience de votre produit.
La page de statut affiche trois éléments principaux :
Indicateur de statut global du système — Indique en un coup d'œil si votre système est opérationnel, dégradé ou hors service
Grille des services — Liste les services individuels avec leur statut actuel et leur pourcentage de disponibilité
Chronologie des incidents — Un journal des incidents passés en ordre chronologique inverse, avec horodatages, gravité et détails de résolution
La mise en page est entièrement responsive et fonctionne parfaitement sur ordinateur, tablette et appareils mobiles. Vos clients peuvent y accéder à tout moment sans se connecter.
Configuration de la page de statut
Prérequis
Vous disposez d'un compte ellocharlie avec accès au portail
Vous avez configuré l'identité visuelle de votre portail (logo, nom de l'entreprise, couleur de marque)
Vous disposez d'un système de surveillance ou d'une source de données pour les informations de statut et de disponibilité
Étape 1 : Accéder à la configuration de la page de statut
La page de statut fait partie de votre portail de documentation ellocharlie. Accédez aux paramètres de votre portail et localisez la section Page de statut. La fonctionnalité est affichée en pleine page aux côtés de vos autres pages de portail.
Étape 2 : Connecter vos données de surveillance
La page de statut affiche des informations sur vos services et incidents. Vous devez la connecter à une source de données réelle. Il peut s'agir de :
Votre infrastructure de surveillance interne
Un fournisseur de surveillance SaaS tiers (p. ex., Datadog, StatusPage.io, PagerDuty)
Un point de terminaison API personnalisé que vous gérez
Collaborez avec votre administrateur ellocharlie ou l'équipe d'assistance pour configurer la connexion API qui alimentera votre page de statut en données de disponibilité et de statut.
Étape 3 : Définir vos services
Configurez les services qui apparaissent sur votre page de statut. Pour chaque service, précisez :
Nom du service — Un nom clair et visible par les clients (p. ex., « API », « Tableau de bord web », « Application mobile »)
Statut actuel — Opérationnel, dégradé ou hors service
Pourcentage de disponibilité — Métrique de disponibilité historique (p. ex., 99,9 %)
Les services sont stockés dans la configuration de votre client et seront automatiquement filtrés et affichés sur la page de statut.
Étape 4 : Configurer l'historique des incidents
Définissez la façon dont les incidents passés sont affichés. Les incidents doivent inclure :
Horodatages de début et de fin — Quand l'incident a débuté et a été résolu
Services affectés — Quels services ont été impactés
Niveau de gravité — Critique, majeur, mineur, etc.
Description — Une explication brève et accessible aux clients de ce qui s'est passé
Les incidents sont affichés en ordre chronologique inverse (les plus récents en premier) et regroupés par date pour faciliter la lecture.
Étape 5 : Publier et surveiller
Une fois configurée, votre page de statut est en ligne et accessible publiquement. Vos clients peuvent la consulter à tout moment pour vérifier la santé de votre système sans avoir à se connecter.
Utilisation de la page de statut
Pour vos clients
Vos utilisateurs finaux peuvent accéder à la page de statut en naviguant vers l'URL de la page de statut de votre portail. Ils verront :
État actuel du système — Un indicateur prominent en haut affichant l'état de santé global
Liste des services — Une grille ou liste de services avec leur état actuel et leur disponibilité
Historique des incidents — Une chronologie des incidents récents et de leurs résolutions
Aucune connexion n'est requise. La page est entièrement publique.
Pour votre équipe
En tant qu'administrateur ellocharlie, vous pouvez :
Surveiller la fraîcheur des données — Vérifier que votre API de surveillance alimente la page d'état avec des données à jour
Mettre à jour les enregistrements d'incidents — Ajouter de nouveaux incidents au fur et à mesure qu'ils surviennent et les marquer comme résolus une fois corrigés
Examiner les retours clients — Suivre si les clients trouvent la page d'état utile
Ajuster les définitions des services — Ajouter, supprimer ou renommer des services au fur et à mesure de l'évolution de votre produit
FAQ et bonnes pratiques
Q : D'où proviennent les données d'état et de disponibilité ?
R : La page d'état extrait les données de votre système de surveillance configuré. Il peut s'agir de votre surveillance d'infrastructure interne, d'un fournisseur SaaS tiers ou d'un point de terminaison API personnalisé. Les données réelles doivent être récupérées depuis votre système de surveillance et intégrées à la page d'état via des appels API. Travaillez avec votre équipe d'assistance ellocharlie pour configurer l'intégration.
Q : Les clients peuvent-ils personnaliser les services affichés sur la page d'état ?
R : La page d'état affiche les services en fonction de votre configuration. Si vous souhaitez proposer une personnalisation par client, suivez les modèles multi-locataires plus larges d'ellocharlie — stockez les listes de services dans la configuration de chaque client et filtrez en conséquence. Contactez l'assistance ellocharlie pour discuter des options de configuration personnalisée.
Q : La page d'état doit-elle se rafraîchir automatiquement ?
R : Oui. La bonne pratique consiste à interroger votre API de surveillance toutes les 30 à 60 secondes pour maintenir la page à jour sans surcharger votre backend. Cela garantit que les clients voient toujours des informations d'état quasi en temps réel. Votre administrateur ellocharlie peut configurer l'intervalle d'interrogation.
Q : Comment les incidents doivent-ils être présentés ?
R : Les incidents doivent être affichés sous forme de chronologie en ordre chronologique inverse (les plus récents en premier) avec :
Des heures de début et de fin clairement indiquées
La liste des services affectés
Un badge de sévérité (critique, majeur, mineur, etc.)
Une description brève et compréhensible par le client du problème et de sa résolution
Regroupez les incidents par date si votre historique devient long, et veillez à ce que les descriptions soient claires et non techniques.
Q : Qu'en est-il de la réactivité mobile ?
R : La page d'état est entièrement responsive. Sur les appareils mobiles :
La grille des services s'empile en une seule colonne pour faciliter le défilement
Les détails des incidents restent lisibles sans défilement horizontal
L'indicateur d'état de niveau supérieur et la navigation restent accessibles
Testez la page d'état sur des appareils mobiles pour vous assurer que vos clients bénéficient d'une bonne expérience.
Q : La page d'état nécessite-t-elle une authentification ?
R : Non. La page d'état est un portail public. Vos clients n'ont pas besoin de se connecter pour la consulter. Cela permet à n'importe qui de vérifier l'état de santé de votre système, même s'il ne possède pas de compte ellocharlie.
Q : Comment mettre à jour la page d'état lorsqu'un incident survient ?
R : Lorsqu'un incident se produit, ajoutez-le à votre historique des incidents avec :
L'heure de début de l'incident
Une description de ce qui est affecté et des mesures que vous prenez
Les services affectés
Au fur et à mesure que vous travaillez sur la résolution, mettez à jour l'enregistrement de l'incident avec des notes de progression. Une fois résolu, marquez l'incident comme résolu et enregistrez l'heure de fin. Vos clients verront la mise à jour en temps réel (ou dans votre intervalle d'interrogation).
Q : Puis-je personnaliser l'apparence de la page d'état ?
R : Oui. La page d'état hérite automatiquement de l'identité visuelle de votre portail :
Le logo de votre entreprise
Le nom de votre entreprise
La couleur de votre marque
L'en-tête, le pied de page et le thème de votre portail
La page de statut conserve un style cohérent avec le reste de votre portail ellocharlie, afin qu'elle soit perçue comme une partie native de votre expérience produit.
Q : Que faire si je n'ai pas encore de système de surveillance ?
R : Vous devrez mettre en place un moyen de suivre et de signaler l'état de votre système. Les options disponibles sont les suivantes :
Surveillance interne — Créez ou configurez une surveillance pour votre infrastructure
SaaS tiers — Utilisez un service tel que Datadog, StatusPage.io ou PagerDuty
Solution personnalisée — Créez un point de terminaison API simple qui rapporte l'état de votre service
Contactez le support ellocharlie pour obtenir des conseils sur l'intégration de la solution de surveillance choisie avec la page de statut.
Bonnes pratiques
Restez simple
Utilisez un langage clair et accessible aux clients. Évitez le jargon technique. Par exemple, indiquez « Base de données indisponible » plutôt que « Le délai de réplication PostgreSQL a dépassé le seuil. »
Mettez à jour fréquemment lors des incidents
Lorsqu'un incident est en cours, mettez régulièrement à jour l'enregistrement de l'incident afin que les clients sachent que vous en êtes informé et que vous travaillez à sa résolution. Cela réduit les demandes d'assistance et renforce la confiance.
Soyez transparent
Fournissez suffisamment de détails pour que les clients comprennent ce qui se passe, sans les submerger de détails techniques. Une bonne description d'incident explique ce qui est affecté, ce que vous faites et quand vous prévoyez une résolution.
Surveillez la fraîcheur des données
Assurez-vous que vos données de surveillance sont mises à jour régulièrement. Si votre page de statut affiche des données obsolètes, les clients perdront confiance en elle. Configurez des alertes pour être notifié si les mises à jour de données s'arrêtent.
Testez sur tous les appareils
Vérifiez que la page de statut s'affiche correctement et fonctionne bien sur les ordinateurs de bureau, les tablettes et les appareils mobiles. Vos clients peuvent consulter le statut depuis n'importe où.
Utilisez une terminologie cohérente
Gardez les noms de services, les libellés de statut et les niveaux de gravité cohérents dans toutes vos communications. Si vous appelez quelque chose « API » sur la page de statut, utilisez le même nom dans les descriptions d'incidents et les communications avec les clients.
Archivez les anciens incidents
Au fil du temps, votre historique d'incidents va s'allonger. Envisagez d'archiver ou de supprimer les incidents très anciens afin de concentrer la chronologie sur les événements récents. Une bonne règle empirique consiste à conserver les 90 derniers jours d'incidents visibles.