NetSpyGlass
2.2
1. Release Notes
1.1. Release Notes 2.2.4
1.1.1. This is a bug fix release in v2.2.x series
1.1.2. Improvements and bug fixes
1.2. Release Notes 2.2.3
1.2.1. This is a bug fix release in v2.2.x series
1.2.2. Improvements and bug fixes
1.3. Release Notes 2.2.2
1.3.1. This is a bug fix release in v2.2.x series
1.3.2. Improvements and bug fixes
1.4. Release Notes 2.2.1
1.4.1. This is a bug fix release in v2.2.x series
1.4.2. Improvements and bug fixes
1.5. Release Notes 2.2.0
1.5.1. Highlights
1.5.2. Improvements and new features
1.5.2.1. Ability to use MySQL hosted by Azure
1.5.3. Bugs fixed in this release
1.6. Release Notes 2.1.3
1.6.1. Improvements and new features
1.6.2. Bugs fixed in this version
1.7. Release Notes 2.1.2
1.7.1. Improvements and new features
1.7.2. Bugs fixed in this version
1.8. Release Notes 2.1.1
1.8.1. Improvements and new features
1.8.2. Bugs fixed in this version
1.9. Release Notes 2.1.0
1.9.1. NetSpyGlass v2.1.0
1.9.2. Improvements, Important Changes and New Features
1.9.2.1. General
1.9.2.2. UI
1.9.2.3. Configuration
1.9.2.4. Alerts
1.9.2.5. Support for New Hardware Vendors and Devices
1.9.2.6. Support for SNMPv3
1.9.2.7. ‘Discovery’ of the polling configuration
1.9.2.8. Changes and Improvements in Network Discovery
1.9.2.9. NsgQL
1.10. Release Notes 2.0.4
1.10.1. Improvements and New Features
1.10.2. Bug fixes
1.11. Release Notes 2.0.3
1.11.1. Improvements and New Features
1.11.2. Bug fixes
1.12. Release Notes 2.0.2
1.12.1. Improvements and New Features
1.12.2. Bug fixes
1.13. Release Notes 2.0.1
1.13.1. Improvements and New Features
1.13.2. Bug fixes
1.14. Release Notes 2.0.0
1.14.1. Improvements, Important Changes and New Features
1.14.2. Bug fixes
1.15. Release Notes 1.6.3
1.15.1. Improvements, Important Changes and New Features
1.15.2. Bug fixes
1.16. Release Notes 1.6.2
1.16.1. Improvements, Important Changes and New Features
1.16.2. Bug fixes
1.17. Release Notes 1.6.1
1.17.1. Improvements and New Features
1.17.2. Bug fixes
1.18. Release Notes 1.6.0
1.18.1. Bug Fixes
1.19. Release Notes 1.5.5
1.19.1. Important
1.19.2. Improvements and New Features
1.20. Release Notes 1.5.4
1.20.1. Important
1.20.2. Improvements and New Features
1.20.3. Bug fixes
1.21. Release Notes 1.5.3
1.21.1. Improvements and New Features
1.21.2. Bug fixes
1.22. Release Notes 1.5.2
1.22.1. Improvements and New Features
1.22.2. Bug fixes
1.23. Release Notes 1.5.1
1.23.1. Improvements and New Features
1.23.2. Bug fixes
1.24. Release Notes 1.5.0
1.24.1. Improvements and New Features
1.24.2. Bug fixes
1.25. Release Notes 1.4.1
1.25.1. Improvements and New Features
1.25.2. Bug fixes
1.26. Release Notes 1.4.0
1.26.1. New features
1.26.2. Bug fixes
1.27. Release Notes 1.3.0
1.27.1. New features
1.27.2. Bug fixes
1.28. Release Notes 1.2.0
1.28.1. New features
1.28.2. Bug fixes
1.29. Release Notes 1.1.0
1.29.1. New features
1.29.2. Changes
1.30. Release Notes 1.0.6
1.30.1. New features
1.30.2. Bug fixes
1.31. Release Notes 1.0.5
1.31.1. New features
1.31.2. Bugs fixed in this version
1.32. Release Notes 1.0.4
1.32.1. New features
1.33. Release Notes 1.0.3
1.33.1. New features
1.33.2. Improvements in the Server
1.33.3. Bugs fixed in this version
1.34. Release Notes 1.0.2
1.34.1. New features
1.34.2. Improvements in the Server
1.34.3. Changes in the Monitor
1.35. Release Notes 1.0.1
1.35.1. Important changes
1.35.1.1. Change in the user-defined report scripts
1.35.2. Improvements in the Server
1.35.3. Other Changes
1.36. Release Notes 1.0.0rc2
1.36.1. Improvements in the Server
1.36.2. Bugs fixed in this release
1.37. Release Notes 1.0.0rc1
1.37.1. Improvements in the Server
1.37.2. Improvements in the Monitor
1.37.3. Improvements in the Python library of functions used to process monitoring data
1.37.4. Bugs fixed in this release
1.38. Release Notes 0.99.1
1.38.1. New Features
1.38.2. Packaging
1.38.3. Bugs fixed in this release
1.38.4. Other improvements
1.38.5. JSON API
1.39. Release Notes 0.98.4
1.39.1. New Features in this release
1.39.2. Packaging
1.39.3. Bugs fixed in this release
1.40. Release Notes 0.98.3
1.40.1. Important changes in this release
1.40.2. Code changes and other internal changes
1.40.3. Start/stop shell script netspyglass.sh
1.40.4. Configuration
1.40.5. User Interface
1.40.6. Documentation
1.40.7. Device discovery
1.40.8. Monitoring and data processing
1.40.9. Changes in the Data Processing Python Scripts
1.40.10. Scalability
1.41. Release Notes 0.98.2
1.41.1. Important changes in this release
1.41.1.1. Network Discovery and Monitoring
1.42. Release Notes 0.98.1
1.42.1. Important changes in this release
1.42.2. Improvements in this release
1.42.3. User Interface
1.43. Release Notes 0.98
1.43.1. Important changes in this release
1.43.2. Improvements in this release
1.43.2.1. Startup scripts
1.43.2.2. Tags
1.43.2.3. Network Discovery and Monitoring
1.43.2.4. User Interface
1.43.2.5. Infrastructure
1.43.2.6. Configuration file format changes
1.44. Release Notes 0.974
1.44.1. Improvements in this release
1.45. Release Notes 0.973
1.45.1. Bugs fixed in this release
1.46. Release Notes 0.972
1.46.1. New features and improvements in UI
1.46.2. New features and improvements in Monitor
1.46.3. Bugs fixed in this release
1.47. Release Notes 0.971
1.47.1. Notable Bugs fixed in this release
1.48. Release Notes 0.97
1.48.1. Important changes in this release
1.48.2. New features and improvements in UI
1.48.3. New features and improvements in the Monitor
1.48.4. Notable Bugs fixed in this release
1.48.5. Known issues in this release
1.49. Release Notes 0.967
1.49.1. Important changes in this release
1.49.2. New features and improvements in UI
1.49.3. New features and improvements in the Monitor
1.49.4. Notable Bugs fixed in this release
1.50. Release Notes 0.965
1.50.1. Important changes in this release
1.50.2. New features and improvements in this release
1.50.3. Notable Bugs fixed in this release
1.51. Release Notes 0.965
1.51.1. Important changes in this release
1.51.2. New features and improvements in this release
1.51.3. Notable Bugs fixed in this release
1.52. Release Notes 0.964
1.52.1. New features and improvements in this release
1.52.2. Notable Bugs fixed in this release
1.53. Release Notes 0.963
1.53.1. New features and improvements in this release
1.53.2. Notable Bugs fixed in this release
1.54. Release Notes 0.962
1.54.1. New features and improvements in this release
1.54.2. Bugs fixed in this release
1.55. Release Notes 0.961
1.55.1. New features and improvements in this release
1.55.2. Bugs fixed in this release
1.56. Release Notes 0.96
1.56.1. New features and improvements in this release
1.56.2. Bugs fixed in this release
1.57. Release Notes 0.951
1.57.1. New features and improvements in this release
1.57.2. Bugs fixed in this release
1.58. Release Notes 0.95
1.58.1. Highlights
1.58.2. New features and improvements in this release
1.58.3. UI
1.58.4. Monitoring and Processing of Collected Data
1.58.5. Core Technology
1.58.6. Improvements in Device Discovery and Monitoring
1.58.7. Notable bugs fixed in this release
1.59. Release Notes 0.941
1.59.1. New features and improvements in this release
1.60. Release Notes 0.94
1.60.1. New features and improvements in this release
1.60.2. Known issues in this release
1.61. Release Notes 0.93
1.61.1. New features and improvements in this release
1.61.2. Known issues
1.62. Release Notes 0.92
1.62.1. New features in this release
1.62.2. Documentation
1.62.3. Known issues
1.63. Release Notes 0.91
1.63.1. Main Features Available in this Release
1.63.2. Known Issues
2. Installation and Configuration
2.1. Installation and Configuration using rpm or deb package
2.1.1. Installation
2.1.1.1. Startup configuration file /etc/edfault/netspyglass
2.1.2. Running the Server
2.1.2.1. Starting and stopping NetSpyGlass
2.1.3. Zookeeper
2.2. Installation and Configuration using package in tar format
2.2.1. Installation
2.2.2. Running the Server
2.2.2.1. Starting and stopping NetSpyGlass
2.2.2.2. Upgrade
2.2.2.3. Starting the server for the first time
2.3. How to install license file
2.4. Configuration
2.4.1. Polling Configurations
2.4.2. Adding Network Devices
2.4.2.1. Using Scripts to Add Devices
2.4.3. Network Discovery
2.4.3.1. Schedule
2.4.4. Configuration file syntax
2.4.4.1. Basic rules of the config file format
2.5. Running NetSpyGlass via encrypted HTTP connection
2.5.1. Keystore
2.6. User Authentication
2.6.1. Unprotected mode
2.6.2. Protected mode
2.6.2.1. Using locally stored user names and passwords
2.6.2.2. Using external LDAP server (OpenLDAP)
2.6.2.3. Using external LDAP server (Active Directory)
2.6.2.4. Using Combination of Authentication Modules
2.6.2.5. Role Based Authorization
2.6.2.6. Debugging User Authentication and Authorization Problems
2.6.3. Using access tokens for script access to API
2.6.4. Running NetSpyGlass behind reverse proxy with authentication
2.6.4.1. How to configure NetSpyGlass to parse HTTP header to extact user name
2.6.5. UI indication of successful authentication
2.6.5.1. Example: using Apache web server as proxy
2.6.5.2. How to limit access to NetSpyGlass running behind the proxy
2.7. Databases
2.7.1. Running NetSpyGlass with embedded database HSQLDB
2.7.2. Running NetSpyGlass with MySQL
2.7.3. Running NetSpyGlass with Postgresql
2.7.4. Examples
2.7.5. How to migrate from embedded HSQLDB database to MySQL
2.7.5.1. Prerequisites
2.7.5.2. Migration Process
2.8. Time Series Database
2.8.1. Configuration
2.8.2. RRD
2.8.2.1. Configuration
2.8.3. Graphite
2.8.3.1. Configuration
2.8.3.2. Schema
2.8.3.3. Variable, device and interface names
2.8.4. InfluxDb
2.8.4.1. Versions
2.8.4.2. Configuration
2.8.4.3. Schema
2.8.4.4. Tags
2.8.4.5. Queries using tags
2.8.4.6. Retention Policies
2.8.5. hbase
2.8.5.1. Configuration
2.8.5.2. Schema
2.9. Data Export to External Systems and Services
2.9.1. Data Export to DataDog
2.10. Cluster configuration
2.10.1. Command line parameters
2.10.1.1. Zookeeper
2.10.1.2. Namespace
2.10.1.3. Name, Role and Region
2.10.2. Cluster Configuration
2.10.2.1. Configuration file
cluster.conf
2.10.2.2. Configuration file
nw2.conf
2.10.3. Known limitations as of time of this release
2.10.4. Examples of cluster configurations
2.10.4.1. Single server configuration (the default)
2.10.4.2. Primary server and several monitors
2.10.4.3. Dedicated compute server
2.10.4.4. Dedicated compute and alerts servers
2.11. High Availability
2.11.1. Configuration
2.11.2. Health Checks
2.12. Distributed Monitoring and Discovery Strategies
2.12.1. SNMP Polling
2.12.2. Configuration
2.12.3. Device Allocation
2.12.4. Zookeeper
2.12.5. Single server, single monitor
2.12.6. Single server, multiple monitor servers in one location
2.12.7. Multiple servers and monitors in one region
2.12.8. Multiple regions
2.13. Performance tuning
2.13.1. Java Command line
2.13.2. Data Push Tuning
2.14. Hardware Requirements
2.15. Distribution Packages
2.16. Supported Browsers
3. Log Files
3.1. UI backend
4. Views
4.1. Building Your Own Views
4.2. Examples of Views
4.2.1. Matching Rules for Hierarchical Views
4.2.2. Class View
4.3. Examples of Hierarchical Views
4.3.1. Clusters
4.3.2. Virtualization
5. Data Flow
6. Monitoring Variables
6.1. How Monitoring Variables are Stored
6.2. Python hook scripts that create Monitoring Variables
6.2.1. Selection of components to monitor
6.2.2. The structure of the variable definition dictionary
6.3. How to override the defaults
6.3.1. Example 1: making NetSpyGlass monitor specific interfaces that are not monitored by default
6.3.2. Example 2: making NetSpyGlass poll packet rate counter OIDs for network interfaces
6.3.3. Example 3: making NetSpyGlass monitor duplex/half-duplex mode of network interfaces
6.4. Report
6.5. Data Display
6.5.1. How to change or add data display rules
6.6. String Monitoring Variables
7. Tags
7.1. Tag Facets
7.1.1. Tags that describe device
7.1.2. Tags that describe interfaces
7.2. How Tags are Assigned
7.3. Tag Selector Class
7.4. User Defined Device Tags
7.4.1. User Defined Interface Tags: Parsing Interface Descriptions
8. Data Processing Rules
8.1. Summary
8.2. Configuration
8.3. How to access monitoring variables
8.4. How does this work
8.5. Examples
8.5.1. Converting interface counters to interface utilization
8.5.2. Calculate interface utilization as percentage of speed
8.5.3. max()
8.5.4. group_by_device()
8.5.5. Filtering by tags
8.5.6. Print variable attributes to log
8.5.7. Tag manipulation
8.5.8. Calculating aggregates
8.5.8.1. Aggregates and NaN values
8.5.9. Calculating average value using data that fits in the memory buffer
8.5.10. Calculating 95 percentile
8.5.11. Calculating weekly peak values
8.5.12. Calculating long term average values
8.5.13. Operations with string variables
8.5.14. Calculating total monthly traffic value (data cap)
8.5.15. Difference between functions new_var() and get_or_create()
9. Reporting Framework
9.1. Configuration
9.2. How to Access Reports via NetSpyGlass UI
9.3. Report Scripts
10. Alerting
10.1. Configuration
10.2. Alerting rules
10.2.1. Alert state
10.2.2. Fan Out
10.2.3. Conditions with timing
10.3. Classes and Functions
10.3.1. Alert
10.3.1.1. Attributes
10.4. Silences
10.5. Script silence.py
10.6. Alert Notifications
10.7. Notification streams
10.7.1. Macros
10.7.2. Mixing Macros and configuration parameter expansion
10.7.3. Log
10.7.4. Email
10.7.5. Slack
10.7.6. HipChat
10.7.7. PagerDuty
10.7.8. Jira
10.7.8.1. Deduplication
10.7.8.2. Example
10.7.8.3. How to add custom Jira field
10.7.9. DataDog
10.8. Examples
10.8.1. busyCpuAlert
10.8.2. deviceDown
10.8.3. bigChangeInVariables
10.8.4. lagPartiallyDegraded
10.8.5. interfaceDown
10.8.6. bgpSessionDown: alert with dependencies
10.8.7. Alert Modules
10.9. Using alerts with Nagios
11. Integration with Nagios
11.1. Configuration
11.2. Monitoring Devices
11.3. Monitoring NetSpyGlass Server
11.4. Installation
11.5. Use Cases
11.6. Examples
11.7. Using Nagios with NetSpyGlass Alerts
12. Testing Framework
12.1. Running tests
12.2. Utility functions
12.3. Context object
12.4. Alert object
12.5. Examples of Unit Tests
12.5.1. Test Alert and its Fields
13.
nw2functions
— Operations with monitoring variables
13.1. Summary
13.2. Classes and Functions
14. Java classes that can be accessed from Python scripts
14.1. Summary
14.2. Classes and Functions
14.2.1. MonitoringVariable
14.2.1.1. Attributes
14.2.1.2. Instance Methods
14.2.2. Statistics
14.2.2.1. Methods
14.2.3. TimeSeries
14.2.3.1. Methods
14.2.3.2. Python “magic” methods
14.2.4. Observation
14.2.4.1. Attributes
14.2.4.2. Methods
14.2.4.3. Python “magic” methods
14.2.5. DataSource
14.2.5.1. Attributes
14.2.6. DataScaler
14.2.6.1. Methods
14.3. Wrappers
14.3.1. PyDevice
14.3.1.1. Attributes
14.3.1.2. Instance Methods
14.3.2. PyNetworkInterface
14.3.2.1. Attributes
14.3.3. PyHardwareComponent
14.3.3.1. Attributes
14.3.4. PyChassisAlarm
14.3.4.1. Attributes
14.3.5. PyProtocolDescriptor
14.3.5.1. Attributes
14.3.6. PyNetworkGraph
14.3.6.1. Instance Methods
14.4. Examples
15. NetSpyGlass Server Query Language
15.1. Model
15.2. SELECT
15.3. Schema
15.3.1. Table “tags”
15.3.2. Table “maps”
15.3.3. Table “devices”
15.3.4. Table “interfaces”
15.3.5. Table “alerts”
15.3.6. Table named after monitoring variables name
15.4. LIMIT and OFFSET
15.5. Column Aliases
15.6. WHERE
15.7. Time Match in WHERE
15.8. GROUP BY
15.9. Aggregation by Time
15.10. Aggregation
15.11. Transformation Functions
15.12. Command SHOW
15.13. Command DESCRIBE
15.14. Using NsgQL
15.14.1. Command Line Query Tool
15.14.2. Using NsgQL queries in Python scripts
15.15. Examples
15.16. Caching
16. NetSpyGlass Server JSON API
16.1. API v2.0
16.1.1. Status call
16.1.1.1. GET /v2/ui/net/:id/status[?s=order]
16.1.2. Network topology and inventory (discovery data)
16.1.2.1. GET /v2/discovery/net/:id/topo?[timestamp=:time|generation=:gen]
16.1.2.2. GET /v2/discovery/net/:id/devices[?timestamp=:time|generation=:gen]
16.1.2.3. GET /v2/discovery/net/:id/devices/:devid[?timestamp=:time|generation=:gen]
16.1.3. Calls used by the UI to access information about devices
16.1.3.1. GET /v2/ui/net/:id/dashboards/device/:id
16.1.3.2. GET /v2/ui/net/:id/data/device/:devid?[format=(brief|full)][category=:name]
16.1.3.3. GET /v2/ui/net/:id/popup/device/:devid
16.1.3.4. GET /v2/ui/net/:id/popup/device/:devid/hwcomp/:idx
16.1.3.5. GET /v2/ui/net/:id/popup/device/:devid/intf/:ifIndex
16.1.4. Map Views
16.1.4.1. GET /v2/ui/net/:id/views[?type=:view_type]
16.1.4.2. GET /v2/ui/net/:id/views/:view_id
16.1.4.3. POST /v2/ui/net/:id/views
16.1.4.4. POST /v2/ui/net/:id/views/:view_id/update
16.1.4.5. DELETE /v2/ui/net/:id/views/:view_id
16.1.4.6. POST /v2/ui/net/:id/views/:view_id/share
16.1.4.7. POST /v2/ui/net/:id/views/:view_id/unshare
16.1.4.8. POST /v2/ui/net/:id/views/:view_id/validate
16.1.4.9. GET /v2/ui/net/:id/views/:view_id/map[?timestamp=:time]
16.1.4.10. GET /v2/ui/net/:id/views/:view_id/map?layout=auto
16.1.4.11. GET /v2/ui/net/:id/views/:view_id/map?layout=reset
16.1.4.12. GET /v2/ui/net/:id/views/:view_id/map?layout=fit
16.1.4.13. GET /v2/ui/net/:id/views/:view_id/preview[?devRule=NSGQL][&linkRule=NSGQL][&hide=true][&connecting=false|true][&adjacent=false|true]
16.1.4.14. GET /v2/ui/net/:id/views/:view_id/linkGraphVars
16.1.4.15. GET /v2/ui/net/:id/views/:view_id/linkVar/:lv/nodeVar/:nv[?timestamp=:time]
16.1.4.16. PUT /v2/ui/net/:id/views/:view_id/coordinates
16.1.5. Server Health Checking
16.1.5.1. GET /v2/ping/net/:netid/[se]
16.1.6. Data Query
16.1.6.1. POST /v2/query/net/:id/data/
16.1.7. Graphs
16.1.8. View Filters
16.1.8.1. POST /v2/ui/net/:id/filters/[?user=:user_name]
16.1.8.2. GET /v2/ui/net/:id/filters/[?user=:user_name]
16.1.8.3. DELETE /v2/ui/net/:id/filters/:filter_id
16.1.8.4. POST /v2/ui/net/:id/filters/:filter_id/share
16.1.8.5. POST /v2/ui/net/:id/filters/:filter_id/unshare
16.1.9. Settings
16.1.10. Integrations
16.1.11. Alerts and Alert silences JSON API
16.1.11.1. GET /v2/alerts/net/:netid/alerts[?active=true|false][rule_spec]
16.1.11.2. GET /v2/alerts/net/:netid/alerts/:alertKey
16.1.11.3. POST /v2/alerts/net/:netid/silences
16.1.11.4. POST /v2/alerts/net/:netid/silences/:id
16.1.11.5. GET /v2/alerts/net/:netid/silences/
16.1.11.6. GET /v2/alerts/net/:netid/silences/:id
17. Integration with Kentik
NetSpyGlass
Docs
»
1. Release Notes
»
1.59. Release Notes 0.941
View page source
1.59. Release Notes 0.941
¶
1.59.1. New features and improvements in this release
¶
Map zoom control now works.
NetSpyGlass
v: 2.2.x
Versions
2.0.x
2.1.x
2.2.x