Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual
Logging Server
Logging Server
Overview
Magellan™ Diagnostic Logging provides logging information on SDNO Controller and Routing functions.
It is pre-installed on the SDNO Controller and can be accessed on port 8002 on the same IP address as the SDNO Controller .
To launch the Magellan Diagnostic Logging:
In the URL field of your browser, type
http://<Controller IP Address>:8002/
OR
Click the
Fault Log
link on the SDNO Controller dashboard.
The following is explained in this section:
Logging Server Interface (on page 294 )
Examining Logs (on page 296)
Live Logs (on page 297)
Log History (on page 298)
Clearing Logs (on page 298)
Configuring the Logging Server (on page 298)
Exporting Logs (on page 301)
Importing Logs (on page 302)
Using Summaries (on page 303)
Browser Settings
If using Internet Explorer, turn off caching to prevent any issues with content being displayed in popup windows
1.
Go to Tools > Internet Options
2.
In the General tab, click the Settings button in the Browsing History section
3.
In the Temporary Internet Files and History Settings dialog, select Every time I visit the webpage under check for newer versions of stored pages.
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 292
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual
4.
Click OK.
Logging Server
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 293
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual
Logging Server Interface
Logging Server
Figure 75: Logging Server Home tab
1
2
Table 18: Logging Server Interface Options
Item Description
3
4
5
6
Home Tab The top level Home Tab.
Diagnostic Elements The available elements to view logs for. For example, Database Service, Debug Log, etc. Note that elements are displayed depending on whether they have any related logs. For example, if a firmware upgrade has never been performed on a
Controller, logs for that will not be displayed.
History
Examine Logs
Select an element and click the
History
button to view History for the selected element
Select an element and click the
Examine Logs
button to review logs for the selected element
View Live Logs Select an element and click the
View Live Logs
button to view real time logs for the selected element
Filters and Actions Click to filter display and content preferences for logs
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 294
7
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual
Item
Export
Description
Select an element and click the
Export
button to export log information. Logs can be exported by day, week, or all.
8 Summary
9 Find
Click the Summary icon to display a Summary toolbar at the top of the page that contains shortcut links to Exports, Imports, and Collections.
Searches for the entered text on the page
Logging Server
10
11
Settings Click to view/define System-wide settings, Log
Viewer Settings, and Logging Server Settings.
Import and View Log
Collections
Click to view/access
Log collections
that can then be
examined
or
exported
. You can also
import
logs.
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 295
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual
Working with Logs
Logging Server
Examining Logs
On the
Home
tab, select devices (if no devices are selected, it’s the same as if all of them are) and click
Examine Logs
to view logs in detail.
Figure 76: Examiner Tab
6
7
2
3
1
4
Table 19: Examiner Tab
Item
5
8
Log Date
Log End Range
Description
Date to view logs from. Click the calendar icon and go to a date.
Log Start Range The Start Point of the Log Range. Click and drag to define.
The End Point of the Log Range
Date/Time Range Date and Time range for the selected log range
Next/Previous
Page
First/Last Page
Click to go to the next or previous page.
Click to go to the last or first page.
Options Click to view/define Log Options and to filter logs.
Log Range Options
Right click to view options for the selected log range. You can choose to refresh logs or export the selected range, or zoom into a selection
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 296
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual Logging Server
The top portion of the
Examiner
tab shows a timeline. To View a specific time, click the timeline with the mouse. The log examiner updates to show logs surrounding that time.
Above the timeline, you can adjust the content that is displayed by changing the date and duration. To view a different part of the log, drag the sliders. Below the timeline, messages are displayed in a static format. You can sort the log entries by clicking on column headers.
Live Logs
To view a live (real time) log, place a check beside the device on the Home page, and then click
View
Live Logs
.
Figure 77: Live Logs
If no logs are selected or all logs are selected, click
View Live Logs
and the log that opens will contain entries for all connected devices.
If no device has activity when you select View Live Logs, the viewer tab is empty. The viewer updates dynamically as events occur.
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 297
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual
Log History
Click the
History
button against a module to view Module Log History.
Logging Server
Figure 78: Logging Server History Tab
Clearing Logs
When you clear logs from the logging server, all devices are also removed. Be sure to save logs that you need prior to clearing.
1.
If the
Filters
palette is not open at the right side of the screen, click
Show Filters/Actions
.
Click
Clear All Logs
and then click
OK
. All logs and all information in the logs are removed.
When a device has activity, it will reappear on the
Home
page of the logging server.
Configuring the Logging Server
Click
Settings
in the top right corner of the screen to open the
Settings
pane.
Settings are divided into:
Network
,
Log Viewer
,
Logging Server,
and
System Wide
settings.
When you make any changes to the Logging Server’s settings, click
Save Settings
to commit changes.
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 298
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual Logging Server
For the most part, don’t change port numbers and other settings except on the advice of Customer
Service.
If your logging server is not receiving any messages, despite having devices configured, check the
Send
Messages over SysLog option under
Network Settings. If this item is not checked, no messages will be received.
Changing Columns That Appear in the Logging Server
1.
In the
Settings > Log
Viewer section, scroll down to
Column Preferences
.
Figure 79: Column References Selector in the Logging Server
The items in the
Available
list on the left are not currently used in the Log display. Items in the
Visible
list on the right are column headers in the Log display.
To move items from one column to the other, click on the item and hold the mouse down while dragging from one column to the other. When you see a shadow of the item in the column you’re dragging to, release the mouse button. The item appears at the point in the list where you dropped it.
You can change column order by dragging items within a column.
Note:
You can also drag column headers on the table interfaces themselves.
Click
Save Settings
to commit the changes.
Changes to columns are universal and apply to all examiner pages.
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 299
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual Logging Server
Changing (Filtering) the Content Displayed in the Examiner
In addition to sorting a log file by the display columns, you can choose to view only certain types of logs.
Follow these steps:
1.
Click
Show Filters/Actions
.
The
Filters
palette appears at the right side of the screen.
2.
Place checks beside types of information you would like to see in the
Examiner
.
You can only filter out information.
3.
Click
Apply
. The table refreshes to display the selected information.
Interpreting Messages in the Logging Server
Information such as
Date
,
Time
,
Level
, etc., in the logging server is defined by the logging server itself; see the Logging Server’s documentation for more information on those items.
The
Application
field in the logging server tells you which component the message is from, for example,
Platinum IP3 Diagnostics
. The
Message
field is specific to the particular device. A single device action, such as a Take, can trigger numerous messages in the log, as the repercussions of that action are executed.
The message field of a typical log entry is separated by commas, and contains the following information:
The source of the change, for example: Operation, meaning an operator performed an action)
The device where the action took place, for example RCP: IP address, meaning a specific remote control panel triggered an action
The item that was triggered
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 300
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual
The action that happened as a result of the triggered item
Logging Server
Message Types
Error:
This level is reserved for problems that directly affect output, such as loss of signal and loss of reference. High-priority CCSP alarms with a level of
Critical
generate this message when asserted.
Warning
: This level notifies about potential problems. Medium-priority CCSP alarms with a level of
Warning
generate this message when asserted.
Notice
: These messages apply to all alarm de-assertions and RCP connection messages.
Informational
: This level indicates routine device operation.
Debug
: This level is disabled by default and only intended for use in specific troubleshooting guided by tech support.
Informational messages will be generated for all operational changes from control sources enabled in the logging server setup. Control by RCP will list the IP of the device to identify which one performed the operation. Other sources have a sole source available - all Automation message are assumed to come from the same source, but EAS is considered another source. All messages control from the parametric system are identified as CCSP.
Import and Exporting Logs
Exporting Logs
When you export a log, it is saved as a zip file that contains an XML file. Do one of the following:
Logging Server Home Page
From the Logging Server’s
Home
page, do either of the following:
At the right end of the header line, click
Export
, enter Duration and Format, and then click
Export
again.
Place checks beside items in the Devices and Application Profiles list, and then click
Show
Filters/Actions
, and click
Export
under
Actions
. All selected logs (any log with a check beside it) are exported.
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 301
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual
Examiner Tab
From the Examiner, click
Show Options
, and then, under
Actions
, click
Export
.
Logging Server
History Tab
From the
History
tab, place a check beside the logs you want to export, and then click
Export
.
Importing Logs
The Logging Server can import logs that it or another Logging Server has saved. To import a log, follow these steps:
1.
Click
Import and View Log Collections
at the bottom of the
Home
page. This enables you to see past log collections or to import logs.
The lower section of the screen expands to display details.
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 302
Magellan™ SDN Orchestrator
Installation, Configuration, and Operation Manual
2.
Click
Import Logs
and then browse to a .zip or .magellanlog file and click
Open
.
Logging Server
A progress bar appears, and when the import is finished, an
Import Complete
message appears in the top right corner of the screen.
3.
Click an item in the
Log Collections
column on the left.
The
Collection Devices
column updates to display all devices contained in that collection.
4.
Place a check beside each device log you would like to load in the Examiner, and then click
Examine
Logs
.
5.
The logs open in the
Examiner
.
Using Summaries
If you have recently imported or exported a log, the
Summary
bar appears below the button bar at the top of your Logging Server screen. If the Summary bar is not open, click
Summary
to open it. Click the X at the end of the toolbar to close it.
Figure 80: Summary Toolbar
The Summary bar has three options:
Exports
,
Imports
, and
Collections
.
Click one of these options to open the
Summary Details
dialog box.
The three options correspond to three tabs on the
Summary Details
dialog box.
Each tab details recent activity for that area of the interface.
© 2016 Imagine Communications Corp.
Proprietary and Confidential.
Version 2.0 | Page 303
