NetSpyGlass
2.0
1. Release Notes
1.1. Release Notes 2.0.4
1.1.1. Improvements and New Features
1.1.2. Bug fixes
1.2. Release Notes 2.0.3
1.2.1. Improvements and New Features
1.2.2. Bug fixes
1.3. Release Notes 2.0.2
1.3.1. Improvements and New Features
1.3.2. Bug fixes
1.4. Release Notes 2.0.1
1.4.1. Improvements and New Features
1.4.2. Bug fixes
1.5. Release Notes 2.0.0
1.5.1. Improvements, Important Changes and New Features
1.5.2. Bug fixes
1.6. Release Notes 1.6.3
1.6.1. Improvements, Important Changes and New Features
1.6.2. Bug fixes
1.7. Release Notes 1.6.2
1.7.1. Improvements, Important Changes and New Features
1.7.2. Bug fixes
1.8. Release Notes 1.6.1
1.8.1. Improvements and New Features
1.8.2. Bug fixes
1.9. Release Notes 1.6.0
1.9.1. Bug Fixes
1.10. Release Notes 1.5.5
1.10.1. Important
1.10.2. Improvements and New Features
1.11. Release Notes 1.5.4
1.11.1. Important
1.11.2. Improvements and New Features
1.11.3. Bug fixes
1.12. Release Notes 1.5.3
1.12.1. Improvements and New Features
1.12.2. Bug fixes
1.13. Release Notes 1.5.2
1.13.1. Improvements and New Features
1.13.2. Bug fixes
1.14. Release Notes 1.5.1
1.14.1. Improvements and New Features
1.14.2. Bug fixes
1.15. Release Notes 1.5.0
1.15.1. Improvements and New Features
1.15.2. Bug fixes
1.16. Release Notes 1.4.1
1.16.1. Improvements and New Features
1.16.2. Bug fixes
1.17. Release Notes 1.4.0
1.17.1. New features
1.17.2. Bug fixes
1.18. Release Notes 1.3.0
1.18.1. New features
1.18.2. Bug fixes
1.19. Release Notes 1.2.0
1.19.1. New features
1.19.2. Bug fixes
1.20. Release Notes 1.1.0
1.20.1. New features
1.20.2. Changes
1.21. Release Notes 1.0.6
1.21.1. New features
1.21.2. Bug fixes
1.22. Release Notes 1.0.5
1.22.1. New features
1.22.2. Bugs fixed in this version
1.23. Release Notes 1.0.4
1.23.1. New features
1.24. Release Notes 1.0.3
1.24.1. New features
1.24.2. Improvements in the Server
1.24.3. Bugs fixed in this version
1.25. Release Notes 1.0.2
1.25.1. New features
1.25.2. Improvements in the Server
1.25.3. Changes in the Monitor
1.26. Release Notes 1.0.1
1.26.1. Important changes
1.26.1.1. Change in the user-defined report scripts
1.26.2. Improvements in the Server
1.26.3. Other Changes
1.27. Release Notes 1.0.0rc2
1.27.1. Improvements in the Server
1.27.2. Bugs fixed in this release
1.28. Release Notes 1.0.0rc1
1.28.1. Improvements in the Server
1.28.2. Improvements in the Monitor
1.28.3. Improvements in the Python library of functions used to process monitoring data
1.28.4. Bugs fixed in this release
1.29. Release Notes 0.99.1
1.29.1. New Features
1.29.2. Packaging
1.29.3. Bugs fixed in this release
1.29.4. Other improvements
1.29.5. JSON API
1.30. Release Notes 0.98.4
1.30.1. New Features in this release
1.30.2. Packaging
1.30.3. Bugs fixed in this release
1.31. Release Notes 0.98.3
1.31.1. Important changes in this release
1.31.2. Code changes and other internal changes
1.31.3. Start/stop shell script netspyglass.sh
1.31.4. Configuration
1.31.5. User Interface
1.31.6. Documentation
1.31.7. Device discovery
1.31.8. Monitoring and data processing
1.31.9. Changes in the Data Processing Python Scripts
1.31.10. Scalability
1.32. Release Notes 0.98.2
1.32.1. Important changes in this release
1.32.1.1. Network Discovery and Monitoring
1.33. Release Notes 0.98.1
1.33.1. Important changes in this release
1.33.2. Improvements in this release
1.33.3. User Interface
1.34. Release Notes 0.98
1.34.1. Important changes in this release
1.34.2. Improvements in this release
1.34.2.1. Startup scripts
1.34.2.2. Tags
1.34.2.3. Network Discovery and Monitoring
1.34.2.4. User Interface
1.34.2.5. Infrastructure
1.34.2.6. Configuration file format changes
1.35. Release Notes 0.974
1.35.1. Improvements in this release
1.36. Release Notes 0.973
1.36.1. Bugs fixed in this release
1.37. Release Notes 0.972
1.37.1. New features and improvements in UI
1.37.2. New features and improvements in Monitor
1.37.3. Bugs fixed in this release
1.38. Release Notes 0.971
1.38.1. Notable Bugs fixed in this release
1.39. Release Notes 0.97
1.39.1. Important changes in this release
1.39.2. New features and improvements in UI
1.39.3. New features and improvements in the Monitor
1.39.4. Notable Bugs fixed in this release
1.39.5. Known issues in this release
1.40. Release Notes 0.967
1.40.1. Important changes in this release
1.40.2. New features and improvements in UI
1.40.3. New features and improvements in the Monitor
1.40.4. Notable Bugs fixed in this release
1.41. Release Notes 0.965
1.41.1. Important changes in this release
1.41.2. New features and improvements in this release
1.41.3. Notable Bugs fixed in this release
1.42. Release Notes 0.965
1.42.1. Important changes in this release
1.42.2. New features and improvements in this release
1.42.3. Notable Bugs fixed in this release
1.43. Release Notes 0.964
1.43.1. New features and improvements in this release
1.43.2. Notable Bugs fixed in this release
1.44. Release Notes 0.963
1.44.1. New features and improvements in this release
1.44.2. Notable Bugs fixed in this release
1.45. Release Notes 0.962
1.45.1. New features and improvements in this release
1.45.2. Bugs fixed in this release
1.46. Release Notes 0.961
1.46.1. New features and improvements in this release
1.46.2. Bugs fixed in this release
1.47. Release Notes 0.96
1.47.1. New features and improvements in this release
1.47.2. Bugs fixed in this release
1.48. Release Notes 0.951
1.48.1. New features and improvements in this release
1.48.2. Bugs fixed in this release
1.49. Release Notes 0.95
1.49.1. Highlights
1.49.2. New features and improvements in this release
1.49.3. UI
1.49.4. Monitoring and Processing of Collected Data
1.49.5. Core Technology
1.49.6. Improvements in Device Discovery and Monitoring
1.49.7. Notable bugs fixed in this release
1.50. Release Notes 0.941
1.50.1. New features and improvements in this release
1.51. Release Notes 0.94
1.51.1. New features and improvements in this release
1.51.2. Known issues in this release
1.52. Release Notes 0.93
1.52.1. New features and improvements in this release
1.52.2. Known issues
1.53. Release Notes 0.92
1.53.1. New features in this release
1.53.2. Documentation
1.53.3. Known issues
1.54. Release Notes 0.91
1.54.1. Main Features Available in this Release
1.54.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. Running NetSpyGlass via encrypted HTTP connection
2.4.1.1. Keystore
2.4.2. User Authentication
2.4.2.1. Unprotected mode
2.4.2.2. Protected mode
2.4.2.3. Using access tokens for script access to API
2.4.2.4. Running NetSpyGlass behind reverse proxy with authentication
2.4.2.5. UI indication of successful authentication
2.4.2.6. User Roles
2.4.3. Network Discovery
2.4.3.1. Schedule
2.4.4. Supported Browsers
2.4.5. Configuration file syntax
2.4.5.1. Basic rules of the config file format
2.5. Performance tuning
2.5.1. Java Command line
2.5.2. Data Push Tuning
2.6. Databases
2.6.1. Running NetSpyGlass with embedded database HSQLDB
2.6.2. Running NetSpyGlass with MySQL
2.6.3. How to migrate from embedded HSQLDB database to MySQL
2.6.3.1. Prerequisites
2.6.3.2. Migration Process
2.7. Time Series Database
2.7.1. Configuration
2.7.2. RRD
2.7.2.1. Configuration
2.7.3. Graphite
2.7.3.1. Configuration
2.7.3.2. Schema
2.7.3.3. Variable, device and interface names
2.7.4. InfluxDb
2.7.4.1. Versions
2.7.4.2. Configuration
2.7.4.3. Schema
2.7.4.4. Tags
2.7.4.5. Queries using tags
2.7.4.6. Retention Policies
2.7.5. hbase
2.7.5.1. Configuration
2.7.5.2. Schema
2.8. Cluster configuration
2.8.1. Command line parameters
2.8.1.1. Zookeeper
2.8.1.2. Name, Role and Region
2.8.2. Cluster Configuration
2.8.2.1. Configuration file
cluster.conf
2.8.2.2. Configuration file
nw2.conf
2.8.3. Known limitations as of time of this release
2.8.4. Examples of cluster configurations
2.8.4.1. Single server configuration (the default)
2.8.4.2. Primary server and several monitors
2.8.4.3. Dedicated compute server
2.8.4.4. Dedicated compute and alerts servers
2.9. Distributed Monitoring and Discovery Strategies
2.9.1. SNMP Polling
2.9.2. Configuration
2.9.3. Device Allocation
2.9.4. Zookeeper
2.9.5. Single server, single monitor
2.9.6. Single server, multiple monitor servers in one location
2.9.7. Multiple servers and monitors in one region
2.9.8. Multiple regions
2.10. Hardware Requirements
2.11. Distribution Packages
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.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. 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.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 JSON API
15.1. API v2.0
15.1.1. UI
15.1.1.1. GET /v2/ui/net/:id/status
15.1.1.2. GET /v2/nsg/discovery/net/:id/start
15.1.1.3. GET /v2/ui/net/:id/dashboards/device/:id
15.1.1.4. GET /v2/ui/net/:id/devices
15.1.1.5. GET /v2/ui/net/:id/devices/:devid
15.1.1.6. GET /v2/ui/net/:id/data/device/:devid?[format=(brief|full)][category=:name]
15.1.1.7. GET /v2/ui/net/:id/popup/device/:devid
15.1.1.8. GET /v2/ui/net/:id/popup/device/:devid/intf/:ifIndex
15.1.1.9. GET /v2/ui/net/:id/graph/:triplet,:triplet
15.1.1.10. GET /v2/ui/net/:id/data/:triplet,:triplet
15.1.1.11. GET /v2/ui/net/:id/views/:viewid/map
15.1.1.12. GET /v2/ui/net/:id/views/:viewid/map?layout=auto
15.1.1.13. GET /v2/ui/net/:id/views/:viewid/map?layout=reset
15.1.1.14. GET /v2/ui/net/:id/views/:viewid/map?layout=fit
15.1.1.15. GET /v2/ui/net/:id/views/:viewid/linkGraphVars
15.1.1.16. GET /v2/ui/net/:id/views/:viewid/linkVar/:lv/nodeVar/:nv
15.1.1.17. PUT /v2/ui/net/:id/views/:viewid/coordinates
15.1.1.18. POST /v2/ui/net/:id/keyvalue[/:handle]
15.1.1.19. GET /v2/ui/net/:id/keyvalue/:handle
15.1.1.20. GET /v2/ui/net/:id/gw/variables?rule_spec
15.1.1.21. GET /v2/ui/net/:id/gw/catalog/categories/list
15.1.1.22. GET /v2/ui/net/:id/gw/catalog/categories/:category
15.1.1.23. GET /v2/ui/net/:id/gw/catalog/variables/:v1,:v2
15.1.1.24. GET /v2/ui/net/:id/gw/catalog/variables/:v1,:v2/devices/:dev1,:dev2
15.1.1.25. GET /v2/ui/net/:id/gw/catalog/tags/facets/list
15.1.2. Actions
15.1.3. Grafana
15.1.3.1. POST /v2/query/net/:id/categories/
15.1.3.2. POST /v2/query/net/:id/variables/:category
15.1.3.3. POST /v2/query/net/:id/data/
15.2. Legacy API (v1.0)
15.2.1. Network-related commands
15.2.1.1. GET /api/ui/status
15.2.1.2. GET /api/ui/networks
15.2.1.3. GET /api/ui/networks/:netid/full
15.2.1.4. GET /api/ui/networks/:netid/generations
15.2.1.5. GET /api/ui/networks/:netid/generations/:generation_num
15.2.1.6. GET /api/ui/networks/:netid/generations/:timestamp
15.2.1.7. GET /api/ui/networks/:netid/discover
15.2.1.8. GET /api/ui/networks/:netid/tiles
15.2.1.9. GET /api/ui/networks/:netid/topo
15.2.1.10. GET /api/ui/networks/:netid/topo/7
15.2.1.11. GET /api/ui/networks/:netid/topo/1382411525350
15.2.1.12. GET /api/ui/networks/:netid/nodes
15.2.1.13. GET /api/ui/networks/:netid/nodes[?generation=:gen]
15.2.1.14. GET /api/ui/networks/:netid/nodes/:nodeid[?generation=:gen]
15.2.1.15. GET /api/ui/networks/:netid/nodes/:nodeid/summary[?generation=:gen]
15.2.1.16. GET /api/ui/networks/:netid/views/:viewid/map
15.2.1.17. GET /api/ui/networks/:netid/views/:viewid/map?layout
15.2.1.18. GET /api/ui/networks/:netid/views/:viewid/map?reset
15.2.1.19. GET /api/ui/networks/:netid/views/:viewid/map?fit&zoom=:zm&viewBox=0,0,1000,1000
15.2.1.20. GET /api/ui/networks/:netid/views/:viewid/map?generation=:gen
15.2.1.21. GET /api/ui/networks/:netid/icons
15.2.1.22. PUT /api/ui/networks/:netid/views/:viewid/nodes/coordinates
15.2.2. View Manipulation (Not Implemented)
15.2.2.1. POST /api/networks/:netid/views
15.2.2.2. PUT /api/networks/:netid/views/:viewid
15.2.2.3. PUT /api/networks/:netid/views/:viewid?validate
15.2.2.4. DELETE /api/networks/:netid/views/:viewid
15.2.3. UI state
15.2.3.1. POST /api/ui/networks/:netid/keyvalue
15.2.3.2. POST /api/ui/networks/:netid/keyvalue/:handle
15.2.3.3. GET /api/ui/networks/:netid/keyvalue/:handle
15.2.4. Reports
15.2.4.1. GET /api/ui/networks/:netid/reports
15.2.4.2. GET /reports
15.2.4.3. GET /reports/report_file
15.2.5. Monitoring Data
15.2.5.1. GET /api/monitor/networks/:netid/nodes/:nodeid[?sortBy=var1&sortBy=var2...]
15.2.5.2. GET /api/monitor/networks/:netid/nodes/:nodeid/brief
15.2.5.3. GET /api/monitor/networks/:netid/nodes/:nodeid/interfaces/:ifIndex/linkSummary
15.2.5.4. GET /api/monitor/networks/:netid/nodes/:nodeid/interfaces/:ifIndex/popupGraph
15.2.5.5. GET /api/monitor/networks/:netid/nodes/:nodeid/popupGraph
15.2.6. Monitoring Data requests used to build labels in maps
15.2.6.1. GET /api/monitor/networks/:netid/views/:viewid/linkVar/:intfvarName/nodeVar/:nodevarName
15.2.7. Graphs
15.2.7.1. GET /api/monitor/networks/:netid/graph/:varid1,:varid2
15.2.7.2. GET /api/monitor/networks/:netid/graph/?rule_spec
15.2.8. Generic monitoring data request
15.2.8.1. GET /api/monitor/networks/:netid/data/:varid1,:varid2
15.2.8.2. GET /api/monitor/networks/:netid/data/?rule_spec
15.2.9. Graphing Workbench
15.2.9.1. GET /api/monitor/networks/:netid/gw/
15.2.9.2. GET /api/monitor/networks/:netid/gw?rule_spec
15.2.9.3. GET /api/monitor/networks/:netid/vars/:varname
15.2.9.4. GET /api/monitor/networks/:netid/catalog/[triplet1,triplet2...]
15.2.10. Monitor JSON API
15.2.10.1. GET /api/metrics/healthcheck
15.2.10.2. GET /api/metrics/ping
15.2.10.3. GET /api/metrics/metrics?pretty=true
15.2.10.4. GET /api/quit
15.2.11. Format of the variable matching rule
15.2.12. Alerts and Alert silences JSON API
15.2.12.1. GET /api/alerts/networks/:netid/alerts[?active=true|false][rule_spec]
15.2.12.2. GET /api/alerts/networks/:netid/alerts/:alertKey
15.2.12.3. POST /api/alerts/networks/:netid/silences
15.2.12.4. POST /api/alerts/networks/:netid/silences/:id
15.2.12.5. GET /api/alerts/networks/:netid/silences/
15.2.12.6. GET /api/alerts/networks/:netid/silences/:id
NetSpyGlass
Docs
»
Please activate JavaScript to enable the search functionality.
NetSpyGlass
v: 2.0.x
Versions
2.0.x
2.1.x