From 8f694746a03134a5a33ac60b729e12f33fcfe423 Mon Sep 17 00:00:00 2001 From: marostegui Date: Fri, 24 Nov 2006 11:26:27 +0000 Subject: [PATCH] 2006-11-24 Manuel Arostegui * en/pandora_chapter1.xml,pandora_chapter2.xml,pandora_chapter3.xml, pandora_chapter4.xml,pandora_chapter5.xml,pandora_chapter6.xml, pandora_chapter8.xml,pandora_chapter9.xml,pandora_advanced.xml, pandora_userguide.xml,pandora_migration.xml,pandora_introduction.xml pandora.xml: Text corrections. git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@280 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f --- pandora_doc/ChangeLog | 8 +++ pandora_doc/en/pandora.xml | 8 +-- pandora_doc/en/pandora_advanced.xml | 35 +++++----- pandora_doc/en/pandora_chapter1.xml | 12 ++-- pandora_doc/en/pandora_chapter2.xml | 12 ++-- pandora_doc/en/pandora_chapter3.xml | 28 ++++---- pandora_doc/en/pandora_chapter4.xml | 10 +-- pandora_doc/en/pandora_chapter5.xml | 6 +- pandora_doc/en/pandora_chapter6.xml | 2 +- pandora_doc/en/pandora_chapter8.xml | 4 +- pandora_doc/en/pandora_chapter9.xml | 2 +- pandora_doc/en/pandora_introduction.xml | 89 ++++++++++++------------- pandora_doc/en/pandora_migration.xml | 4 +- pandora_doc/en/pandora_userguide.xml | 4 +- 14 files changed, 114 insertions(+), 110 deletions(-) diff --git a/pandora_doc/ChangeLog b/pandora_doc/ChangeLog index 04a6984d86..fef5c9e061 100644 --- a/pandora_doc/ChangeLog +++ b/pandora_doc/ChangeLog @@ -1,3 +1,11 @@ +2006-11-24 Manuel Arostegui + + * en/pandora_chapter1.xml,pandora_chapter2.xml,pandora_chapter3.xml, + pandora_chapter4.xml,pandora_chapter5.xml,pandora_chapter6.xml, + pandora_chapter8.xml,pandora_chapter9.xml,pandora_advanced.xml, + pandora_userguide.xml,pandora_migration.xml,pandora_introduction.xml + pandora.xml: Text corrections. + 2006-11-21 Esteban Sanchez * en/pandora_install.xml: Changed module_proc explanation and example, diff --git a/pandora_doc/en/pandora.xml b/pandora_doc/en/pandora.xml index 012e3afd1d..e563fc49d9 100644 --- a/pandora_doc/en/pandora.xml +++ b/pandora_doc/en/pandora.xml @@ -1,6 +1,6 @@ Pandora"> @@ -19,8 +19,8 @@ 2006 - �tica Soluciones Tecnol�icas S.L, Sancho Lerena, Esteban - S�chez, David Villanueva and others. + Artica Soluciones Tecnologicas S.L, Sancho Lerena, Esteban + S�chez, David Villanueva, Raul Mateos, Manuel Arostegui and others. 19/11/2006 @@ -63,4 +63,4 @@ &include_fdl; &include_gpl; - \ No newline at end of file + diff --git a/pandora_doc/en/pandora_advanced.xml b/pandora_doc/en/pandora_advanced.xml index adf7204c98..ce9d0a6079 100644 --- a/pandora_doc/en/pandora_advanced.xml +++ b/pandora_doc/en/pandora_advanced.xml @@ -27,7 +27,7 @@ Multiple Pandora Data Servers for HA . This is the more complex scenario, because you - dont need to know nothing special about Pandora Server + don't need to know anything special about Pandora Server setup, and you need to use of another tool to implement Network HA, like VRRP or Keepalive. For Pandora Data server you need to setup two identical machines, with the same @@ -36,7 +36,7 @@ point one of them. If one fails, VRRP or Keepalive "promote" the other server up, and Pandora Agents, will connect it for the next data packets. There is no need to change anything - in each of Pandora Data server, only need to be sure that + in each of Pandora Data server, only need ensure that Pandora Server name is the same on both machines (in pandora server setup, not in the system hostname). @@ -47,10 +47,10 @@ . This is more easy. You need to setup multiple network servers in several machines across your network (or all of them in the same segment), and assign modules to the - same server. If this servers fails, and there ara other + same server. If this servers fails, and there are other Network Servers active, marked as "primary" server, automatically, the first network server available marked as - "Primary" launch the network module query. If you have many + "Primary" will launch the network module query. If you have many servers marked as "primary", any of them could launch query. @@ -60,7 +60,7 @@ balancing. . You need to setup multiple network servers in several machines across your network (or all of them in the same segment), and assign agent/modules to - different servers, balancing yourself load between all + different servers, balancing load between all servers available. @@ -84,29 +84,29 @@ Pandora Database design (and redesign from 1.1) First Pandora versions, from 0.83 until 1.1 was based on a simple - idea: ona data, one database insertion. This was very easy to - develop and allow to program easily searches, insertions and other + idea: one data, one database insertion. This was very easy to + develop and allowed to program easily searches, insertions and other operations. - This had many advantages and a great problem: the + This had many advantages and a big problem: the scalability. This system has a limit defined in maximum number of modules that could support in a "easy" way, from that number of modules the management was too slow. - Solutions based on MySQL cluster was difficult and comes with some + Solutions based on MySQL cluster was difficult and cames with some problems and they did not offer either a solution in the long term. Data compression based on interpolation and data purge, makes a - smaller database, but this was not enought. Production systems has + smaller database, but this was not enough. Production systems has a limit based on 100 agents, with about ten modules each one. This - was not a high limit for huge environments. + was not a high limit for large environments. - This problem was very important for Pandora future, so we are + This problem was very important for Pandora future, so we changed the way Pandora store its data. New data management system store only "new" data. If a duplicate value enter the system, it won't be stored in database. It's very useful to keep database @@ -129,11 +129,11 @@ a graphical representation, for module graph there will be no changes. You will have a graph with a perfect horizontal line. Pandora, if doesn't receive new values, thinks that there - are no new values, and everything seems to be equal that in the last + are no new values, and everything seems to be as in the last notification. - This graph, for example, show changes for each data, received each + This graph, for example, shows changes for each data, received every 180 seconds. @@ -150,10 +150,9 @@ and it's receiving data. This is an example of an agent connecting regulary to server: - If you have low leaks in this graph, you could have experiencing - some problems or slow connections in Pandora Agent connectivity - with Pandora Server. This graph with previous example could have - an aspect similar to this: + If you have low leaks in this graph, you may have some problems or slow + connections in Pandora Agent connectivity with Pandora Server. This graph + with previous example could have an aspect similar to this: diff --git a/pandora_doc/en/pandora_chapter1.xml b/pandora_doc/en/pandora_chapter1.xml index e64a39046b..0eb4365034 100644 --- a/pandora_doc/en/pandora_chapter1.xml +++ b/pandora_doc/en/pandora_chapter1.xml @@ -17,7 +17,7 @@ Pandora can be implemented over any operating system, with specific agents for each platform. Pandora can also monitor any TCP/IP - hardware system, such as load balancers, routers, switches, printers + hardware system, as load balancers, routers, switches, printers and so on. @@ -28,17 +28,17 @@ - Web Console: Pandora's user interface. The user controls and operates the system with it. Several Web consoles can be implemented in a single system. - The Web console is written in PHP, and rests on a database and a + The Web console is written in PHP, and it must be over a database and a Web server. It is compatible with any platforms - GNU/Linux, - Solaris, Win2000, AIX, etc. However, the official supported + Solaris, Win2000, AIX, etc. Although, the official supported platform is GNU/Linux. The console permits the user to control the status of the agents, view statistical information, generate graphs and data - tables, keep a system incident control, as well as to generate - reports and change the alerts, agents, and user profile + tables, keep a system incident control, moreover, it will be able + to generate reports and change the alerts, agents, and user profile settings. @@ -131,4 +131,4 @@ - \ No newline at end of file + diff --git a/pandora_doc/en/pandora_chapter2.xml b/pandora_doc/en/pandora_chapter2.xml index 0946bf83ee..27c01be971 100644 --- a/pandora_doc/en/pandora_chapter2.xml +++ b/pandora_doc/en/pandora_chapter2.xml @@ -25,14 +25,14 @@ elements in common among various users. Each user could be in one or more groups at any one time. Each group has user profiles which are defined and attached to it. A profile is a list of things a - user can do, such as view incidents, manage database or other. + user can do, such as view incidents, manage database or other tasks. Profile manager Pandora's profile manager is used to assign specific profiles to - each user. A hierarchy of users is so created, structured by the + each user. A hierarchy of users is created, structured by the user's profile within the company. With this system different security levels can be implemented: read-only users, agent group coordinators or system administrators. @@ -112,7 +112,7 @@ Adding a user - A user is added clicking on "Manage Users" > "Create user" + An user is added clicking on "Manage Users" > "Create user" in the Administration Menu @@ -127,7 +127,7 @@ Deleting a user - 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. @@ -137,7 +137,7 @@ Statistics - The user activity statistics show a graph with the + The user activity statistics shows a graph with the activity of the user, being the number of events the audit has generated for each user. The number of events of a user usually reflects the user's activity. @@ -152,7 +152,7 @@ Messages to users In pandora 1.2 the possibility of send messages to other - users has been added.To create a new message to other user, + users has been added.To create a new message to another user, go to "Messages"section in the Operation menu. You can also read the received messages, but the sent messages are not stored. diff --git a/pandora_doc/en/pandora_chapter3.xml b/pandora_doc/en/pandora_chapter3.xml index e3cce47fa0..07dbdc86dd 100644 --- a/pandora_doc/en/pandora_chapter3.xml +++ b/pandora_doc/en/pandora_chapter3.xml @@ -8,13 +8,13 @@ The agents collect information. There are agents based on a software agent and installed in the System to monitor, and network agents - a non-physical agent, without need of installing any software, that - execute network tasks in Pandora Network servers and shows + executes network tasks in Pandora Network servers and shows information on console. For agents who need to install software into remote systems, public key of the machine to be monitored needs to be copied into - Pandora Data server to be able to collect data, as it is specified + Pandora Data server in order to be able to collect data, as it is specified in detail in Pandora Install documentation. @@ -80,7 +80,7 @@ There are several default groups defined in Pandora. You also can - create your own (please use given icons or edit and add your own icons). + create your own group (please use given icons or edit and add your own icons). You can also modify default ones. @@ -172,7 +172,7 @@ - Module definition: There are two modes + Module definition: There are two state for a module: @@ -180,7 +180,7 @@ Learning mode: All the modules sent by the agent are accepted. If modules are not defined, they - are automatically defined by the system. It is recommended + will be automatically defined by the system. It is recommended to activate the agents in this mode and change it once the user is familiar with Pandora FMS. @@ -403,7 +403,7 @@ value. The Alert can consist of sending an e-mail or SMS to the administrator, sending a SNMP trap, write the incident into the system syslog or Pandora log file, etc. Basically, - it's anything that can be triggered by a script configured + anything that can be triggered by a script configured in the Operating System where Pandora Servers run. @@ -539,7 +539,7 @@ The next step after an agent has been added, its modules have been configurated and the alerts have been - defined, is to assign those alerts to the agent. + defined, is assign those alerts to the agent. @@ -640,7 +640,7 @@ It might happen that the user finds that modules and alerts configured for an agent would be repeated in a new agent. - In order to simplify the administrator's job Pandora offers + In order to simplify the administrator's work Pandora offers the option of copying modules and alerts defined in an agent to be assigned to another. @@ -840,7 +840,7 @@ - In this list the module information is shown in the following + In this list the module information is showed in the following columns: @@ -916,8 +916,8 @@ - Timestamp: This is the hour of the last - contact. + Timestamp: This is the hour when last + contact was made. @@ -1122,7 +1122,7 @@ SNMP Console - Almost all device can send SNMP traps when have any problem as + Majority of devices can send SNMP traps when have any problem as reboot, lost interface, the temperature is very high, CPU crash, etc. With Traps is possible to know the problem when it happens. @@ -1140,7 +1140,7 @@ SNMP Alerts - Just like is possible to generat alert if there is an out of + Just like is possible to generate an alert if there is an out of range module value. It is possible to generate an alert if an SNMP trap is received with a anorma value. The Alert can consist of sending and e-mail or SMS to the administrator, sending an SNMP @@ -1243,4 +1243,4 @@ - \ No newline at end of file + diff --git a/pandora_doc/en/pandora_chapter4.xml b/pandora_doc/en/pandora_chapter4.xml index 206a5395b9..0cacc9a31a 100644 --- a/pandora_doc/en/pandora_chapter4.xml +++ b/pandora_doc/en/pandora_chapter4.xml @@ -26,7 +26,7 @@ Clicking on "Manage Incidents", in the Operation menu, a list showing all the incidents is displayed, ordered by the date-time they - were last updated. Filters can be applied to display only those + were updated. Filters can be applied to display only those incidents the user is interested on. @@ -240,7 +240,7 @@ Searching for an incident - A specific incident can be found amongst the incidents created + A specific incident can be found among 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. @@ -250,8 +250,8 @@ Any text string included as a sub-string in the incident can be searched for using this tool. This search engine looks for the string in the Incident title as well as in the text contained by - the incident. The search engine will not search neither the - Comments added to the agent nor the attached files. The search + the incident. The search engine will not search either the + Comments added to the agent or the attached files. The search can be performed in addition to group, priority or status filters. @@ -309,4 +309,4 @@ - \ No newline at end of file + diff --git a/pandora_doc/en/pandora_chapter5.xml b/pandora_doc/en/pandora_chapter5.xml index 1da83513ec..59b6840e85 100644 --- a/pandora_doc/en/pandora_chapter5.xml +++ b/pandora_doc/en/pandora_chapter5.xml @@ -23,7 +23,7 @@ The events appear ordered chronologically as they enter the system, and can be viewed by clicking the "View Events" - option in the Operation menu. The newer events are placed + option in the Operation menu. The newest events are placed at the top of the table. @@ -86,7 +86,7 @@ Statistics - Three different kinds of graphical statistic + Three different sort of graphical statistic representation can be choosen from the "View Events" > "Statistics" option in the Operation menu: @@ -118,4 +118,4 @@ - \ No newline at end of file + diff --git a/pandora_doc/en/pandora_chapter6.xml b/pandora_doc/en/pandora_chapter6.xml index 18321a2da0..3e50929a38 100644 --- a/pandora_doc/en/pandora_chapter6.xml +++ b/pandora_doc/en/pandora_chapter6.xml @@ -82,4 +82,4 @@ - \ No newline at end of file + diff --git a/pandora_doc/en/pandora_chapter8.xml b/pandora_doc/en/pandora_chapter8.xml index 1bf415e607..06585043c0 100644 --- a/pandora_doc/en/pandora_chapter8.xml +++ b/pandora_doc/en/pandora_chapter8.xml @@ -104,7 +104,7 @@ 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 + 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. @@ -266,4 +266,4 @@ - \ No newline at end of file + diff --git a/pandora_doc/en/pandora_chapter9.xml b/pandora_doc/en/pandora_chapter9.xml index ba603cb13c..c9f4c15a7c 100644 --- a/pandora_doc/en/pandora_chapter9.xml +++ b/pandora_doc/en/pandora_chapter9.xml @@ -86,4 +86,4 @@ - \ No newline at end of file + diff --git a/pandora_doc/en/pandora_introduction.xml b/pandora_doc/en/pandora_introduction.xml index 3a32e1ffb6..bcbb88ad57 100644 --- a/pandora_doc/en/pandora_introduction.xml +++ b/pandora_doc/en/pandora_introduction.xml @@ -29,7 +29,7 @@ servers, etc. - all integrated into an open and distributed architecture. Pandora can be implemented over any operating system, with specific agents for each platform. Pandora can also - monitor any TCP/IP hardware system, such as load balancers, + monitor any TCP/IP hardware system, as load balancers, routers, switches, printers, etc. Pandora architecture is formed of four main components: @@ -39,16 +39,16 @@ Web Console: Pandora's user interface. The user controls and operates the system with it. Several Web consoles can be implemented in a single - system. The Web console is written in PHP, and rests on a + system. The Web console is written in PHP, and it is over a database and a Web server. It is compatible with any - platform - GNU/Linux, Solaris, Win2000, AIX, etc. However, - the official supported platform is GNU/Linux. + platform - GNU/Linux, Solaris, Win2000, AIX, etc.T + official supported platform is GNU/Linux, though The console permits the user to control the status of the agents, view statistical information, generate graphs and - data tables, keep a system incident control, as well as to - generate reports and change the alerts, agents, and user + data tables, keep a system incident control,moreover it is able + to generate reports and change the alerts, agents, and user profile settings. @@ -132,7 +132,7 @@ At present, with Pandora any process or system that through a command returns a value can be monitored, as well as any value in any Operating System log file or similar. Some examples of already - existing implementations can be the following ones: + existing implementations below: Number of connections (sessions) of Checkpoint FW-1 Number of NAT sessions of Checkpoint FW-1 @@ -199,11 +199,11 @@ The process of transferring the data file from the agent to the server is made regularly at a defined time interval in the agent configuration file, pandora_agent.conf. It's possible to modify - that parameter to not fill the database with non-relevant - information, not to load the network or to not affect the system + that parameter in order to do not fill the database with non-relevant + information, either load the network or affect the system performance. The default interval is 300 (seconds), which is equivalent to five minutes. Minor values of 100 (seconds) are not - recommended since host performance can be affected, besides + recommended since host performance could be affected, besides loading excessively Database and the Operating System of Pandora Server. Pandora is not a real time system; it's an applications and systems general monitoring system in environments that are not @@ -263,8 +263,7 @@ Pandora. This file has the information gathered by the Agent. Its easy structure allows that any user could create its own developments to be processed in Pandora, or use the included ones. - An example of the information included into the data file is the - following one: + An example of the information included into the data file below: @@ -349,27 +348,27 @@ Data are extracted from the data file, identifying origin, type - and category. One classified, the data are inserted into the + and category. Once it's classified, the data are inserted into the Database by the same Perl script. Pandora Server can work in High Availability and/or Load Balancing. In a very big architecture, several Pandora Servers can - be arranged simultaneously to be able to manage big volumes of + be arranged simultaneously in order to be able to manage big volumes of information distributed by geographical or functional zones. Pandora Server is always running (as a daemon) and permanently verifies if some element causes to fire an alarm. If so, it executes the action defined in the alarm, as to send a SMS, an - email, to activate the execution of a SCRIPT or to send an HTTP + email, even activates the execution of a SCRIPT or to send an HTTP form. We could have several simultaneous servers, one of them is the - Main Server or "Master Server " and the rest servers are "Slave + Main Server or "Master Server " and the rest of servers are "Slave Servers". The Master Server is the only one that verifies the - alarms if any agent goes down. The server who receives the data + alarms if any agent goes down. The server which receives the data file from the agent always fires the rest of alarms, defined in the agents' modules. This is also important if this server changes (due to configurations of high availability, load balancing or @@ -379,20 +378,20 @@ Pandora console - The Web Console it's a web application that allows to see - graphical reports, state of every agent, and to access to the + The Web Console is a web application that allows to see + graphical reports, state of every agent, also to access to the information sent by the agent, to see every monitored parameter and to see its evolution throughout the time, to form the different nodes, groups and users of the system. It is the part - that interacts with the final user, and that allows you to + that interacts with the final user, and that will allows you to administer the system. The Web Console is written in PHP and no plug-in, Flash, Java or ActiveX is needed to access the console, only a browser that - supports HTML and CSS (IE5+ o Mozilla 4+). Pandora Web Console can - run in several servers, the only thing you need is to access - Pandora Database, where Pandora stores all the information. + supports HTML and CSS (IE5+ or Mozilla 4+). Pandora Web Console can + run in several servers, the only thing you need is to be allow to + access Pandora Database, where Pandora stores all the information. @@ -400,7 +399,7 @@ Pandora uses a SQL Database to store all the information. Pandora maintains an asynchronous database with all the received data, - making a temporary cohesion of everything what it receives and + making a temporary cohesion of everything it is receives and normalizing all the information from the different sources. Every Agent data module generates an entry of information for every data bundle, which implies that a real production system can have of @@ -408,33 +407,31 @@ This information is managed automatically from Pandora, carrying - out a periodic and automatic maintenance of the database. This - allows that Pandora should need neither any type of administration - of database nor process attended by an operator or manager. This - is made by a periodic purge of the past information over a date - (by default 90 days), as well as a data compaction of the data - that have more than, by default, 30 days. + out a periodic and automatic maintenance of the database. This means + that there is no operator either manager required to run tasks as database + administration ones. This is possible thanks to a periodic purge of the past + information over a date (by default 90 days), as well as a data + which is older, by default, 30 days. Compacting data - Data stored by Pandora are useful to see evolutions regard through - the time, to make statistics, to generate reports and to do - capacity planning, as well as other tasks of statistical - nature. For it, it isn't necessary to have all the data, but it's + Data stored by Pandora are useful to see evolutions through + the time, in order to: make statistics, generate reports and to do + capacity planning, as well as other statisticals tasks. + To do that it isn't necessary to have all the data, but it's enough to have a representative sample, of smaller resolution, enough to carry out the task that is needed. With that philosophy the compaction system has been - constructed. If we have a sample of 9.000 elements, distributed - during 90 days, for example, Pandora is going to take the data of - last month, which would be 3.000 elements and it's going them to - compress them in 300. In the graphs they will practically be seen - equal, which it will serve us for the reports, statistics and - other tasks. This is made by means of interpolation in temporary - strips, in a totally automatic and periodic way, without the user - or the administrator must himself or herself worry about it. + constructed. For instance, If we have a sample of 9.000 elements, + distributed during 90 days, Pandora will take the data of + last month, which would be 3.000 elements and will compress it in 300. + In the graphs they will practically be equal, and it will be usfel for the reports, statistics + and other tasks. This is made thanks to a interpolation in temporary + strips, in a totally automatic and periodic way, there is not user + or the administrator needed to do this. @@ -442,12 +439,12 @@ Pandora 1.2 new features - Alert system. Now its possible to define a + Alert system. Now it is possible to define a "minimun" and "maximum" limit to fire an alert, just to delete "noisy" data that fires false positives. - Network Subsystem. Now its possible to + Network Subsystem. Now it is possible to monitor and analyze data using remote network tools, without using agents, from the new Pandora Network Server component. All management are made from Pandora Console, and now you will be able @@ -499,7 +496,7 @@ Pandora is a project initiated and mainly developed by Sancho Lerena, at present other people is working on it: Raul Mateos, David Villanueva, Esteban Sanchez, Jose Navarro and Jonathan - Barajas. We want to give thanks for many other people who help us + Barajas. We want to thank many other people who help us with translation, graphic design, bugs reporting and interesting ideas. diff --git a/pandora_doc/en/pandora_migration.xml b/pandora_doc/en/pandora_migration.xml index ac11b1d7fc..20ba425724 100644 --- a/pandora_doc/en/pandora_migration.xml +++ b/pandora_doc/en/pandora_migration.xml @@ -38,8 +38,8 @@ Migration steps - 0. You need to stop Pandora Server before any changes in - database. Think that you dont loose any data in the process of + 0. You need to stop Pandora Server before change anything in + database. Think that you don't lose any data in the process of migration because agent data will be stored in incoming directory. Move this data to the new incoming directory before launch the new server, and you process that data without miss diff --git a/pandora_doc/en/pandora_userguide.xml b/pandora_doc/en/pandora_userguide.xml index fd435f872c..bb198699c1 100644 --- a/pandora_doc/en/pandora_userguide.xml +++ b/pandora_doc/en/pandora_userguide.xml @@ -25,7 +25,7 @@ 2006 Artica Soluciones Tecnologicas S.L, Sancho Lerena, Esteban - Sanchez, David Villanueva and others. + Sanchez, David Villanueva, Raul Mateos, Manuel Arostegui and others. 19/11/2006 @@ -49,7 +49,7 @@ 1.2 - 21 November 2006 + 24 November 2006 Submitted.