======================================================================
Halcyon Monitoring Solutions
www.HalcyonInc.com
Halcyon Neuron Core
Version 1.8.0
README
======================================================================
Overview
======================================================================
Halcyon Neuron Core is a lightweight centralized event management
framework. It can not only receive inbound events, but also process
those events through its rules engine and forward them to popular
Enterprise Management Frameworks (EMFs).
This file consists of the following sections:
- Included Components
- Supported Platforms
- Informational Text Files
- Installation and Uninstallation Instructions
- Release Notes
- Runtime Directory Structure
- Configuration
- User Interface
- Utilities
- Acknowledgements
- Halcyon Forums
- License Agreement
- About Halcyon
Included Components
======================================================================
This distribution includes the following Halcyon products:
Halcyon Neuron Core
Halcyon Generic Adapter
Halcyon Email Adapter
Halcyon Neuron Event Viewer
Halcyon Neuron Agent Viewer
Supported Platforms
======================================================================
Halcyon Neuron Core is only supported on the following platforms:
SPARC Solaris 2.9-2.10
x86/x64 Solaris 2.10
It only supports Neuron Agent integration with the following Neuron
Agent version:
Halcyon Neuron Agent 3.1.0
Note: Halcyon officially supports the versions listed above as the
product was tested against these releases. It is possible
that the product may function correctly with other versions.
Halcyon Neuron Core provides a web-based user interface which is
only supported for the following browsers:
Mozilla Firefox 2.0-3.5
Microsoft Internet Explorer 7-8
Note: Halcyon officially supports the browsers and versions listed
above as the product was tested against these releases. It is
possible the product may function correctly with other
browsers and versions.
Informational Text Files
======================================================================
A number of useful informational text files are included with this
distribution:
- README
- README.install
- README.config
- README.EventViewer
- README.NeuronAgentViewer
- README.EventActionConverter
- README.Utilities
- README.DataExport
- ReleaseNotes
For licensing information, refer to the following files:
- LICENSE
- COPYRIGHT
- NeuronCore.LICENSE
- ApacheLicense.txt
- FUSEMessageBroker.txt
- CDDL.txt
- LGPL.txt
- GPL.txt
- MIT.txt
These files are located in the base directory of the distribution
tarball, and after installation, in the directory:
- On a Solaris host (where LOCALDIR is typically /var/opt/HMF):
/[LOCALDIR]/install/Halcyon_Neuron_Core
Installation and Uninstallation Instructions
======================================================================
For installation or uninstallation instructions, refer to the
following file:
- README.install
Release Notes
======================================================================
For information about bug fixes, enhancements, known problems, and
upgrade strategy for the current release, refer to the following file:
- ReleaseNotes
Runtime Directory Structure
======================================================================
All necessary configuration, log, and data files can be found in the
[LOCALDIR] folder, where LOCALDIR is typically /var/opt/HMF.
The contents of this folder are as follows:
[LOCALDIR]
+ bin - Store for runnable scripts
+ conf - Configuration files
+ lib - Store for additional library files
+ logs - Log files
+ mibs - Store for mibs supported by Neuron Core
Configuration Files
----------------------------------------------------------------------
Configuration files are located in the [LOCALDIR]/conf directory
as well as the service and module subdirectories.
The following configuration files are most likely
to require modification:
container.xml - general configuration parameters for the
Halcyon Neuron Core, including the path
to service related configuration files
logging.xml - configuration parameters for the message
logging service
security.xml - security related configurations
users.xml,groups.xml - access control list for the Halcyon
Neuron Core
TrapRules.hmf - mappings for snmp traps (more details
located with file)
service/SnmpService.xml - configuration parameters related to the
receipt of snmp traps (ie listener port)
service/RuleServiceSnmpFilter.drl - filtering rules for incoming
snmp traps (more details in file)
Log Files
----------------------------------------------------------------------
Log files are located in the [LOCALDIR]/logs directory as described
above. The following files are the most relevant log files:
messageLogger.log - contains a dump of all messages that have
been sent to the Halcyon Neuron Core.
NeuronCore.log - general logfile for the Halcyon Neuron Core;
all internal logging information is sent to
this log file.
Configuration
======================================================================
Various components of the Halcyon Neuron Core require configuration.
The following sections provide information on how to configure the
Generic and Email adapters.
Generic Adapter Configuration
----------------------------------------------------------------------
Please refer to the README.config file for information on how to
configure the Halcyon Generic Adapter that is included with this
version of the Halcyon Neuron Core.
Email Adapter Configuration
----------------------------------------------------------------------
To enable the Email Adapter, please update the EmailService.xml
configuration file in /[LOCALDIR]/HMF/conf/service/ to include your
mail server. Within the file you will see a line like
<property name="mailHost" value="localhost" type="string"/>
Please change "localhost" to your own Mail Host.
User Interface
======================================================================
Halcyon Neuron Core provides a web-based user interface that consists
of multiple components.
Halcyon Neuron EventViewer
----------------------------------------------------------------------
This version of Halcyon Neuron Core comes with Halcyon's Neuron
EventViewer. Please refer to README.EventViewer for more information
and how to access this tool.
Halcyon Neuron Agent Viewer
----------------------------------------------------------------------
This version of Halcyon Neuron Core comes with Halcyon's Neuron Agent
Viewer. Please refer to README.NeuronAgentViewer for more information
and how to access this tool.
Utilities
======================================================================
This version of Halcyon Neuron Core comes with several command-line
utilities. Please refer to the following documents for more
information and how to access these tools:
- README.EventActionConverter
The EventActionConverter utility can be used to convert an
existing EventAction rule file to a Neuron Core rule file.
- README.DataExport
The DataExport utility can be used for data export.
- README.Utilities
Neuron Core comes with several utilities for managing its
components.
Acknowledgements
======================================================================
Halcyon Neuron Core uses the SNMP4J software developed by
Frank Fock and Jochen Katz from SNMP4J.org.
The object code can be found here:
./packages/Solaris/HALhmfcon/reloc/HMF/lib/snmp4j/SNMP4J.jar
SNMP4J is covered under the terms of the Apache License, Version 2,
January 2004. A copy of the license can also be found in the same
directory as this README file.
Halcyon Neuron Core uses the FUSE Message Broker developed by
Progress Software Corporation.
FUSE Message Broker is covered under the terms of the FUSE Message
Broker v. 5.3 License (based on the Apache License, Version 2,
January 2004). A copy of the license can also be found in the
same directory as this README file.
Halcyon Neuron Core uses the Apache XBean, Apache Commons IO, Apache
Commons FileUpload, Apache FOP, Apache XML Graphics Commons, Apache
Batik, Apache Avalon and Apache Tomcat software all developed by
The Apache Software Foundation.
Apache XBean, Apache Commons IO, Apache Commons FileUpload, Apache
FOP, Apache Batik, Apache Avalon and Apache Tomcat are covered under
the terms of the Apache License, Version 2, January 2004. A copy of
the license can also be found in the same directory as this README
file.
Halcyon Neuron Core uses the Drools software developed by JBoss.
The object code can be found here:
./packages/Solaris/HALhmfcon/reloc/HMF/lib/drools/
Drools is covered under the terms of the Apache License, Version
2, January 2004. A copy of the license can also be found in the
same directory as this README file.
Halcyon Neuron Core uses the Ehcache software developed by Luck
Consulting Pty Ltd. The object code can be found here:
./packages/Solaris/HALhmfcon/reloc/HMF/lib/ehcache/
Ehcache is covered under the terms of the Apache License, Version
2, January 2004. A copy of the license can also be found in the
same directory as this README file.
Halcyon Neuron Core uses the BlazeDS software developed by Adobe
Systems Inc (http://opensource.adobe.com/wiki/display/blazeds/BlazeDS/)
The source code can be found here:
http://www.halcyoninc.com/products/OpenSource/
BlazeDS is covered under the terms of the GNU Lesser General
Public License (LGPL), Version 3. A copy of the license can also
be found in the same directory as this README file.
Halcyon Neuron Core uses the JFreeChart software developed by Object
Refinery Limited (http://www.jfree.org/jfreechart/download.html)
The source code can be found here:
http://www.halcyoninc.com/products/OpenSource/
JFreeChart is covered under the terms of the GNU Lesser General
Public License (LGPL), Version 3. A copy of the license can also
be found in the same directory as this README file.
Halcyon Neuron Core uses the j-Interop software
(http://www.j-interop.org/download.html)
The source code can be found here:
http://www.halcyoninc.com/products/OpenSource/
j-Interop is covered under the terms of the GNU Lesser General
Public License (LGPL), Version 3. A copy of the license can also
be found in the same directory as this README file.
Halcyon Neuron Core uses the Hibernate Core, Hibernate Entity
Manager and Hibernate Annotations software developed by Red Hat
Middleware (http://www.hibernate.org/6.html).
The source code can be found here:
http://www.halcyoninc.com/products/OpenSource/
Hibernate Core, Hibernate Entity Manager and Hibernate Annotations
are covered under the terms of the GNU Lesser General Public
License (LGPL), Version 2.1. A copy of the license can also be
found in the same directory as this README file.
Halcyon Neuron Core uses the Envers Easy Entity Auditing/
Versioning software developed by Adam Warski from
JBoss Inc (http://www.jboss.org/envers/).
The source code can be found here:
http://www.halcyoninc.com/products/OpenSource/
Envers Easy Entity Auditing/Versioning is covered under
the terms of the GNU Lesser General Public License (LGPL),
Version 2.1. A copy of the license can also be
found in the same directory as this README file.
Halcyon Neuron Core uses the JMXMP Connector software developed by
Sun Microsystem as part of the Project OpenDMK
(https://opendmk.dev.java.net/download/index.html)
JMXMP Connector is covered under the terms of the Common
Development and Distribution License (CDDL). A copy of the license
can also be found in the same directory as this README file.
Halcyon Neuron Core uses the Mibble software developed by Per
Cederberg (http://www.mibble.org). Halcyon Neuron Core runs the
Mibble as a separate executable, and is only loosely coupled
with it. The source code can be found here:
./packages/Solaris/HALhmfmib/install/mibble-2.8-application-src.tar.bz2
The Mibble is covered under the terms of the GNU General Public
License, Version 2, June 1991 (http://www.gnu.org/copyleft/gpl.html).
A copy of the license can also be found in the same directory as this
README file.
Halcyon Forums
======================================================================
Halcyon experts actively participate in the online Halcyon Forums. The
experts are constantly monitoring the forums, answering questions and
posting useful tips, tricks, and general knowledge base information.
Whether you have a technical question or just wish to expand our
knowledge base, this is the place for you.
http://forums.HalcyonInc.com
License Agreement
======================================================================
Please refer to the license agreement in the following file:
- LICENSE
Without purchasing a license, the Halcyon Neuron Core will
only operate for a trial period of 30 days from installation.
If you wish to purchase a license to use the Halcyon Neuron Core,
please contact us at:
Web: http://www.HalcyonInc.com
Email: info@HalcyonInc.com
Tel: 416-932-4647
Fax: 416-932-4711
About Halcyon
======================================================================
Halcyon delivers Infrastructure Management solutions that provide
operational visibility, availability, and reliability for business
critical services and their underlying infrastructure. Since 1994,
Halcyon solutions have been adopted by numerous Fortune 100 and SMEs,
spanning every major geography and sector.
At Halcyon, we believe the health of the IT infrastructure is integral
to the success of a business. Our clients rely on us for complete
end-to-end monitoring solutions that are straightforward, easy to
deploy and use, and cost-effective, coupled with a history of client
service excellence.
---//---