Install OneClick with Report Manager

casp1032
This section describes how to install OneClick with
Spectrum Report Manager
. For more information, see the Installing section.
We recommend that you back up the reporting data on the installation server before you upgrade from an earlier version of OneClick with
Spectrum Report Manager
.
Best Practices While Migrating SRM
Review the migration process is the best thing for your business needs. For example, if you only leave 30 days' worth of data in Spectrum Report Manager but leave 45 days worth in your Archive Manager DDMDB - moving the database is not recommended since Report Manager can process those 30 days from the DDM. Follow the migration process only if you keep more data in SRM than stored in the DDMDB.
The following are the best practices we recommend while migrating SRM:
  • Anytime the Spectrum modeling database (SSdb) is backed up, the Archive Manager database (DDMDB) and Reporting databases should also be backed up to maintain the three database synchronization.
  • If an SSdb is reloaded, the other two databases should also be reloaded. This is not always possible because the reporting database takes up so much space. However, migration is recommended.
  • If the SSdb is reloaded but the others are not you will have an SSdb that does not have certain data that the Reporting database may have, like an outage or a newly created model.
Migrate Report Data from a Previous Report Manager During OneClick Installation
During the installation of OneClick with
Spectrum Report Manager
, you are prompted to migrate report data from a remote (source) reporting database to the new
DX NetOps Spectrum
reporting database. The prompt applies to upgrade situations where data from a previous installation is preserved. This migration is optional. Therefore, you can either accept or decline the migration.
If you prefer to migrate data, enable access to the source report database from the remote server as described in this section.
Follow these steps:
  1. Launch a MySQL client session on the source server with root account credentials. For example:
    oscmdline> ./mysql -uroot -p<localrootpassword>;
  2. Let data be extracted from the source database by a remote account. You can provide temporary access to a remote root account.
    For example, if the
    DX NetOps Spectrum
    target OneClick Linux server is named target-linux.ca.com, issue the following command at the MySQL command line:
    mysql> GRANT ALL PRIVILEGES ON *.* TO 'root'@'target-linux.ca.com' IDENTIFIED BY '<remoterootpassword>';
    Provide the fully qualified host name.
  3. Verify that this new permission is available to all existing sessions by issuing the following command:
    mysql> FLUSH PRIVILEGES;
  4. (Windows Only) Verify that Windows Firewall settings on the source server allow remote connections to MySQL.
    1. Click Start, Control Panel, and then Windows Firewall.
    2. Under the Exceptions tab, click Add Port and configure values as follows:
      • Enter
        MySQL
        for the name.
      • Enter
        3306
        for the Port Number.
      • Select
        TCP
        .
    3. (Optional) Click Change to restrict the scope of access to MySQL.
    4. Specify the location of your
      DX NetOps Spectrum
      server.
    5. Configure the option to allow remote connections to MySQL only from the migration destination server. For more information, see Windows Help and Support.
    Access to the report database on the Windows server is enabled.
Prepare for the Migration
Before you start migrating the data, verify the connection between the source and destination server databases. Verify that the data you plan to migrate is updated.
Follow these steps:
  1. Verify the database connection to the remote host containing data that you plan to migrate. Issue the following command on the
    DX NetOps Spectrum
    server:
    telnet <remote-srm-host> 3306
    The following message indicates that the permissions have been set properly:
    Escape character is '^]'. 7 4.1.11-nt î&#9786; t#J0Mu'] ,&#9787; #2p^giYa]0t{ &#9644; &#9786;&#9830;#08S01Bad handshakeConnection closed by foreign host.
    The following message indicates that the permissions have not been set correctly:
    Q &#9830;#HY000Host 'user.com' is not allowed to connect to this MySQL server Connection closed by foreign host.
    If you are unable to connect to the MySQL server, verify that your MySQL permissions are configured correctly on your previous SRM MySQL database. Verify that the privileges are flushed before you reattempt to connect.
  2. Stop all reporting processes on the remote, source server by removing all entries from the
    Spectrum Report Manager
    Admin Tools,
    DX NetOps Spectrum
    Status option.
  3. Wait for 5 minutes to verify that any outstanding data changes are committed to the report database.
    The root database account on the remote destination server can extract report data on the source server.
    The connection is verified.
Post Migration
Perform the following tasks after migration:
  • Enable the integration of
    DX NetOps Spectrum
    with CABI. For more information, see Business Objects Integration.
    If you have integrated
    DX NetOps Spectrum
    with CABI before migration, we recommend disabling the previous integrations.
  • To ensure that the most recent reporting content (such as Crystal Reports) is available, update the existing content that is installed by
    DX NetOps Spectrum
    in Business Objects. For more information, see Manage Business Objects Content.
Initialization Considerations for InnoDB Storage
With 9.4, reporting data is now stored using only the InnoDB storage-engine based tables.
For new installations,
Spectrum Report Manager
automatically ensures that InnoDB is used for all of the reporting tables.
For upgrade installations,
Spectrum Report Manager
migrates all the reporting tables from MyISAM to InnoDB.
Before you upgrade, verify that the amount of free disk space on the system is at least twice the size of the largest MYD file under
$SPECROOT
/mysql/data/reporting.
Calculating Disk Requirements for Event Storage
Use the following formula to estimate the amount of disk space that is required to support the reporting database for a specific amount of time.
Total Gigabytes Required = ((Number of Devices) * (Average Number of Events per Device per Day) * (Number of Days Storage Required) * (Average Size of Event in Kilobytes)) / 1048576
The following variables are used:
  • Number of Devices - The number of devices at your site. Consider the future growth of your site when determining this value.
  • Average Number of Events per Device per Day - The total number of events that are generated on a daily basis that are associated with a single device model. This number includes all events that would result from related application, port, and interface models. The easiest way to get an approximation is to look at the total number of events that were generated on a single
    SpectroSERVER
    in a single day and divide it by the number of devices that are modeled on that
    SpectroSERVER
    .
  • Number of Days Storage Required - The number of days that your site requires storage.
  • Average Size of Event in Kilobytes - An estimation of the amount of disk space a single event ends up consuming in the Reporting database.
  • 1048576 - A conversion factor for gigabytes.
In addition to the number of devices and the number of days of storage, two variables are required to estimate the database size:
  • Average Number of Events per Device per Day
    Query the DDMDB to see the average number of events that are generated on a given day.
    If you are a new
    DX NetOps Spectrum
    user and do not know the average number of events, use a default value. Three hundred events per day, per device for 500 devices would equate to 150,000 events a day. Therefore, 300 would be a reasonable default value.
  • Average Size of Each Event in Reporting DB
    An appropriate amount of space to store your average event and corresponding records is 1 KB. This number can increase if most of the events that are being handled are large events that contain much data. Also the types of events affect data size. Alarm events turn into multiple reporting table records. Network Configuration Manager (NCM) events only affect a single table (event).
Here are some examples:
Example A - User has 600 devices and wants to keep data for 4 years (1460 days).
The user does not know how many events per device, therefore consider 300 as the default value.
Total GBs required = (600 * 300 * 1460 * 1) / 1048576 Total GBs required = 262,800,000 / 1,048,576 Total GBs required = 250 GBs
Example B - User has 1900 devices across three servers and wants to keep data for 2 years (730 days).
The user seems to be averaging 400 events per device, per day. In this example, the three servers are not considered.
Total GBs required = (1900 * 400 * 730 * 1) / 1048576 Total GBs required = 554,800,000 / 1,048,576 Total GBs required = 530 GBs
How to Calculate Average Daily Event Rate per Device
To estimate the average daily number of events that generated per device, you first need to know how many events get generated each day. Use the following queries on the DDMDB database.
The following query returns the total event count for the last ten days:
SELECT date(from_unixtime(utime)) as x, count(*) as cnt FROM event GROUP BY x ORDER BY x DESC LIMIT 10;
The following query returns the 10 days with the highest event volume and the event volume for each day::
SELECT date(from_unixtime(utime)) as x, count(*) as cnt FROM event GROUP BY x ORDER BY cnt DESC LIMIT 10;
Use the result of these queries to come up with a reasonable event count. Once you know the event count, divide the number of events by the total number of modeled devices on the server to derive the average event count per device, per day.
Report Manager Installation
You can install OneClick with
Spectrum Report Manager
by specifying
Spectrum Report Manager
as a feature selection during the OneClick installation process. To install
Spectrum Report Manager
, you need OneClick, however,
Spectrum Report Manager
is not required to run OneClick. During installation, you can migrate the report data from a previous
Spectrum Report Manager
installation.
The disk space that is required for a
Spectrum Report Manager
upgrade installation is two times the table size for each table that is converted to InnoDB. If enough space is not available, the installer displays a warning.
Multiple
Spectrum Report Manager
installations using a common set of
SpectroSERVER
s can result in inconsistencies between the primary and secondary
Spectrum Report Manager
installations.
Follow these steps:
  1. Select the
    Spectrum Report Manager
    option from the Select Features window during the installation.
  2. When prompted during the installation, specify the names of the
    DX NetOps Spectrum
    servers from which you want
    Spectrum Report Manager
    to collect data.
    The
    Spectrum Report Manager
    Servers dialog lets you specify the names of more
    DX NetOps Spectrum
    servers, in addition to the primary server specified for OneClick. You can also modify the servers list after you have completed the installation using
    Spectrum Report Manager
    Admin Tools.
    Use
    DX NetOps Spectrum
    landscape names to specify servers.
  3. Select to migrate historical report data associated with a previous release of OneClick with
    Spectrum Report Manager
    to the new reporting database.
    • If you select to migrate reporting data, specify the following options:
      1. Specify the host from which you want to migrate the data in the Source host name field.
      2. Enter the password to access the MySQL installation on the remote server in the Source Host 'root' Database Password and Verify Password fields. The default password is ‘root’.
      3. Click Next.
    • If you do not want to migrate reporting data, do not type any values in the window and click Next.
  4. Follow the onscreen instructions, to continue the OneClick installation.
    OneClick with
    Spectrum Report Manager
    is installed successfully.
Spectrum Report Manager
and Fault Tolerance
Support for fault tolerance exists for the
DX NetOps Spectrum
application, but does not extend to the
Spectrum Report Manager
component. Architectural limitations within the
Spectrum Report Manager
do not enable a Fault Tolerant configuration beyond standard database/file replications.
Multiple
Spectrum Report Manager
installations using a common set of
SpectroSERVER
s can result in inconsistencies between the primary and secondary
Spectrum Report Manager
installations. The inconsistencies occur due to the lack of an integrated fault tolerance architecture within the
Spectrum Report Manager
components.
Verify Installation by Testing Access Methods
Verify the
Spectrum Report Manager
environment after installing OneClick with
Spectrum Report Manager
. Verify that all of the
SpectroSERVER
s have started.
Follow these steps:
  • Open BI Launch Pad from the OneClick web console and run several
    DX NetOps Spectrum
    reports.
    For more information, see the Report Manager section.
    If you do not install OneClick with
    Spectrum Report Manager
    correctly, then you cannot
    generate reports or notice any other application irregularities. For more information, see Troubleshooting.
Upgrade the Report Parameter Pages
If you update
Spectrum Report Manager
, run the spectrum-wkp-update.bat tool on the CABI server that is integrated with
Spectrum Report Manager
. The spectrum-wkp-update.bat tool downloads updated files from the
DX NetOps Spectrum
web server and deploys them on the CABI server.
Procedure for Windows
Follow these steps:
  1. Open Command Prompt.
  2. Run the following command (words in italics indicate installation-specific values):
    % cd "C:/Program Files/CA/SC/CommonReporting3/spectrum" % spectrum-wkp-update.bat -host http://spectrum-hostname:port -username admin_name -password admin_password
    The -host flag can also specify an https URL, if SSL is configured on
    DX NetOps Spectrum
    .
  3. Follow the onscreen instructions to upgrade the Report Parameter pages.
    Report Parameter pages are upgraded.
Procedure for Linux
Follow these steps:
  1. Open Command Prompt.
  2. Run the following command (words in italics indicate installation-specific values):
    % cd /opt/CA/SharedComponents/CommonReporting3/spectrum % spectrum-wkp-update.sh -host http://spectrum-hostname:port -username admin_name -password admin_password
    The -host flag can also specify an https URL, if SSL is configured on
    DX NetOps Spectrum
    .
  3. Restart the Tomcat server.
    The process to upgrade the Report Parameter pages is completed.
Migrate Report Data from a Previous Report Manager After OneClick Installation
As hardware updates become available, there may be times you need to move your software products from an older system to a newer one. To move the database ensure you meet the following requirements:
  1. Landscape handles names MUST remain the same.
    Else SRM treats them as new landscapes and report them separately.
  2. The new system MUST have ample disk space to handle the new database plus some for new data and in the event a repair needs to be done (2x the largest table - For example, 100GB table, 200GB free space is needed to repair).
  3. The new system MUST have the exact version of
    DX NetOps Spectrum
    the old system had on it (including
    DX NetOps Spectrum
    patches),
Backup the Database
Follow these steps:
  1. Shutdown Spectrum Tomcat Service (This will prevent any potential writes to the database while it's backed up).
  2. Navigate a bash shell to the
    $SPECROOT/mysql/bin
    directory and run the following command:
    mysqldump --defaults-file=../my-spectrum.cnf --opt --routines --ignore-table=reporting.v_active_user_model --ignore-table=reporting.v_alarm_activity --ignore-table=reporting.v_ncm_config_diff --ignore-table=reporting.v_security_string_accessibility_by_landscape--ignore-table=reporting.v_user_report_security --compress -uroot -p<root_pw> --databases reporting > <dump_log>
    Backup process may take a while to complete based on the database size and system resources available. We recommended not run any other process till the backup is completed.
    You can find the
    dump_log
    file in LOCATION. Compress the file using any compression tool like the zip to transfer the file to the new system.
  3. Move the
    dump_log
    file to the $SPECROOT/mysql/bin directory.
  4. Shutdown
    DX NetOps Spectrum
    Tomcat Service
  5. Navigate a bash shell to
    $SPECROOT/mysql/bin
    directory and run the following command:
    mysql --defaults-file=../my-spectrum.cnf -uroot -p<root_pw> reporting < <dump_log>
    For example:
    mysql --defaults-file=../my-spectrum.cnf -uroot -proot reporting < reporting_db_backup_2012_10.sql
    The database restore process may take a while to complete based on the database size and system resources available. We recommended not run any other process until the database is restored.
Set Up Report Manager to Process Data From a Migrated DDMDB
If you do not copy the database and want to set up a Report Manager to process data from a migrated DDMDB follow this process on the SRM host.
Follow these steps:
  1. Navigate to
    $SPECROOT/bin
    directory.
  2. Run the following command:
    ./RpmgrInitializeLandscape <username> <password> [-skipInitialHistory] [-initHist <#of days>] [-slm] [-all] [<landscape1> <landscape2> ...]
    For example: ./RpmgrInitializeLandscape root root -initHist 45 -all
    The command removes all SRM data currently existing in the SRM database and start processing new data from the DDMDBs.