Getting Started

i-scream · before

ihost.pl server.domain.com port
+ihost.pl server.domain.com port
+
+        
+          
+            i-scream CVS Repository
+          
+          
+            The i-scream CVS Repository contains all code,
+            documentation, and other files pertaining to all i-scream
+            projects.
+          
+          
+            All code available in the CVS Repository is
+            licensed under the GPL.
+          
+          
+            Web Access
+          
+          
+            We use viewcvs
+            to provide a visual frontend to the CVS Repository. It
+            allows you to browse around the repository, viewing any
+            version of a file, and the differences between different
+            versions. There is also a link to download the latest
+            version of any section.
+          
+          
+            http://cvs.i-scream.org/
+          
+          
+            We also have a facility to allow people to keep tabs on
+            what's changed recently. The following are available:
+          
+          
+            Commits today: http://www.i-scream.org/cgi-bin/cvslog.cgi?period=today

+            Commits this week: http://www.i-scream.org/cgi-bin/cvslog.cgi?period=thisweek

+            Commits in the past 7 days: http://www.i-scream.org/cgi-bin/cvslog.cgi?period=days&days=7

+            Commits made since 29/03/2001: http://www.i-scream.org/cgi-bin/cvslog.cgi?period=since&date=2001/03/29
+          
+          
+            Anonymous CVS Access (read-only)
+          
+          
+            Anyone can access the i-scream CVS repository in anonymous
+            mode read-only mode. The following commands will allow you
+            to check out a portion of the CVS repository. To see what
+            is available it is recommended that you first look at the
+            web frontend.
+          
+           cvs -d :pserver:anonymous@cvs.i-scream.org:/cvs/i-scream login
 cvs -d :pserver:anonymous@cvs.i-scream.org:/cvs/i-scream checkout [module]
 
-
-When asked for a password, simply press enter.
-Replace [module] with the section you wish to checkout.
-
-Developer CVS Access (write)
-
-The i-scream development team have full write
-access to the CVS repository. This is only available over SSH, and can be done
-on most clients. First the following environment variables need to be set.
-
-+          
+            When asked for a password, simply press enter. Replace
+            [module] with the section you wish to checkout.
+          
+          
+            Developer CVS Access (write)
+          
+          
+            The i-scream development team have full write access to the
+            CVS repository. This is only available over SSH, and can be
+            done on most clients. First the following environment
+            variables need to be set.
+          
+           CVS_RSH = ssh
 CVSROOT = :ext:username@cvs.i-scream.org:/cvs/i-scream
 
-
-You should know your username and password
-already. After setting these you will need to enter your password each time you
-use a CVS command. Obviously this is a time wasting event, so an RSA key can be
-generated and placed on the server for you. Please view the relevant ssh
-manpages on how to generate an RSA key pair.
-
-After this you will be able to work with CVS as
-normal.
-
-Other means of accessing CVS
-
-We currently provide CVSup access to
-the repository, either for mirroring or for maintaining an up-to-date local
-copy. You will probably want to create a supfile that looks something like
-this;
-
-+          
+            You should know your username and password already. After
+            setting these you will need to enter your password each
+            time you use a CVS command. Obviously this is a time
+            wasting event, so an RSA key can be generated and placed on
+            the server for you. Please view the relevant ssh manpages
+            on how to generate an RSA key pair.
+          
+          
+            After this you will be able to work with CVS as normal.
+          
+          
+            Other means of accessing CVS
+          
+          
+            We currently provide CVSup
+            access to the repository, either for mirroring or for
+            maintaining an up-to-date local copy. You will probably
+            want to create a supfile that looks something like this;
+          
+           *default host=cvsup.i-scream.org
 *default base=/home/user/sup
 *default prefix=/home/user/i-scream
@@ -90,31 +106,32 @@ this;
 *default compress
 i-scream.cms.source tag=.
 
-
-The last item in that list is the collection you which to get. The collection
-"i-scream" is simply the whole repository, and is best used with no
-tag specified for mirroring. It is most likely that you will want to do that
-given above, which gets the latest copy of the i-scream source code.
-
-CVS Statistics
-
-There are some statistics available on the cms module of the CVS
-repository, generated by cvsplot,
-that allow you to see the progress of development. They're not that exciting,
-but do show when the work was done.
-
-
-http://www.i-scream.org/cvsplot/
-
-
-
+          
+            The last item in that list is the collection you which to
+            get. The collection "i-scream" is simply the whole
+            repository, and is best used with no tag specified for
+            mirroring. It is most likely that you will want to do that
+            given above, which gets the latest copy of the i-scream
+            source code.
+          
+          
+            CVS Statistics
+          
+          
+            There are some statistics available on the cms module
+            of the CVS repository, generated by
+            cvsplot,
+            that allow you to see the progress of development.
+            They're not that exciting, but do show when the work
+            was done.
+          
+          
+            http://www.i-scream.org/cvsplot/
+          
+        
-		    GNU GENERAL PUBLIC LICENSE
-		       Version 2, June 1991
+        
+          
+            i-scream software licensing
+          
+          
+            Unless explicitly mentioned the i-scream central monitoring
+            system is licensed under the GNU General Public License
+            (GPL). The full license can be found here, but is also
+            given below for reference.
+          
+          +                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
 
  Copyright (C) 1989, 1991 Free Software Foundation, Inc.
                        59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
-			    Preamble
+                            Preamble
 
   The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
@@ -81,8 +78,8 @@ patent must be licensed for everyone's free use or not licensed at all.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
-
-		    GNU GENERAL PUBLIC LICENSE
+
+                    GNU GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
   0. This License applies to any program or other work which contains
@@ -136,7 +133,7 @@ above, provided that you also meet all of these conditions:
     License.  (Exception: if the Program itself is interactive but
     does not normally print such an announcement, your work based on
     the Program is not required to print an announcement.)
-
+
 These requirements apply to the modified work as a whole.  If
 identifiable sections of that work are not derived from the Program,
 and can be reasonably considered independent and separate works in
@@ -194,7 +191,7 @@ access to copy from a designated place, then offering equivalent
 access to copy the source code from the same place counts as
 distribution of the source code, even though third parties are not
 compelled to copy the source along with the object code.
-
+
   4. You may not copy, modify, sublicense, or distribute the Program
 except as expressly provided under this License.  Any attempt
 otherwise to copy, modify, sublicense or distribute the Program is
@@ -251,7 +248,7 @@ impose that choice.
 
 This section is intended to make thoroughly clear what is believed to
 be a consequence of the rest of this License.
-
+
   8. If the distribution and/or use of the Program is restricted in
 certain countries either by patents or by copyrighted interfaces, the
 original copyright holder who places the Program under this License
@@ -281,7 +278,7 @@ make exceptions for this.  Our decision will be guided by the two goals
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
 
-			    NO WARRANTY
+                            NO WARRANTY
 
   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
@@ -303,9 +300,9 @@ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
-		     END OF TERMS AND CONDITIONS
-
-	    How to Apply These Terms to Your New Programs
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
 
   If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it
@@ -365,15 +362,10 @@ consider it more useful to permit linking proprietary applications with the
 library.  If this is what you want to do, use the GNU Library General
 Public License instead of this License.
 
-
-
+        
+        
+          
+            i-scream pgp keys
+          
+          
+            i-scream developer pgp key
+          
+          
+            This is the public key we use for signing i-scream software
+            releases.

+            You can also download a copy
+            here.
+          
+           
 
-
-i-scream automated build pgp key
-
-
-This is the public key we use for signing automated
-builds on our build server. This key is less trusted
-as it has no passphrase. We will only use this to
-sign things such as snapshot builds - all proper
-releases will be signing with the main key given
-above.
You can also download a copy
-here.
-
-
-+          
+            i-scream automated build pgp key
+          
+          
+            This is the public key we use for signing automated builds
+            on our build server. This key is less trusted as it has no
+            passphrase. We will only use this to sign things such as
+            snapshot builds - all proper releases will be signing with
+            the main key given above.

+            You can also download a copy
+            here.
+          
+           
 
-
-
+        

- i-scream - screenshots - (or the two minute - tour) - - This page provides a sequence of - screenshots to help you to gain a better understanding of the i-scream - distributed central monitoring system and how it may be applied in - networked environments. Click on the thumbnails to view the full - size screenshots. -
-	Reports Centre - (Web) - The i-scream reports centre provides a central access point to all - web-based reports that are provided by the i-scream system. Reports - are available to display information about the current status of an - individual machine and any alerts pertaining to either an individual - machine, or a summary of alerts for all machines. Historical - information about monitored machines may also be accessed from this point. -
-	Latest Information - (Web) - Here we are viewing the latest information provided by a host. Bars - are used to represent values such as disk space and free memory as this - makes it easier to spot casual problems. The small graph icons link - to historical reports of each field for the previous day. The choice - of fields to display on this page is stored in a separate configuration - file. -
-	Conient (Multiplatform - real-time client) - Conient is a real-time client that - can hook into an i-scream server to allow the user to view host - information as it passes through the server. The client displays - information provided by the hosts as well as the results of service checks - performed by the server on each host (eg FTP, Telnet, etc). Conient - is written in Java and can thus be run on most operating systems. -
-	Conient (Viewing - extra data) - Less important host information may be viewed in a seperate window to - avoid clutter in Conient's display. Details of the protocol for - host-to-server communications are freely available to developers. - The protocol itself is extensible and client programs such as Conient - display even unrecognised data from modified host programs. -
-	Conient - (Configuration) - Conient is fully configurable from within the program itself. - Multiple configurations may be saved. Conient can also be configured - to connect to a server through a firewall via an SSH tunnel or suchlike. -
-	ihost (Unix/Linux - host) - The ihost is currently the main Unix/Linux/FreeBSD host application for - i-scream. ihost is centrally configured by the server it connects to - and periodically sends information about the machine on which it is - running. The ihost is written in Perl, so can be easily altered to - send extra information to your i-scream server. -
-	WinHost (Windows - host) - The WinHost is similar in concept to the ihost, however, this one runs on - Windows NT/2000 servers. Again, the configuration is dynamically - obtained from the server. The WinHost is typically only present in - the Windows system tray. Double clicking on the system tray icon - will bring up a small window that allows data to be viewed and to force - reconfiguration with the server. -
-	Alerts (Email) - The i-scream server includes many alerting mechanisms. Simple email - alerts may be sent out if desired. Alert levels and frequencies may - be configured for the server. This screenshot shows the format of a - typical alert; the contents of which are of course configurable. -
-	Alerts (IRC bot) - Another i-scream alerter comes in the form of an interactive IRC bot. - This may reside in an IRC (Internet relay chat) channel and broadcasts - alerts if told to do so. This screenshot shows a typical interaction - with a user in the "Bersirc" IRC client. -
-	Alerts (Web page) - Individual alerts and a summary of all alerts raised by the i-scream - server may be viewed on the alerts web pages. These show the - different levels of alerts in configurable colours and provides specific - details about the alerts being raised for each machine. -
-	Alerts (Public - helpdesk display) - The reports centre also provides a - page that may be useful in configuring non-interactive public displays of - alerts. These displays automatically refresh the page periodically - and supported web browsers may also automatically scroll the page to allow - a large font to be employed for easier reading from a distance. -
-	Conient (Server queue - monitoring) - The Conient client may also be used - to monitor information about the i-scream server itself. Here we are - viewing the status of the internal queues within the server. This - shows that the server is performing healthily and that there are no - bottlenecks.
-	Historical reports - (Web) - Historical information is collated - by the i-scream server into (typically) a MySQL database. A separate - program is used to produce the historical web reports These may be browsed - via this web-based interface (see screenshot). The reports to be - generated for each machine and the size of the page are of course - configurable. -
-	Historical reports - (Metadata) - The historical report generation - also produces a number of other files that may be useful for third party - analysis tools. The chart itself is written as a GIF image, as well - as a small file suitable for including on PHP pages that specifies the - minimum and maximum values during the 24 hour period. A file - containing the raw plot data is also produced to enable the use of third - party on-the-fly plotting tools. -
-	The i-scream server - The server is distributed and may - therefore have multiple points of data entry and run on more than one - machine. This helps to reduce the amount of host traffic over large - networks and reduces potential bottlenecks. The server is written in - Java to allow it to run on most operating systems. This exciting - screenshot shows the i-scream server running ;-) -

Getting Started

Getting Started with the i-scream Central Monitoring System

1. Installing the corba services (pre-requisite for the server)

1. Installing the server

2. Configuring the server

2a. Setting up the database

3. Starting the server

4. Setting up hosts

5. Using Conient

6. Setting up DBReporter

7. Setting up the Web Interface

8. Further

+ Getting Started +

+ Getting Started with the i-scream Central Monitoring System +

+ 1. Installing the corba services (pre-requisite for the + server) +

+ 1. Installing the server +

+ 2. Configuring the server +

+ 2a. Setting up the database +

+ 3. Starting the server +

+ 4. Setting up hosts +

+ 5. Using Conient +

+ 6. Setting up DBReporter +

+ 7. Setting up the Web Interface +

+ 8. Further +

i-scream documentation

User guides

Maintenance documentation for developers

Specification documents

Other documents

+ i-scream documentation +

+ User guides +

+ Maintenance documentation for developers +

+ Specification documents +

+ Other documents +

CMS Features

Problem Specification

Original Problem

Centralised Machine Monitoring

Features

Key Features of The System

An Overview of the i-scream Central Monitoring System

+ CMS Features +

+ Problem Specification +

+ Original Problem +

+ Centralised Machine Monitoring +

+ Features +

+ Key Features of The System +

+ An Overview of the i-scream Central Monitoring System +

i-scream CMS homepage

Snapshot Builds

Old Builds (from project completion)

Product documentation

Javadoc documentation

Process documentation

+ i-scream CMS homepage +

+ Overview +

+ Screen Shots +

+ Reports Demo +

+ Downloads +

+ Snapshot Builds +

+ Old Builds (from project completion) +

+ Documentation +

+ Product documentation +

+ Javadoc documentation +

+ Process documentation +

+ Project History +

i-scream CMS javadoc

Java Source code documentation

+ i-scream CMS javadoc +

+ Java Source code documentation +

i-scream meeting minutes

i-scream meeting minutes

March 2001

February 2001

January 2001

December 2000

November 2000

October 2000

September 2000

+ i-scream meeting minutes +