CLM documentation (public beta)

.github/workflows/documentation.yml

@@ -28,6 +28,7 @@ jobs:
       build_pp: ${{ steps.filters.outputs.build_pp }}
       build_cloud: ${{ steps.filters.outputs.build_cloud }}
       build_dem: ${{ steps.filters.outputs.build_dem }}
+      build_logmanagement: ${{ steps.filters.outputs.build_logmanagement }}
 
     steps:
       - name: Checkout sources
@@ -57,6 +58,9 @@ jobs:
             dem:
               - 'dem/**'
               - 'i18n/**/docusaurus-plugin-content-docs-dem/**'
+            logmanagement:
+              - 'logmanagement/**'
+              - 'i18n/**/docusaurus-plugin-content-docs-logmanagement/**'
             pp:
               - 'pp/**'
               - 'i18n/**/docusaurus-plugin-content-docs-pp/**'
@@ -79,6 +83,7 @@ jobs:
             let build_pp = '1';
             let build_cloud = '1';
             let build_dem = '1';
+            let build_logmanagement = '1';
 
             if ('${{ github.event_name }}' === 'pull_request' && ${{ steps.changes.outputs.global }} === false) {
               if (${{ steps.changes.outputs.versions }} === false && ${{ steps.changes.outputs.pp }} === false) {
@@ -93,6 +98,10 @@ jobs:
                 build_dem = '0';
               }
 
+              if (${{ steps.changes.outputs.versions }} === false && ${{ steps.changes.outputs.logmanagement }} === false) {
+                build_logmanagement = '0';
+              }
+
               build_versions = [];
               build_next_version = null;
               if (${{ steps.changes.outputs.versions }} === true) {
@@ -110,7 +119,10 @@ jobs:
                 build_versions = [...new Set(build_versions)].sort().reverse(); // remove duplicates and sort desc
               }
 
-              if (build_versions.length === 0 && (build_pp === '1' || build_cloud === '1' || build_dem === '1')) {
+              if (
+                build_versions.length === 0 &&
+                (build_pp === '1' || build_cloud === '1' || build_dem === '1' || build_logmanagement === '1')
+              ) {
                 build_versions.push(available_versions[0]);
               }
             }
@@ -120,6 +132,7 @@ jobs:
             console.log(`pp section will${build_pp === '0' ? ' not' : ''} be built`);
             console.log(`cloud section will${build_cloud === '0' ? ' not' : ''} be built`);
             console.log(`dem section will${build_dem === '0' ? ' not' : ''} be built`);
+            console.log(`logmanagement section will${build_logmanagement === '0' ? ' not' : ''} be built`);
 
             const build_environments = [];
             if (build_versions.length) {
@@ -135,6 +148,7 @@ jobs:
             core.exportVariable('build_pp', build_pp);
             core.exportVariable('build_cloud', build_cloud);
             core.exportVariable('build_dem', build_dem);
+            core.exportVariable('build_logmanagement', build_logmanagement);
 
       - name: Manage versions to build
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
@@ -154,6 +168,7 @@ jobs:
             core.exportVariable('build_pp', '1');
             core.exportVariable('build_cloud', '1');
             core.exportVariable('build_dem', '1');
+            core.exportVariable('build_logmanagement', '1');
 
       - name: Manage versions to build
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
@@ -166,6 +181,7 @@ jobs:
             core.setOutput('build_pp', '${{ env.build_pp }}');
             core.setOutput('build_cloud', '${{ env.build_cloud }}');
             core.setOutput('build_dem', '${{ env.build_dem }}');
+            core.setOutput('build_logmanagement', '${{ env.build_logmanagement }}');
 
   build:
     if: ${{ needs.get-versions.outputs.build_environments != '[]' }}
@@ -182,6 +198,7 @@ jobs:
             pp: ${{ needs.get-versions.outputs.build_pp }}
             cloud: ${{ needs.get-versions.outputs.build_cloud }}
             dem: ${{ needs.get-versions.outputs.build_dem }}
+            logmanagement: ${{ needs.get-versions.outputs.build_logmanagement }}
 
     name: Build ${{ matrix.environment }}
 
@@ -207,15 +224,6 @@ jobs:
         run: pnpm install --frozen-lockfile
         shell: bash
 
-      - name: Restore rspack cache
-        uses: actions/cache/restore@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5.0.3
-        with:
-          path: |
-            ./node_modules/.cache
-          key: docusaurus-rspack-${{ matrix.environment }}-${{ github.head_ref || github.ref_name }}
-          restore-keys: |
-            docusaurus-rspack-${{ matrix.environment }}-staging
-
       - name: Build documentation
         run: pnpm build
         env:
@@ -224,6 +232,7 @@ jobs:
           PP: ${{ matrix.pp }}
           CLOUD: ${{ matrix.cloud }}
           DEM: ${{ matrix.dem }}
+          LOGMANAGEMENT: ${{ matrix.logmanagement }}
           VERSIONS: ${{ matrix.environment == 'staging' && matrix.versions || matrix.next_version }}
           BASE_URL: ${{ github.event_name == 'pull_request' && format('/previews/pr-{0}/{1}', github.event.pull_request.number, matrix.environment) || '' }}
 
@@ -247,15 +256,6 @@ jobs:
             build
           key: docusaurus-build-${{ matrix.environment }}-${{ github.head_ref || github.ref_name }}
 
-      - name: Store rspack cache
-        # only store cache for staging branch builds because it is too big (~1.2GB)
-        if: github.ref_name == 'staging' && github.event_name != 'pull_request'
-        uses: actions/cache/save@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5.0.3
-        with:
-          path: |
-            ./node_modules/.cache
-          key: docusaurus-rspack-${{ matrix.environment }}-${{ github.head_ref || github.ref_name }}
-
   deploy-preview:
     if: ${{ github.event_name == 'pull_request' }}
     needs: [get-versions, build]

docusaurus.config.js

@@ -49,9 +49,19 @@ const dem = (() => {
   return true;
 })();
 
+const logmanagement = (() => {
+  if (archivedVersion) {
+    return false;
+  }
+  if (process.env.LOGMANAGEMENT !== undefined && process.env.LOGMANAGEMENT === '0') {
+    return false;
+  }
+  return true;
+})();
+
 const baseUrl = process.env.BASE_URL ? process.env.BASE_URL : (archivedVersion ? `${archivedVersion}/` : '/');
 
-if (versions.length == 0 && !pp && !cloud && !dem) {
+if (versions.length == 0 && !pp && !cloud && !dem && !logmanagement) {
   throw new Error('Nothing is selected for build');
 }
 
@@ -63,16 +73,16 @@ const config = {
 
   future: {
     v4: {
-      removeLegacyPostBuildHeadAttribute: false,
+      removeLegacyPostBuildHeadAttribute: true,
       useCssCascadeLayers: true,
     },
     experimental_faster: {
-      swcJsLoader: false,
-      swcJsMinimizer: false,
-      swcHtmlMinimizer: false,
-      lightningCssMinimizer: false,
+      swcJsLoader: true,
+      swcJsMinimizer: true,
+      swcHtmlMinimizer: true,
+      lightningCssMinimizer: true,
       rspackBundler: true,
-      rspackPersistentCache: true,
+      rspackPersistentCache: false,
       ssgWorkerThreads: false,
       mdxCrossCompilerCache: false,
     },
@@ -168,8 +178,8 @@ const config = {
       ({
         hashed: true,
         indexBlog: false,
-        docsRouteBasePath: ["docs", "cloud", "pp", "dem"],
-        docsDir: ["i18n", "versioned_docs", "cloud", "pp", "dem"],
+        docsRouteBasePath: ["docs", "cloud", "pp", "dem", "logmanagement"],
+        docsDir: ["i18n", "versioned_docs", "cloud", "pp", "dem", "logmanagement"],
         explicitSearchResultPath: true,
         useAllContextsWithNoSearchContext: true,
         // searchContextByPaths: [
@@ -271,6 +281,25 @@ const config = {
       ];
     }
 
+    if (logmanagement) {
+      plugins = [
+        ...plugins,
+        [
+          '@docusaurus/plugin-content-docs',
+          {
+            id: 'logmanagement',
+            path: 'logmanagement',
+            routeBasePath: 'logmanagement',
+            sidebarPath: './logmanagement/sidebarsLogmanagement.js',
+            breadcrumbs: true,
+            editUrl: 'https://github.com/centreon/centreon-documentation/edit/staging/',
+            editLocalizedFiles: true,
+            showLastUpdateTime: true,
+          },
+        ],
+      ];
+    }
+
     return plugins;
   })(),
 
@@ -352,7 +381,7 @@ const config = {
               type: 'doc',
               docId: defaultPageId,
               position: 'left',
-              label: 'Centreon OnPrem'
+              label: 'Infra Monitoring OnPrem'
             },
           ];
 
@@ -361,7 +390,7 @@ const config = {
               ...items,
               {
                 to: '/cloud/getting-started/welcome',
-                label: 'Centreon Cloud',
+                label: 'Infra Monitoring Cloud',
                 position: 'left',
                 activeBaseRegex: '/cloud/',
               },
@@ -392,6 +421,19 @@ const config = {
             ];
           }
 
+          if (logmanagement) {
+            items = [
+              ...items,
+              {
+                to: '/logmanagement/getting-started/welcome',
+                label: 'Centreon Log Management BETA',
+                position: 'left',
+                activeBaseRegex: '/logmanagement/',
+              },
+            ];
+          }
+
+
           return [
             {
               type: 'search',

i18n/en/docusaurus-theme-classic/navbar.json

@@ -1,10 +1,10 @@
 {
-  "item.label.Centreon OnPrem": {
-    "message": "Centreon OnPrem",
+  "item.label.Infra Monitoring OnPrem": {
+    "message": "Infra Monitoring OnPrem",
     "description": "Navbar item with label Centreon OnPrem"
   },
-  "item.label.Centreon Cloud": {
-    "message": "Centreon Cloud",
+  "item.label.Infra Monitoring Cloud": {
+    "message": "Infra Monitoring Cloud",
     "description": "Navbar item with label Centreon Cloud"
   },
   "item.label.Monitoring Connectors": {

i18n/fr/docusaurus-plugin-content-docs-logmanagement/current.json

@@ -0,0 +1,34 @@
+{
+  "version.label": {
+    "message": "Next",
+    "description": "The label for version current"
+  },
+    "sidebar.logmanagement.category.Getting started with Centreon Log Management": {
+    "message": "Démarrer avec Centreon Log Management",
+    "description": "The label for category Getting started with Centreon Log Management in sidebar logmanagement"
+  },
+    "sidebar.logmanagement.category.Managing users": {
+    "message": "Gérer les utilisateurs",
+    "description": "The label for category Managing users in sidebar logmanagement"
+  },
+    "sidebar.logmanagement.category.Sending logs to CLM": {
+    "message": "Envoyer des logs à CLM",
+    "description": "The label for category Sending logs to CLM in sidebar logmanagement"
+  },
+    "sidebar.logmanagement.category.Exploring and analyzing logs": {
+    "message": "Explorer et analyser les logs",
+    "description": "The label for category Exploring and analyzing logs in sidebar logmanagement"
+  },
+    "sidebar.logmanagement.category.Managing alerts": {
+    "message": "Gérer les alertes",
+    "description": "The label for category Managing alerts in sidebar logmanagement"
+  },
+    "sidebar.logmanagement.category.Administration": {
+    "message": "Administration",
+    "description": "The label for category Administration in sidebar logmanagement"
+  },
+    "sidebar.logmanagement.category.Resources": {
+    "message": "Ressources",
+    "description": "The label for category Resources in sidebar logmanagement"
+  }
+}

i18n/fr/docusaurus-plugin-content-docs-logmanagement/current/administration/storage-usage.md

@@ -0,0 +1,13 @@
+---
+id: storage-usage
+title: Surveiller l’utilisation du stockage
+---
+
+Vous pouvez utiliser la page **Administration > Storage Usage** pour surveiller l'espace de stockage utilisé par votre instance Centreon Log Management.
+
+* Sélectionnez la période souhaitée dans le coin supérieur droit.
+* Passez la souris sur le graphique pour afficher la valeur des points de données.
+
+Dans Centreon Log Management, l'utilisation du stockage est exprimée en mébioctets. 1 Mioctet = 1,048576 Mo.
+
+Pour le programme bêta, l'utilisation totale du stockage est limitée à 150 Go. Au-delà, les logs ne sont plus acceptés par CLM.

i18n/fr/docusaurus-plugin-content-docs-logmanagement/current/administration/tokens.md

@@ -0,0 +1,20 @@
+---
+id: tokens
+title: Gérer les jetons d'authentification
+---
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Chaque hôte a besoin d'un jeton pour s'authentifier auprès de CLM. Ce jeton permet à l'hôte de s'identifier de manière sécurisée lors de l'envoi de données, garantissant ainsi que seuls les hôtes autorisés peuvent se connecter à votre instance CLM et l'utiliser.
+
+## Créer un jeton
+
+1. À la page **Administration > Token management**, cliquez sur **Add**.
+2. Dans la fenêtre qui s'ouvre, entrez un nom (obligatoire) et une description (facultative) pour votre jeton.
+3. Cliquez sur **Generate token**. La fenêtre affiche votre jeton. Elle ne l'affiche qu'une seule fois : stockez-le de manière sécurisée. Si vous fermez la fenêtre, vous ne pourrez plus afficher le jeton.
+
+Vous pouvez supprimer un jeton à l'aide de l'icône **Delete** sur la page **Administration > Token management**. Si vous supprimez un jeton, tous les hôtes qui l'utilisent ne pourront plus s'authentifier auprès de CLM. Par conséquent, les logs envoyés par ces hôtes ne parviendront plus à votre instance CLM jusqu'à ce qu'un nouveau jeton valide soit configuré. La suppression d'un jeton est irréversible.
+
+## Utiliser des jetons dans la configuration de votre collecteur Open Telemetry
+
+Voir [Configurer un collecteur OpenTelemetry](../collector/collector.md).

i18n/fr/docusaurus-plugin-content-docs-logmanagement/current/alerts.md

@@ -0,0 +1,58 @@
+---
+id: alert-events
+title: Définir des règles d'alerte
+---
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+## Des logs aux évènements d'alerte
+
+Les logs ont un [niveau de sévérité](./resources/glossary.md#sévérité) (c'est-à-dire un niveau de log) qui indique la sévérité d'un évènement. Cependant, le niveau de sévérité ne vous renseigne que sur la nature d'un seul log. Un seul log ne suffit pas. Les logs doivent souvent être analysés ensemble.
+
+Par exemple, une entrée de log INFO peut simplement enregistrer qu'un utilisateur a tenté de se connecter. Mais si vous constatez 300 tentatives de connexion (et donc 300 entrées INFO) en 10 secondes, cela suggère un problème.
+
+Pour détecter ce type de problème, vous devez créer des règles d'alerte.
+
+Une règle d'alerte évalue des critères spécifiques et génère des [évènements d'alerte](./resources/glossary.md#évènement-dalertestatut-dalerte), chacun avec un [statut d'alerte](#statuts-dalerte). Par exemple, une règle d'alerte peut être décrite comme suit :
+"Si cette requête renvoie plus de 50 résultats au cours des 5 dernières minutes, un évènement d'alerte avec le statut CRITIQUE doit être enregistré."
+
+* type d'alerte : count
+* fréquence : 5 minutes
+* conditions d'alerte : si > 50, alors statut d'alerte = CRITICAL
+
+![image](./assets/alert_rule.png)
+
+### Statuts d'alerte
+
+Les différents statuts d'alerte possibles sont les suivants :
+
+* <span style={{color:'#ff4a4a'}}>**CRITICAL**</span>
+* <span style={{color:'#fd9b27'}}>**ERROR**</span>
+* <span style={{color:'#ffca34'}}>**WARNING**</span>
+* <span style={{color:'#88b917'}}>**OK**</span>
+* <span style={{color:'#bcbdc0'}}>**UNKNOWN**</span>
+
+## Définir une règle d'alerte
+
+> Pour le programme BETA, vous pouvez créer jusqu'à 20 règles d'alerte.
+
+1. Allez à la page **Alerts & notifications > Alert rules**.
+2. Cliquez sur **Add**.
+3. Dans la fenêtre qui s'affiche, entrez un nom et une description pour votre règle d'alerte, puis définissez les critères souhaités.
+   * **Alert type**: 
+      * **Count** signifie que la requête renverra le nombre d'entrées de log correspondant à la requête.
+      * **Ratio** signifie que vous divisez les résultats d'une requête par les résultats d'une autre requête.
+   * **Frequency**: ce champ définit à la fois la fréquence des contrôles et la période couverte par chaque contrôle. Par exemple, si vous sélectionnez **Every 5 minutes**, un contrôle sera effectué toutes les 5 minutes sur les données des 5 dernières minutes.
+   * **Query**: utilisez la [syntaxe de requête](query-syntax.md) correcte.
+   * **Conditions**: définit quel [statut d'alerte l'évènement d'alerte doit avoir](#statuts-dalerte).
+4. Enregistrez votre règle d'alerte. La fenêtre se ferme et votre règle d'alerte apparaît dans la liste des règles d'alerte. La règle commence à être évaluée et à générer des évènements d'alerte.
+
+## Afficher tous les évènements d'alerte
+
+Allez à la page **Alerts & notifications > Alert events**. Utilisez la barre de recherche et son bouton de filtre pour trouver les évènements d'alerte désirés.
+
+![image](./assets/alert_events.png)
+
+Vous pouvez développer chaque évènement d'alerte pour afficher plus d'informations à son sujet. Passez la souris sur le graphique pour afficher les dates de début et de fin.
+
+![image](./assets/alert_events_detail.png)