From 80bd07b731f457fa20c8c9243d53981b32219121 Mon Sep 17 00:00:00 2001 From: raulmateos Date: Wed, 13 Sep 2006 15:48:45 +0000 Subject: [PATCH] 2006-09-13 Raul Mateos * New pandora_doc/en/images/ files * Updated pandora_doc/en/pandora_chapter 1 to 9.xml git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@169 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f --- pandora_doc/ChangeLog | 4 +- pandora_doc/en/images/b_blue.gif | Bin 0 -> 372 bytes pandora_doc/en/images/b_down.gif | Bin 0 -> 182 bytes pandora_doc/en/images/b_green.gif | Bin 0 -> 345 bytes pandora_doc/en/images/b_red.gif | Bin 0 -> 345 bytes pandora_doc/en/images/b_white.gif | Bin 0 -> 375 bytes pandora_doc/en/images/b_yellow.gif | Bin 0 -> 354 bytes pandora_doc/en/images/cancel.gif | Bin 0 -> 529 bytes pandora_doc/en/images/config.gif | Bin 0 -> 561 bytes pandora_doc/en/images/data_d.gif | Bin 0 -> 256 bytes pandora_doc/en/images/data_m.gif | Bin 0 -> 279 bytes pandora_doc/en/images/data_w.gif | Bin 0 -> 282 bytes pandora_doc/en/images/dot_blue.gif | Bin 0 -> 223 bytes pandora_doc/en/images/dot_down.gif | Bin 0 -> 172 bytes pandora_doc/en/images/dot_green.gif | Bin 0 -> 200 bytes pandora_doc/en/images/dot_red.gif | Bin 0 -> 200 bytes pandora_doc/en/images/dot_white.gif | Bin 0 -> 196 bytes pandora_doc/en/images/dot_yellow.gif | Bin 0 -> 223 bytes pandora_doc/en/images/grafica_d.gif | Bin 0 -> 144 bytes pandora_doc/en/images/grafica_h.gif | Bin 0 -> 145 bytes pandora_doc/en/images/grafica_m.gif | Bin 0 -> 145 bytes pandora_doc/en/images/grafica_w.gif | Bin 0 -> 147 bytes pandora_doc/en/pandora_chapter1.xml | 7 +- pandora_doc/en/pandora_chapter2.xml | 55 +-- pandora_doc/en/pandora_chapter3.xml | 589 +++++++++++++++------------ pandora_doc/en/pandora_chapter4.xml | 100 +++-- pandora_doc/en/pandora_chapter5.xml | 14 +- pandora_doc/en/pandora_chapter6.xml | 4 +- pandora_doc/en/pandora_chapter7.xml | 2 +- pandora_doc/en/pandora_chapter8.xml | 118 ++++-- pandora_doc/en/pandora_chapter9.xml | 53 ++- 31 files changed, 556 insertions(+), 390 deletions(-) create mode 100644 pandora_doc/en/images/b_blue.gif create mode 100644 pandora_doc/en/images/b_down.gif create mode 100644 pandora_doc/en/images/b_green.gif create mode 100644 pandora_doc/en/images/b_red.gif create mode 100644 pandora_doc/en/images/b_white.gif create mode 100644 pandora_doc/en/images/b_yellow.gif create mode 100644 pandora_doc/en/images/cancel.gif create mode 100644 pandora_doc/en/images/config.gif create mode 100644 pandora_doc/en/images/data_d.gif create mode 100644 pandora_doc/en/images/data_m.gif create mode 100644 pandora_doc/en/images/data_w.gif create mode 100644 pandora_doc/en/images/dot_blue.gif create mode 100644 pandora_doc/en/images/dot_down.gif create mode 100644 pandora_doc/en/images/dot_green.gif create mode 100644 pandora_doc/en/images/dot_red.gif create mode 100644 pandora_doc/en/images/dot_white.gif create mode 100644 pandora_doc/en/images/dot_yellow.gif create mode 100644 pandora_doc/en/images/grafica_d.gif create mode 100644 pandora_doc/en/images/grafica_h.gif create mode 100644 pandora_doc/en/images/grafica_m.gif create mode 100644 pandora_doc/en/images/grafica_w.gif diff --git a/pandora_doc/ChangeLog b/pandora_doc/ChangeLog index 87c818192b..b88b220ad4 100644 --- a/pandora_doc/ChangeLog +++ b/pandora_doc/ChangeLog @@ -1,8 +1,8 @@ 2006-09-13 Raul Mateos - * New /en/images/esquema.png file + * New /en/images/ files - * Updated /en/pandora_chapter1.xml + * Updated /en/pandora_chapter 1 to 9.xml 2006-09-12 Raul Mateos diff --git a/pandora_doc/en/images/b_blue.gif b/pandora_doc/en/images/b_blue.gif new file mode 100644 index 0000000000000000000000000000000000000000..aef45ab000197120acf82e95305b3ffb3cec85a8 GIT binary patch literal 372 zcmZ?wbhEHb6krfwSgOqc1m==Sp4z28y5;_cRl%mUq2~2bwk@&tZShVW$?n~0UVXI@ zZ0X+p8NL&;{3aHLP47!#uTGr5sEDI6V@Z4dijKlny=80rD%S02;+jykVN%V;sr8$u zHEx;Fylrmh&iUQDFHYfE(7R_*|K24N_bs1#aMjGi8|EM1y7csu!`07Eb^WIdDEC!0GwB`+5i9m literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/b_down.gif b/pandora_doc/en/images/b_down.gif new file mode 100644 index 0000000000000000000000000000000000000000..fa8736b7b8cfc1ec4f60dcaee823343d64d2e821 GIT binary patch literal 182 zcmV;n07?HxNk%w1VGsZi0E8a^|0gH=F){m2PUc-)`Bzr@SXld6S^QdB>tkZuZEW9% zh4zAi)sc|*gM!nOk@$my=aiK0oSV_DtJAQr@295Kx3_g6kEzi&J=9@5s13kaBq{>H176W`x5r@ChUte*F)ZsD({rN27X z{_bD@XUdMha}WPp^Pd!;_>+Z^i@}~j2jmlwpBUK64$Lp$&=70)P->p?ONGHxY5CKv zwSH0=LKiajCae$3D!Cx!t#wT)lyjYx_W%F@ literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/b_red.gif b/pandora_doc/en/images/b_red.gif new file mode 100644 index 0000000000000000000000000000000000000000..6d957afe32f20bf915e8e1c87a9d888e68755cb6 GIT binary patch literal 345 zcmZ?wbhEHb6krfwSZc%o1pUm+eJm`igoM@$3-1sRILghvMojD?JNqLBhAko@FBlk3 z^YVURVEDnn@RgbQ9|OaGM#lfFtbaKaTBUsS~L-`4iOxA#9kza33n z{~{v(#l-xLjs2I9@GmLpUsl%N?CgtEc>Wa>{3|K>S6BDHvGIR%^Z)kt|NZ^{r%wGh zZ{EKZE1n##{=a$a^HW{_i3W;4Ss1w(>=|@GJ^}fOfvxPo`~nUQv33uoY&#-EZ*ye5Pi?#C@LQU;fhoDE&q0>z% zz&3 literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/b_yellow.gif b/pandora_doc/en/images/b_yellow.gif new file mode 100644 index 0000000000000000000000000000000000000000..ff3e7557760898cada033b25cdebe866dedc207b GIT binary patch literal 354 zcma*i%`1Ze90%~Y^>%iG?tnZ{^2kb^dw%|VgFawEw_v8yfNpd1t_PGoY} zM7AtDSZ!8hl(Zx%t+s}g9HdtOf-J1u=7KNx;khNm8C zDNRZzlFTP|X3S>wvTM9AYO}NMfLy&49@I|_3kz41Hcw{P7#eMJ4%9oQ(~czXY;Lud zXQV~tmS?10S=m_Q6A4Wgt3|D9;C+6*$!yZ;;|90eU@ W;Kbp`!J(9m1?ear37xy`)cp&Z*`$O3 literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/cancel.gif b/pandora_doc/en/images/cancel.gif new file mode 100644 index 0000000000000000000000000000000000000000..5fb77f777d857c5775248825273818652e1933d3 GIT binary patch literal 529 zcmZ?wbhEHb3>viHYC=N}2q-x6KEq_}-b_4u6Xe!4jGTv7UuWVg?0o}bda zUS$VeD#^T6n0BT-_hw=K`yBr>)V!C-u4Cs$$;M zC%!dDjtoyM+=EHWi?K=*C*`c&^*P*w2wD0UJ|FK8q$evBR_nzFl=gi){r#>9i zKDuwykNv7Y4yx@xaQxtb6UPspKXUZav7={?9=mkx*yZELuADf2`P9iPr%qixd-D2^ zD~9LK-@16=`i*P%@7#WJ_x9rl_nzLr|NQ@;0gC@bor_WvOHxx5$}>wc6hbmm72G|2 z0~i#4vM_Qn)HCQX00Ahn7}!f2>gyf6>wTI!Iy*d@9J@NqJ1m;)`s+muy6mU%ILoAk)W~2B01P}>)&Kwi literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/data_d.gif b/pandora_doc/en/images/data_d.gif new file mode 100644 index 0000000000000000000000000000000000000000..1378102f6146ba0ec6628c95d144c2cad2fa9434 GIT binary patch literal 256 zcmZ?wbhEHb6krfwXpvz60uBZS2?2pCYHD+)%(*&6V9lB}Th?p=g1uYzo;|zw>e(%4 zLE!4yt5@G$ZT@z(`QFv5_paUpf_KlZetUNI8<70=?Ay0*|G(V>690h+3Fv@q0NKUB z+M1xyr)0piLeul|#=W-{PWK4-_#`LTsC_mP=_`EklkGs`%76xgxvY^71$jg?CLUEy z-grVUE|no@VTSSa)8V!p4C_Q&S!L$2GYYXKU!Q%^hmW_~t%XO)!m7nqibsQkeL~fw pswOt2%H}ScHuI?x;e(%4 zLE!4yt5?5WZN7K)>bxbHc@i{fkcBclgPB} zB9nJEjmA7m7FJC*k~|t5?0sbu%IevaN*g+wTPKT)&1hlde(%4 zLE!4yt5@G$ZT@z(`QFv5_paUpf_KlZetUNI8<70=?Ay0*|G(V>690h+2`K&(buLOx zEJ;mKD9@0jjyu5R%EaS0C*FF&Hw-a literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/dot_blue.gif b/pandora_doc/en/images/dot_blue.gif new file mode 100644 index 0000000000000000000000000000000000000000..bd04ea304593d3b6a72488cfc9d4920fb375832d GIT binary patch literal 223 zcmZ?wbhEHbS7pt6@AjN&6CCEZUGX2 literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/dot_down.gif b/pandora_doc/en/images/dot_down.gif new file mode 100644 index 0000000000000000000000000000000000000000..1ac77f133c4cf0f1b9ba541b318f41860af86cce GIT binary patch literal 172 zcmV;d08{@*Nk%w1VF~~W0E8a^|0gH=F){m2PUc-)`Bzr@SXld6S^QdB>tkZuZEW9% zh4zAi)sc|*gM!nOk@$my=aiK0oSV_DtJAQr@295Kx32mm|zzE)-c literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/dot_green.gif b/pandora_doc/en/images/dot_green.gif new file mode 100644 index 0000000000000000000000000000000000000000..e3b94776e57b392da55b808b37a5466a407a2e08 GIT binary patch literal 200 zcmZ?wbhEHbogDOH4U00xEGiIC}Pst!n`L@6>sxr->hAG zdGf($TmFNA;!hSvE(Uo99R?r(*~!4_`rv!+l*EA97EFx+GhVXE$V^k{a%79y?%2(~ zSmnS3DZZ0Sk~CBlPIx>G(o_`dJE4+n$S1<@sk+#(kE7@0(%C{2mrN_;V6X-N3o}n2 literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/dot_red.gif b/pandora_doc/en/images/dot_red.gif new file mode 100644 index 0000000000000000000000000000000000000000..72dda6743ae3bc68b854cb8c2f8d9775cb4d0de8 GIT binary patch literal 200 zcmV;(05|_fNk%w1VF~~W0E8a^g&!Y@At9VFE~h;;us$}cL^-)WHL*uY(ndJXO+(sJ zK-^S9-d#-EVou^=Ox$K#;$=|gZ(QeeUE+Ll>w#(Of@$r9YvP%h^O=F~pNI9Ih3u=S z>b}4GyrKH+>i_@$A^8LW3IHDfEC2ui015yK000F=;P-8lVN9Di0)ar7=>{C!l^}{i z2AsD&3rM3RxR4kQNyTCyBp%3!1!E~87LEu-lQ9ky5Q#<8F^&q23Z|P9k))Y+2mm|O C&r^~B literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/dot_white.gif b/pandora_doc/en/images/dot_white.gif new file mode 100644 index 0000000000000000000000000000000000000000..2632d652c9e4fd5c93d6f13a833cbbb0e155527b GIT binary patch literal 196 zcmZ?wbhEHbs^Wx2$m+#)a`ts$|e{4YU zCkrDNgFJ%{0}z1hWMFlC@I7);qQ^7~rpAC7D_Ld4rz&(gvWcfzcC#&3SujC@*JDYD lhs6YbPS+qO7J0!_M=SzVmWn>^IB+5_SShHaiI0)N8UUZGa2Ego literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/dot_yellow.gif b/pandora_doc/en/images/dot_yellow.gif new file mode 100644 index 0000000000000000000000000000000000000000..5a9913641f8ffd2b6bbcdd436466db323ca9ba69 GIT binary patch literal 223 zcmV<503iQINk%w1VF~~W0E8X@t#JpkbO^+V6wR3%(UddMp&!_w8sw)I^0zAYydD3^ zCI8AP`^iK9%`^PaHviH$|I<7D(qI4AOZ3r<|JzOf;$8paU;N&j_1(As>wEw1egE%) z|M{W)_~-xs|NsC0A^sCXa%Ev;Zy;lDZXi@>WgtgMO;7+K`2+z903QG>000003IGZK z00l+h_g&F(M3*=Mfnb>F1rXSTB+5YsSa&fCh@&K!kQxt4#d0tp7)XgFV<{yT4@qUC ZF%A?Eie<&(&(%{EpIe)Mn$8}Tbf8wPYFhR##vsR%C@$qsg$3r0FZLW<5Wo<}!0dQ1 XVT%HL%cFN1DrVXZYs{)U85pbq`UO3- literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/grafica_h.gif b/pandora_doc/en/images/grafica_h.gif new file mode 100644 index 0000000000000000000000000000000000000000..26e0c6dc9f3bb26c88d338826d77cefd3809dbca GIT binary patch literal 145 zcmZ?wbhEHbEOo0HcgK(*OVf literal 0 HcmV?d00001 diff --git a/pandora_doc/en/images/grafica_w.gif b/pandora_doc/en/images/grafica_w.gif new file mode 100644 index 0000000000000000000000000000000000000000..0db3c339cd5722fec4c403cdab7571d573c30d61 GIT binary patch literal 147 zcmZ?wbhEHb - + + Introduction - + What is Pandora? Pandora is a monitoring tool that allows a system administrator @@ -87,7 +88,7 @@ in virtually any language, given its simple API and being open source. - + Pandora Administration diff --git a/pandora_doc/en/pandora_chapter2.xml b/pandora_doc/en/pandora_chapter2.xml index 177487e034..ba6a14f793 100644 --- a/pandora_doc/en/pandora_chapter2.xml +++ b/pandora_doc/en/pandora_chapter2.xml @@ -1,6 +1,7 @@ - + + Users @@ -39,7 +40,7 @@ incidents, manage database or other. - + Profile manager @@ -75,7 +76,7 @@ - To create a new profile click on "Manage Profiles" -> + To create a new profile click on "Manage Profiles"> "Create Profile" in the Administration Menu @@ -118,7 +119,7 @@ - + Adding a user @@ -147,23 +148,23 @@ - A user profile is deleted by clicking on the delete icon -  on the right - hand side of the profile. + A user profile is deleted by clicking on the delete icon + on the right + hand side of the profile. - + Deleting a user - A user is deleted by clicking on the delete icon  on the right hand side + A user is deleted by clicking on the delete icon on the right hand side of the user. The list of users is accessed through the "Manage Users" option in the Administration menu. - + Statistics The user activity statistics show a graph with the @@ -172,24 +173,24 @@ user usually reflects the user's activity. - Click on "View Users" -> "Statistics" in the Operation + Click on "View Users">"Statistics" in the Operation menu to show this graph: - - Messages to users - - To create a new message to other user, go to "Messages" - section in the Operation menu. You can also read the - received messages, but the sent messages are not stored. - - - Messages to groups - - From "Messages" -> "Messages to groups" section in the - Operation menu you can send messages to groups of users. - The sent messages will not be stores. - - + + Messages to users + + To create a new message to other user, go to "Messages" + section in the Operation menu. You can also read the + received messages, but the sent messages are not stored. + + + Messages to groups + + From "Messages">"Messages to groups" section in the + Operation menu you can send messages to groups of users. + The sent messages will not be stores. + + \ No newline at end of file diff --git a/pandora_doc/en/pandora_chapter3.xml b/pandora_doc/en/pandora_chapter3.xml index f5548dc7ec..0d94242b8a 100644 --- a/pandora_doc/en/pandora_chapter3.xml +++ b/pandora_doc/en/pandora_chapter3.xml @@ -1,6 +1,7 @@ - + + Agents The agents collect information. The public key @@ -33,7 +34,7 @@ - + Group Manager Groups are added in "Manage Profiles" > "Manage Groups", @@ -73,10 +74,10 @@ A group is added by clicking "Create group" and assigning a name to it. A group is deleted by clicking the delete icon - + in the right hand side of each group. - + Adding an agent Before an agent is added, the public key of the @@ -162,7 +163,7 @@ - + Assigning modules Pandora's agents use the operating system own commands to @@ -247,12 +248,12 @@ - Deleted by clicking + Deleted by clicking - Edited by clicking + Edited by clicking @@ -261,145 +262,198 @@ However, the type of data of the module can't be modified. - - Alerts + + Alerts - - An alert is Pandora's reaction to an out of range module - value. The Alert can consist in sending and e-mail or SMS to - the administrator, sending a SNMP trap, write the incident - into the system syslog or Pandora log file, etc. And basically - anything that can be triggered by a script configured in - Pandora's Operating System. - - - Adding an Alert + + An alert is Pandora's reaction to an out of range module + value. The Alert can consist in sending and e-mail or SMS to + the administrator, sending a SNMP trap, write the incident + into the system syslog or Pandora log file, etc. And basically + anything that can be triggered by a script configured in + Pandora's Operating System. + + + Adding an Alert - - The existing Alerts are accessed by clicking on the "Manage - Alerts" option, Administration menu. - - There are 6 default types of Alerts: + + The existing Alerts are accessed by clicking on the "Manage + Alerts" option, Administration menu. + + There are 6 default types of Alerts: - - - - eMail. Sends an e-mail from Pandora's Server - - - - - Internal audit. Writes the incident - in Pandora's internal audit system - - - - LogFile. Writes the incident in the log file - - - SMS Text. Sends an SMS to a given mobile phone - - - SNMP Trap. Sends a SNMP Trap - - - Syslog. Sends an alert to the Syslog - - + + + + eMail. Sends an e-mail from Pandora's Server + + + + + Internal audit. Writes the incident + in Pandora's internal audit system + + + + LogFile. Writes the incident in the log file + + + SMS Text. Sends an SMS to a given mobile phone + + + SNMP Trap. Sends a SNMP Trap + + + Syslog. Sends an alert to the Syslog + + - + - An Alert is deleted by clicking on the delete icon placed on the right hand side of the Alert. A new customised Alert can be created clicking in "Create Alert". + + An Alert is deleted by clicking on the delete icon + + placed on the right hand side of the Alert. + A new customised Alert can be created clicking in "Create Alert". + - The values "_field1_", "_field2_" and "_field3_" in the customised Alerts are used to build the command line that the machine where Pandora resides will execute – if there were several servers, the one in Master mode. + The values "_field1_", "_field2_" and "_field3_" + in the customised Alerts are used to build the command + line that the machine where Pandora resides will execute + - if there were several servers, the one in Master mode. + - + - When a new Alert is created the following field must be filled in: - - - Alert name: The name of the Alert - - - Command: Command the Alert will trigger - - - Description: Description of the Alert - - + When a new Alert is created the following field must be filled in: + + + Alert name: The name of the Alert + + + Command: Command the Alert will trigger + + + Description: Description of the Alert + + - In 'Command' data field these variables are used to build the command line that the machine where Pandora resides will execute – if there were several servers, the one in Master mode, replacing at runtime: + + In 'Command' data field these variables are used to build + the command line that the machine where Pandora resides will execute + - if there were several servers, the one in Master mode, + replacing at runtime: + - - - _field1_: Field #1, usually assigned as username, e-mail destination or single identification for this event - - - _field2_: Field #2, usually assigned as short description of events, as subject line in e-mail - - - >_field3_: Field #3, a full text explanation for the event - - - >_agent_: Agent name - - - _timestamp_: A standard representation of date and time. Replaced automatically when the event has been fired - - - _data_: The data value that triggered the alert - - - - - Assigning Alerts + + + _field1_: + Field #1, usually assigned as username, + e-mail destination or single identification for this event + + + + _field2_: + Field #2, usually assigned as short + description of events, as subject line in e-mail + + + + _field3_: + Field #3, a full text explanation + for the event + + + >_agent_: Agent name + + + _timestamp_: + A standard representation of date and time. + Replaced automatically when the event has been fired + + + + _data_: The data value that triggered the alert + + + + + Assigning Alerts - The next step after an Agent has been added, its modules have been configurated and the alerts have been defined, it is time to assign those Alerts to the agent. + + The next step after an Agent has been added, its + modules have been configurated and the alerts have been defined, + it is time to assign those Alerts to the agent. + - This is done by clicking on the Agent to be configured on the "Manage Agents" option, Administration menu. The Alert Assignation form is placed at the bottom of that page. + + This is done by clicking on the Agent to be configured on the + "Manage Agents" option, Administration menu. + The Alert Assignation form is placed at the bottom of that page. + - + - To assign an Alert the next fields must be filled in: + To assign an Alert the next fields must be filled in: - - - Alert type: This can be selected from the list of alerts that have been previously generated. - - - Maximum Value: Defines the maximum value for a module. Any value above that threshold will trigger the Alert. - - - Minimum Value: Defines the minimum value for a module. Any value below that will trigger the Alert. - - - Description: Describes the function of the Alert, and it is useful to identify the Alert amongst the others in the Alert General View. - - - Field #1 (Alias, name): Define the used value for the "_field1_" variable. - - - Field #2 (Single Line): Define the used value for the "_field2_" variable. - - - Field #3 (Full Text): Define the used value for the "_field3_" variable. - - - Time threshold: Minimum duration between the firing of two consecutive alerts, in seconds. - - - Max Alerts Fired: Maximun number of alerts that can be sent consecutively. - - - Assigned module: Module to be motitorized by the alert. - - + + + Alert type: + This can be selected from the list of alerts that have + been previously generated. + + + + Maximum Value: + Defines the maximum value for a module. Any value above that + threshold will trigger the Alert. + + + + Minimum Value: + Defines the minimum value for a module. Any value below that + will trigger the Alert. + + + + Description: + Describes the function of the Alert, and it is useful to identify + the Alert amongst the others in the Alert General View. + + + + Field #1 (Alias, name): + Define the used value for the "_field1_" variable. + + + Field #2 (Single Line): + Define the used value for the "_field2_" variable. + + + Field #3 (Full Text): + Define the used value for the "_field3_" variable. + + + Time threshold: + Minimum duration between the firing of two consecutive alerts, + in seconds. + + + + Max Alerts Fired: + Maximun number of alerts that can be sent consecutively. + + + Assigned module: + Module to be motitorized by the alert. + + - All the alerts of an agent can be seen through "Manage Agents" - in the Adminitration menu and selecting the agent. - + All the alerts of an agent can be seen through "Manage Agents" + in the Adminitration menu and selecting the agent. + - + Agent module and agent's alert management It might happen that the user finds that modules and alerts @@ -436,7 +490,7 @@ deletion is performed, the data associated to them will also be deleted. - + Agents group detail Once you have configured your groups and agents, you can @@ -448,20 +502,20 @@ organized by status. By pressing the icon - + at the right of any group image, you will update the info of that group. - - Agent monitoring + + Agent monitoring When the agents start the data transmission to the server, and it is added in the Web console, Pandora processes and inserts the data in the Database. The data are consolidated and can be accessed from the Web console, either as row data or as graphs. - + Agent view All the Agents can be accessed from the Operation menu. @@ -488,176 +542,189 @@ Status: Shows the "general" status of the agent through the following icons: - - All the monitors OK. It's the ideal status. - - No defined monitors. Sometimes nothing is monitored - that could be right or wrong, and only numeric or - text data is reported. - - At least one of the monitors is failing. Usually we - want to avoid this, and keep our systems in a healthy - green colour. - The agent - doesn't have any data. New agents with an empty data - package can have this status. - Colour - shifting from green to red. This icon indicates - that the agent has just changed its status, from - 'All OK' to 'we have a problem'. - When an agent - is down or there is no news from it for 2 times the Interval - value in seconds. Usually it is due to a communication issue - or a crashed remote system.> - + + All the monitors OK. It's the ideal status. + + + + No defined monitors. Sometimes nothing is monitored + that could be right or wrong, and only numeric or + text data is reported. + + + + At least one of the monitors is failing. Usually we + want to avoid this, and keep our systems in a healthy + green colour. + + + The agent + doesn't have any data. New agents with an empty data + package can have this status. + + + Colour + shifting from green to red. This icon indicates + that the agent has just changed its status, from + 'All OK' to 'we have a problem'. + + + When an agent + is down or there is no news from it for 2 times the Interval + value in seconds. Usually it is due to a communication issue + or a crashed remote system. + Alerts: Shows if any alerts have been sent - through the following icons: + through the following icons: + - + No alerts have been sent. - + + + When at least one alert has been sent within the time threshold of the alert. Last contact: Shows the time and date of the last data package sent by the agent, using a progress bar, according to value of the interval. If you see the image - , + , the agent has not send data during the interval. Passing the mouse over the image will show you the last contact in time and date format. Note: The icon - + is only visible if you're and administrator and it's a link to the "Manage Agents" > "Update Agent" option in the Administration menu. - + Accessing the data of an agent When an agent is accessed, by clicking on its name, all the information related to that agent is displayed. - - Agent general info + + Agent general info - This shows the data introduced when the agent was created - and the total number a data packages the agent has sent. + This shows the data introduced when the agent was created + and the total number a data packages the agent has sent. - + - - Last data received + + Last data received - This is the description of all the agent modules - been monitored. + This is the description of all the agent modules + been monitored. - + - In this list the module information is shown - in the following columns: + In this list the module information is shown + in the following columns: - Module name: Name given to the module - in the agent's config file. - Module type: Type of module as described - in Asigning Modules section. - Description: Description given to the module - in the agent's config file. - Data: Last data sent by the agent. - Graph: Monthly(M), Weekly(W), Daily(D) - and Hourly(H) graphs are generated with - the data sent by the agent against time. + Module name: Name given to the module + in the agent's config file. + Module type: Type of module as described + in Asigning Modules section. + Description: Description given to the module + in the agent's config file. + Data: Last data sent by the agent. + Graph: Monthly(M), Weekly(W), Daily(D) + and Hourly(H) graphs are generated with + the data sent by the agent against time. - On the left hand side of the graph the newst - data is represent, and on the right had side the oldest. + On the left hand side of the graph the newst + data is represent, and on the right had side the oldest. - The generated graphs are: - - Hourly graph - () - covers a 60 minute interval - + The generated graphs are: + - Hourly graph + () + covers a 60 minute interval + - - Daily graph - () - covers a 24 hour interval - + - Daily graph + () + covers a 24 hour interval + - - Weekly graph - () - covers a 7 day interval - + - Weekly graph + () + covers a 7 day interval + - - Mothly graph - () - covers a 30 day interval - + - Mothly graph + () + covers a 30 day interval + - Raw Data: This is the raw data sent by the agent + Raw Data: This is the raw data sent by the agent - - Last month - - Last week - - Last day + - Last month + - Last week + - Last day - - Complete list of monitors + + Complete list of monitors - This is the description of all the monitors defined by - the agent + This is the description of all the monitors defined by + the agent - + - The list shows the information about the monitors in the - following columns: + The list shows the information about the monitors in the + following columns: - Agent: Agent where the monitor is defined. - Type: Data type of the monitor. For a monitor this - value is always of the generic_proc type. - Module name: Name given to the module when it was - created. - Description: Description given to the module - in the agent's config file. - Status: The table shows the agent status through - the following icons: + Agent: Agent where the monitor is defined. + Type: Data type of the monitor. For a monitor this + value is always of the generic_proc type. + Module name: Name given to the module when it was + created. + Description: Description given to the module + in the agent's config file. + Status: The table shows the agent status through + the following icons: - - The monitor is OK - - The monitor is failing + + The monitor is OK + + The monitor is failing - Last contact: Shows the time and date of - the last data packaged received from the agent + Last contact: Shows the time and date of + the last data packaged received from the agent - - Complete list of alerts + + Complete list of alerts - This is the description of all the alarms defined - in the agent + This is the description of all the alarms defined + in the agent - + - The monitor information is shown in the list - divided in the following fields: + The monitor information is shown in the list + divided in the following fields: - ID: Agent were the alert has been defined. - Type: Type of alert. - Description: Description given to the alert when - it was created. - Last fired: The last time the alert was - executed. - Times Fired: Number of times the alert was - launched. - Status: Shows if the alert has been sent through - the following icon: + ID: Agent were the alert has been defined. + Type: Type of alert. + Description: Description given to the alert when + it was created. + Last fired: The last time the alert was + executed. + Times Fired: Number of times the alert was + launched. + Status: Shows if the alert has been sent through + the following icon: - No alerts - have been sent - At least - one alert has been sent + No alerts + have been sent + At least + one alert has been sent - + Group details The groups configured in Pandora can be @@ -677,21 +744,21 @@ Status: The status is described through the following icons: - + All monitors are OK. - + At least one monitor has failed. - + At least one monitor is down and there is no contact with it. - + This Agent doesn't have any monitor defined. OK: Number of monitors that are OK. Failed: Number of failing monitors. Down: Number of down monitors. - + Monitors view The description of all the monitors defined in the server @@ -704,7 +771,7 @@ in the individual view, but now they are shown all together. This allows a deeper analisys of each monitor. - + Alert details The description of all the alerts defined in the server @@ -717,7 +784,7 @@ as in the individual view, but now they are shown all together. This allows a deeper analisys of each alert. - + Data Export The Data Export tool can be found in the "View Agents">" @@ -745,7 +812,7 @@ - + Statistics Two kinds of graphical statistics are displayed from the @@ -767,10 +834,10 @@ - + SNMP Console - + SNMP Alerts diff --git a/pandora_doc/en/pandora_chapter4.xml b/pandora_doc/en/pandora_chapter4.xml index b1765251f7..e46224b6ef 100644 --- a/pandora_doc/en/pandora_chapter4.xml +++ b/pandora_doc/en/pandora_chapter4.xml @@ -1,6 +1,6 @@ - + Incident management @@ -75,40 +75,41 @@ Status: The incident status is represented by the following icons: - Active incident - Active incident + Active incident + Active incident with comments - Rejected incident - Closed incident - Expired incident + Rejected incident + Closed incident + Expired incident Incident name: Name given to the incident Priority: The incident assigned priority is represented by the following icons: - - - + + + Very high priority - - - + + + High priority - - - + + + Medium priority - - - + + + Low priority - - - + + + Informative priority - - - Maintenance priority + + + + Maintenance priority Group: The name of the group the incident has been assigned to. One incident can only belong to a single group. @@ -124,7 +125,7 @@ from one user to another. The incident can be assigned to another user by its owner, or by a user with management privileges over the group the incidents belong to. - + Adding an incident The creation of incidents is performed by clicking on @@ -136,7 +137,7 @@ fields to define the incident. The process is completed by clicking on the "Create" button. - + Incident follow up All the open incidents can be followed up. The tool is reached by @@ -174,41 +175,57 @@ The indicent is updated by clicking on the "Update incident" button. - + Adding comments to an incident - Comments about the incident can added clicking on "Add note". This will open up a screen with a text box in it. + Comments about the incident can added clicking on "Add note". + This will open up a screen with a text box in it. + - The comment is written in this box. The Comment will appear in the "Notes attached to incident" section after the button "Add" is pressed. + The comment is written in this box. + The Comment will appear in the "Notes attached to incident" + section after the button "Add" is pressed. + - Only users with writting privilieges can add a comment, and only the owners of the incident or of the notes can delete them. + Only users with writting privilieges can add a comment, + and only the owners of the incident or of the notes can delete them. + - + Attaching files to an incident - Sometimes it is necessary to link an incident with an image, a configuration file, or any kind of file. + Sometimes it is necessary to link an incident with an image, + a configuration file, or any kind of file. + - The files are attached in the "Attach file" section. Here the file can be searched for in the local machine and attached when the "Upload" button is pressed. + The files are attached in the "Attach file" section. + Here the file can be searched for in the local machine and + attached when the "Upload" button is pressed. + - Only a user with writing privileges can attach a file, and only the owner of the incident or of the file can delete it. + Only a user with writing privileges can attach a file, + and only the owner of the incident or of the file can delete it. + - The incident follow up screen shows all the files attached to the incident in the "Attached files" section of the screen. + The incident follow up screen shows all the files attached + to the incident in the "Attached files" section of the screen. - + Searching for an incident - A specific incident can be found amongst the - incidents created in Pandora by either using a filter _ as explained in the - first section of this chapter - or by making a query using the "Manage Incidents">"Searh Incident" tool, in the Operation menu. + A specific incident can be found amongst the incidents created + in Pandora by either using a filter, as explained in the first + section of this chapter, or by making a query using the + "Manage Incidents">"Searh Incident" tool, in the Operation menu. @@ -219,10 +236,11 @@ the attached files. The search can be performed in addition to group, priority or status filters. - + Statistics - The incident statisticts are shown in the "Manage Incidents">"Statistics" option of the Operation menu. They can be of five different types: + The incident statisticts are shown in the "Manage Incidents">"Statistics" + option of the Operation menu. They can be of five different types: diff --git a/pandora_doc/en/pandora_chapter5.xml b/pandora_doc/en/pandora_chapter5.xml index a86bcd4edb..1f1b24e29c 100644 --- a/pandora_doc/en/pandora_chapter5.xml +++ b/pandora_doc/en/pandora_chapter5.xml @@ -1,6 +1,6 @@ - + Events An event in Pandora is any unusual change happend in an agent. @@ -22,8 +22,8 @@ The event information list shows the data in the following columns: Status: The event status is represented by the icon bellow: - The event has been validated - The event hasn't been validated + The event has been validated + The event hasn't been validated Event name: Name assigned to the event by Pandora. Agent name: Agent where the event happend. Group name: Group of the agent where the event has happened. @@ -31,13 +31,15 @@ Timestamp: Date and time when the event was raised or validated - if it has been validated. Action: Action that can be executed over the event. - This icon will validate the event, disappearing the icon - This icon will delete the event + + This icon will validate the event, disappearing the icon + + This icon will delete the event The events can be also validated or deleted in groups by selecting the tick boxes on the last column of the event, and pressing "Validate" or "Delete" at the bottom of the list. - + Statistics Three different kinds of graphical statistic representation can be diff --git a/pandora_doc/en/pandora_chapter6.xml b/pandora_doc/en/pandora_chapter6.xml index 3213d6b08a..6e915bdbc2 100644 --- a/pandora_doc/en/pandora_chapter6.xml +++ b/pandora_doc/en/pandora_chapter6.xml @@ -1,6 +1,6 @@ - + System audit The Pandora's system audit shows all the actions performed by each user, as well as the failed logins. @@ -27,7 +27,7 @@ Source IP: IP of the machine or the agent that provoked the entry. Comment: Comment describing the entry - + Statistics There isn't a special section to view system audit statistics. However, we could use a graph generated in the Users section to evaluate the actions of each user, as this graph would represent the total diff --git a/pandora_doc/en/pandora_chapter7.xml b/pandora_doc/en/pandora_chapter7.xml index 14648754ed..c6a7af93c9 100644 --- a/pandora_doc/en/pandora_chapter7.xml +++ b/pandora_doc/en/pandora_chapter7.xml @@ -1,6 +1,6 @@ - + Pandora Servers diff --git a/pandora_doc/en/pandora_chapter8.xml b/pandora_doc/en/pandora_chapter8.xml index 867a4dc19c..d7cb041025 100644 --- a/pandora_doc/en/pandora_chapter8.xml +++ b/pandora_doc/en/pandora_chapter8.xml @@ -1,32 +1,52 @@ - + Database Maintenance - The core of Pandora's system is its Database. All the data collected by the monitored - machines is stored in this data base, from the administrator's data, to the - events, incidents and audit data generated in the system at any time. + + The core of Pandora's system is its Database. All the data + collected by the monitored machines is stored in this data base, + from the administrator's data, to the events, incidents and audit + data generated in the system at any time. + - It is obvious that the efficiency and reliability of this module is vital for the correct functioning of Pandora. A regular data base maintainance is needed. To do so the data base managers can - use standard MySQL commands. Maintaining Pandora database in good condition is critital for Pandora to work properly. + + It is obvious that the efficiency and reliability of this + module is vital for the correct functioning of Pandora. + A regular data base maintainance is needed. To do so the data base + managers can use standard MySQL commands. Maintaining Pandora database + in good condition is critital for Pandora to work properly. + - As the database size will increase linearly, the data will be compacted to reduce the amount of stored data without loosing important information, specially the different graphs that are generated with - the processed data. + As the database size will increase linearly, the data will be + compacted to reduce the amount of stored data without loosing important + information, specially the different graphs that are generated with + the processed data. + - Going to "DB Maintenance" from the Administration menu we will find the Database configuration defined in the "Pandora Setup" option of the Administration menu to compact and delete data. + + Going to "DB Maintenance" from the Administration menu we will + find the Database configuration defined in the "Pandora Setup" option + of the Administration menu to compact and delete data. + - + DB Information - The DB statistics are generated by Agent, on the "DB Maintenance">"DB Information" in the Administration menu, and are represented in two kinds of graphs: + The DB statistics are generated by Agent, on the + "DB Maintenance">"DB Information" in the Administration menu, + and are represented in two kinds of graphs: + Number of modules configured for each of the agents. - Number of packages sent by each agent. A package is the group of data linked to the module the agent sends in each interval of time. + Number of packages sent by each agent. + A package is the group of data linked to the module + the agent sends in each interval of time. @@ -37,35 +57,61 @@ These graphs can be also viewed from "View Agents">"Statistics" in the Operation menu. - + Manual purge of the Datadase Pandora counts with powerful tools for the Administrator to manually purge the majority of data stored in the Database. This includes data generated by both the agents and the own server. - + Agent's data purge - + Debuging selected data from a module - The option of purging selected data from a module is used to eliminate those out of range entries, whatever the reason – agent failure, out of range values, testing, DB errors, etc. Eliminating erroneous, incorrect or unnecessary data makes the graphical representation more acuarate and shows the data without peaks or unreal scales. + + The option of purging selected data from a module is used + to eliminate those out of range entries, whatever the reason + - agent failure, out of range values, testing, DB errors, etc. + Eliminating erroneous, incorrect or unnecessary data makes + the graphical representation more acuarate and shows the data + without peaks or unreal scales. + - From "DB Maintenance">"Database Debug" in the Administration menu any of the out of range data received from a agent's module can be deleted. + + From "DB Maintenance">"Database Debug" in the + Administration menu any of the out of range data received + from a agent's module can be deleted. + - The purge settings are: agent, module, minimum and maximum data range. Any parameter out of this minimum/maximum range will be deleted. + The purge settings are: agent, module, minimum and maximum + data range. Any parameter out of this minimum/maximum range + will be deleted. - For example, in a module registering the number of processes, if we are only interested in values between 0 and 100, any values above that number will be usually produced by errors, noise or abnormal - circumstances. If we set to range between 0 and 100 all those values below and above - such as -1, 100 or 100000 - will be permanently deleted from the database. + + For example, in a module registering the number of processes, + if we are only interested in values between 0 and 100, any values + above that number will be usually produced by errors, noise + or abnormal circumstances. If we set to range between 0 and 100 + all those values below and above - such as -1, 100 or 100000 - + will be permanently deleted from the database. + - + Purging all the agent's data - All the out of range data received by an agent can be deleted from the "DB Maintainance">"Database Purge" option in the Administration menu. + + All the out of range data received by an agent can be deleted + from the "DB Maintainance">"Database Purge" option in the + Administration menu. + - The data is deleted by the following parameters from the "Delete data" screen: + + The data is deleted by the following parameters from + the "Delete data" screen: + @@ -94,14 +140,20 @@ - + Purging system data - + Audit data purge - All the audit data generated by the system can be deleted from "DB Maintenance">"Database Audit", in the Administration menu + + All the audit data generated by the system can be deleted from + "DB Maintenance">"Database Audit", in the Administration menu + - The data to be deleted is selected by setting the following parameters in the "Delete Data" screen + + The data to be deleted is selected by setting the following + parameters in the "Delete Data" screen + @@ -129,12 +181,18 @@ - + Event data purge - All the event data generated by the system can be deleted from "DB Maintenance">"Database Event", in the Administration menu + + All the event data generated by the system can be deleted from + "DB Maintenance">"Database Event", in the Administration menu + - The data to be deleted is selected by setting the following parameters in the "Delete Data" screen + + The data to be deleted is selected by setting the following + parameters in the "Delete Data" screen + diff --git a/pandora_doc/en/pandora_chapter9.xml b/pandora_doc/en/pandora_chapter9.xml index f46e1ef3eb..15a965be17 100644 --- a/pandora_doc/en/pandora_chapter9.xml +++ b/pandora_doc/en/pandora_chapter9.xml @@ -1,29 +1,48 @@ - + Pandora Configuration - All the configurable parameters in Pandora can be set in the "Pandora Setup" section, in the Administration menu. + All the configurable parameters in Pandora can be set in the + "Pandora Setup" section, in the Administration menu. These parameters are: - Language: In following versions or revisions of the actual Pandora version will support more languages. At the moment version 1.2 supports English, Spanish, Bable, Italian, French, Catalan and Portuguese of Brazil. - Page block size: Maximum size of the lists in the event, incident and audit log sections. - Max. days before compact data: This parameter controls data compacting. From the - number of days in this parameter the data starts getting compacted. For large - amounts of data it is recommended to set this parameter to a number between 14 - and 28; for systems with less data load or very powerful systems, a number - between 30 and 50 will be enough. - Max. days before purge: This parameter controls how long the data is kept - before it is permanently deleted. The recommended value is 60. For systems with - little resources or large work load the recommended value is between 40 and 50. - Graphic resolution (1 low, 5 high): This value represents the precision of the - interpolation logarithm to generate the graphics. - Compact interpolation (Hours: 1 fine, 10 medium, 20 bad): This is the grade of compression used to compact the Data Base, being 1 the lowest compression rate and 20 the highest. A value above 12 means a considerable data loss. It's not recommended to use value above 6 if the data needs to be - represented graphically in large time intervals. - + Language: In following versions or revisions + of the actual Pandora version will support more languages. + At the moment version 1.2 supports English, Spanish, Bable, Italian, + French, Catalan and Portuguese of Brazil. + + Page block size: Maximum size of the lists + in the event, incident and audit log sections. + + Max. days before compact data: This parameter + controls data compacting. From the number of days in this parameter the + data starts getting compacted. For large amounts of data it is recommended + to set this parameter to a number between 14 and 28; for systems with + less data load or very powerful systems, a number + between 30 and 50 will be enough. + + Max. days before purge: + This parameter controls how long the data is kept + before it is permanently deleted. The recommended value is 60. + For systems with little resources or large work load the recommended value + is between 40 and 50. + + Graphic resolution (1 low, 5 high): + This value represents the precision of the + interpolation logarithm to generate the graphics. + + Compact interpolation (Hours: 1 fine, 10 medium, 20 bad): + This is the grade of compression used to compact the Data Base, + being 1 the lowest compression rate and 20 the highest. + A value above 12 means a considerable data loss. + It's not recommended to use value above 6 if the data needs to be + represented graphically in large time intervals. + + Links Links to different Internet or private network links can be