canopsis Documentation

Transcription

1 canopsis Documentation Release capensis September 04, 2015

2

3 Contents 1 Connectors s guide Spécifications connecteur Canopsis Interconnexion FLUX Interconnexion Fichiers Interconnexion BDD Interconnexion CLI Mapping des attributs Conclusion i

4 ii

5 CHAPTER 1 Connectors s guide 1.1 Spécifications connecteur Canopsis Ce document permet de spécifier techniquement les différentes possibilités d interconnexion entre une application et l outil Canopsis. Pour ce faire, il vous est demandé de saisir certaines informations de la manière suivante : Onglet Description Onglet Interconnexion pour le type sélectionné Onglet Mapping Onglet Conclusion Application ciblée Version Type d interconnexion possible Cochez pour selectionner Flux Fichiers BDD CLI AMQP API Trap SNMP Log Si le type d interconnexion possible n est pas listé, vous devez le spécifier. Excel/CSV Oracle SQL Server MySql Send_Event Une fois ce type renseigné, RDV sur l onglet correspondant au type d interconnexion pour saisir de plus amples informations 1.2 Interconnexion FLUX Cet onglet permet de définir techniquement la méthode d interconnexion via des mécanismes de flux Description du type de connecteur Ce type d interconnexion permet de publier un événement dans le bus AMQP par l intermédiaire d un lien direct ou via une API applicative Type d application Choisir un type d application parmi les 4 présents sur le schéma 1

6 1.2.1 Renseignements sur les sources : Application qui appelle un WS API Documentation de l API Canopsis - Authentification - Canopsis Publication d un événement Web Renseignements sur les sources : Application qui propose un WS API Applicative Documentation de l API nécessaire Méthode d authentification Décrire le process ainsi que les requêtes d authentification Méthode de sélection des événements Décrire le process ainsi que les requêtes de sélection des événements sur l API Renseignements sur les sources : Application Custom Bindings dans différents langages Canopsis propose des échantillons de code pour publier des événements dans Canopsis d PHP Perl Python Event-with-Perl Event-with-Python Renseignements sur les sources : Superviseurs Nagios/Shinken Superviseur S agit-il de Nagios ou Shinken? Version superviseur 2 Chapter 1. Connectors s guide

7 1.2.5 Matrice des flux Source Destination Protocole Ports Remarques Application Webserver Canopsis HTTP(s) 80,443 Application Bus Canopsis AMQP 5672 Connecteur Application HTTP(s) 80,443 Connecteur Webserver Canopsis HTTP(s) 80,443 Connecteur Bus Canopsis AMQP Interconnexion Fichiers Cet onglet permet de définir techniquement la méthode d interconnexion via des Logs et Trap SNMP Description du type de connecteur Ce type d interconnexion permet de publier un événement dans le bus AMQP par l intermédiaire d un connecteur qui réceptionne des fichiers de logs ainsi que des Trap SNMP Type d application Choisir un type d application parmi ceux proposés sur le schéma Renseignements sur les sources : Logs Nom des fichiers de Log Liste des Logs + Emplacement FS Format des fichiers de Logs Décrire le format des fichiers de logs à utiliser Agent de transmission de fichier Quel agent peut-être utilisé? rsyslog, nxlog, snare, autre 1.3. Interconnexion Fichiers 3

8 1.3.2 Renseignements sur les sources : Traps SNMP Nom des fichiers MIB MIB contenant les Trap SNMP à intercepter Nom des objets de type Dans la MIB, quels sont les objets à NOTIFICATION-TYPE ou TRAP- intercepter? TYPE Version SNMP / Communauté Informations administratives SNMP SNMP / Auth SNMP Matrice des flux Source Destination Protocole Ports Remarques Connecteur Logstash Bus Canopsis AMQP 5672 Connecteur Logstash Bus Canopsis HTTP(s) 5672 Application Connecteur Logstash TCP 5140 Application Connecteur Logstash Trap SNMP (UDP) Interconnexion BDD Cet onglet permet de définir techniquement la méthode d interconnexion via des mécanismes de sélection de données en base Description du type de connecteur Ce type d interconnexion permet de publier un événement dans le bus AMQP par l intermédiaire d un connecteur qui effectue des sélections en base de données. 4 Chapter 1. Connectors s guide

9 1.4.1 Renseignements sur les sources : Fichier Excel / CSV Nom du fichier Nom du fichier + emplacement Format du Décrire le découpage du fichier fichier Mise à disposition Quelles sont les méthodes de mise à disposition du fichier? Copie, Partage réseau, FTP, Autre Renseignements sur les sources : Base de données Technologie S agit-il d une base de données de type : Oracle, SQL Server, MySQL Version Nom de la base de Nom de la base de données/instance données Port du listener Fonction du type de base de données Compte d authentification Tables concernées Exemples de requêtes L ensemble des requêtes finales est à positionner dans l onglet mapping pour chaque attribut Commentaires Matrice des flux Source Destination Protocole Ports Remarques Connecteur EDC Application Listener de BDD Fonction de la BDD Connecteur EDC Bus Canopsis AMQP Interconnexion CLI Cet onglet permet de définir techniquement la méthode d interconnexion via la ligne de commande Description du type de connecteur Ce type d interconnexion permet de publier un événement dans le bus AMQP par l intermédiaire de l API REST de Canopsis 1.5. Interconnexion CLI 5

10 1.5.1 Renseignements sur les sources : Fichier Excel / CSV Scripts Canopsis met à disposition 2 scripts d émission d événements Canopsis compatibles Windows et Unix Matrice des flux Source Destination Protocole Ports Remarques Application Webserver Canopsis HTTP(s) Prévoir une ouverture de flux par poller nagios 1.6 Mapping des attributs L idée de cet onglet est de faire correspondre les attributs de l application que vous souhaitez interconnecter avec les attributs Canopsis 6 Chapter 1. Connectors s guide

11 1.6. Mapping des attributs 7

12 1.6.1 Matrice des flux Attribut Canopsis Explications Obligatoire? Attribut applicatif correspondant _id event_id connector : Connector type (gelf, nagios, snmp,...) connector_name : Connector name (nagios1, nagios2...) event_type: Event type (check, log, trap,...) source_type : Source type ( component or resource ) component : Component name resource : Ressource name timestamp : UNIX seconds timestamp (UTC) state : State (0 (Ok), 1 (Warning), 2 (Critical), 3 (Unknown)) Réservé Réservé Type de connecteur gelf, nagios, snmp, etc. Nom du connecteur Valeur libre Type d événement check, log, trap Type de source component ou resource Nom du composant Nom de la ressource Timestamp au format UNIX Epoch Etat 0 -> OK 1 -> WARNING 2 - > CRITICAL 3 -> UNKNOWN X X X X X X si source type = resource X si event_type = check Exemple concrèt Fichier de log, requête SQL, Appel web service, Format de log, etc. state_type : State type (O (Soft), 1 (Hard)) Type d état 0 -> Soft 1 -> Hard scheduled : (optional) Réservé True if this is a scheduled event last_state_change Réservé : (reserved) Last timestamp after state change previous_state : (reserved) Réservé Previous state (after change) output : Event message Message de l événement long_output : Event Message Long de long message l événement tags : Event Tags (default: Tags []) display_name : The Nom sympathique name to display (cus- purpose) 8tomization Chapter 1. Connectors s guide

13 1.7 Conclusion L idée de cet onglet est de conclure quant à la faisabilité de l interconnexion entre l applicatif ciblé et l outil Canopsis Questions Réponses Commentaires / Justifications Application / Version Interconnectable par un mécanisme standard Interconnectable par un mécanisme via un développement complémentaire Mapping complet? Non interconnectable 1.7. Conclusion 9