Difference between revisions of "ZenPack:Microsoft Lync"
Ss solutions (Talk | contribs) |
John Causey (Talk | contribs) |
||
(8 intermediate revisions by 4 users not shown) | |||
Line 5: | Line 5: | ||
|Flavor=commercial | |Flavor=commercial | ||
|Releases={{Release | |Releases={{Release | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|Version=1.0.0 | |Version=1.0.0 | ||
|Release date=2014/08/18 | |Release date=2014/08/18 | ||
|Compatible with=Zenoss Resource Manager 4.2.x | |Compatible with=Zenoss Resource Manager 4.2.x | ||
|Requires=PythonCollector, Microsoft Windows | |Requires=PythonCollector, Microsoft Windows | ||
− | |Download URL=https://zenoss. | + | |Download URL=https://support.zenoss.com/ics/support/DLRedirect.asp?deptID=16059&fileID=96529 |
}} | }} | ||
|Devices= | |Devices= | ||
|Applications={{Application | |Applications={{Application | ||
|Product Name=Microsoft Lync | |Product Name=Microsoft Lync | ||
− | |Version=2010, 2013 | + | |Version=2010, 2013 |
}} | }} | ||
|Integrations= | |Integrations= | ||
|DataAudits= | |DataAudits= | ||
}} | }} | ||
− | This ZenPack provides support for monitoring Microsoft Lync | + | This ZenPack provides support for monitoring Microsoft Lync messaging platform. |
Monitoring is performed using the Windows Remote Shell (WinRS) to collect | Monitoring is performed using the Windows Remote Shell (WinRS) to collect | ||
Windows Cmdlet and Perfmon data. | Windows Cmdlet and Perfmon data. | ||
Line 142: | Line 112: | ||
{{note}} As the Edge server machine is not accessible by the domain credentials supplied for the CMS, | {{note}} As the Edge server machine is not accessible by the domain credentials supplied for the CMS, | ||
the above metrics are to be monitored directly on the Edge device with the help of | the above metrics are to be monitored directly on the Edge device with the help of | ||
− | MSLyncEdgeServer2010 | + | MSLyncEdgeServer2010/MSLyncEdgeServer2013 monitoring templates. |
=== Event Monitoring === | === Event Monitoring === | ||
Line 214: | Line 184: | ||
Lync Edge metrics should be monitored directly from the guest device, using the following steps: | Lync Edge metrics should be monitored directly from the guest device, using the following steps: | ||
# Go to the Edge Server device. | # Go to the Edge Server device. | ||
− | # Bind ''MSLyncEdgeServer2010'' | + | # Bind ''MSLyncEdgeServer2010'' or ''MSLyncEdgeServer2013'' monitoring template (according to the Lync server version). |
== Requirements == | == Requirements == | ||
Line 235: | Line 205: | ||
# Set ''zWinRMUser'', ''zWinRMPassword'' and ''zWinKDC'' properties. | # Set ''zWinRMUser'', ''zWinRMPassword'' and ''zWinKDC'' properties. | ||
# Navigate to the ''Modeler plugins'' page of the device, add the ''zenoss.winrm.MSLync'' modeler plugin and remodel the device. This will automatically find the MS Lync components and start monitoring them immediately for the previously mentioned metrics. | # Navigate to the ''Modeler plugins'' page of the device, add the ''zenoss.winrm.MSLync'' modeler plugin and remodel the device. This will automatically find the MS Lync components and start monitoring them immediately for the previously mentioned metrics. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Troubleshooting == | == Troubleshooting == | ||
Line 278: | Line 218: | ||
users should contact [https://support.zenoss.com Zenoss Customer Support]. | users should contact [https://support.zenoss.com Zenoss Customer Support]. | ||
Core users can use the #zenoss IRC channel or the community.zenoss.org forums. | Core users can use the #zenoss IRC channel or the community.zenoss.org forums. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Installed Items == | == Installed Items == | ||
Line 351: | Line 234: | ||
* MSLyncEdgeServer2010 (in /Server/Microsoft) | * MSLyncEdgeServer2010 (in /Server/Microsoft) | ||
* MSLyncEdgeServer2013 (in /Server/Microsoft) | * MSLyncEdgeServer2013 (in /Server/Microsoft) | ||
− | |||
;Component Types | ;Component Types | ||
* MSLyncSite (on related device) | * MSLyncSite (on related device) | ||
Line 363: | Line 245: | ||
== Changes == | == Changes == | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
;1.0.0 | ;1.0.0 | ||
* Initial Release | * Initial Release | ||
{{ZenPackFooter}} | {{ZenPackFooter}} |
Revision as of 21:11, 28 August 2014
Note: This ZenPack is available in commercial versions of Zenoss. Click here to request more information about this commercial ZenPack. Click here to see all commercial ZenPacks.
- Organization
- Zenoss, Inc.
- ZenPack name
- ZenPacks.zenoss.Microsoft.Lync
- Microsoft Lync (2010, 2013, 2015)
Microsoft Lync ZenPack
Warning
The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.
Support
This ZenPack is included with commercial versions of Zenoss and enterprise support for this ZenPack is provided to Zenoss customers with an active subscription.
Releases
- Version 1.0.0- Download
- Released on 2014/08/18
- Requires PythonCollector ZenPack,Microsoft Windows ZenPack
- Compatible with Zenoss Resource Manager 4.2.x
Background
This ZenPack provides support for monitoring Microsoft Lync messaging platform. Monitoring is performed using the Windows Remote Shell (WinRS) to collect Windows Cmdlet and Perfmon data.
Gallery
Features
The features added by this ZenPack can be summarized as follows. They are each detailed further below.
- Initial discovery and periodic remodeling of relevant components.
- Server performance monitoring and QoE metrics monitoring.
- Event management.
- Optional service impact with addition of Zenoss Service Dynamics product.
- Auto-discovery of Lync Computers' guest devices.
Discovery
The following components will be automatically discovered through the Windows server address, username and password you provide. Note that domain credentials are required to model/monitor Lync CMS and it's replicas. The properties and relationships will be periodically updated by modeling.
- MSLync Site
- Attributes: Name, Description, Type of Site, Parent Site
- MSLync Computer
- Attributes: Name, Site, Pool FQDN, Replication Status, Product Version
- MSLync User Server
- Attributes: Name, Site, Computer, Status
- MSLync Web Server
- Attributes: Name, Site, Computer, External FQDN, Internal FQDN, Status
- MSLync Conferencing Server
- Attributes: Name, Site, Computer, Status
- MSLync Mediation Server
- Attributes: Name, Site, Computer, Status
- MSLync Edge Server
- Attributes: Name, Site, Computer, AV Edge External FQDN, Access Edge External FQDN, Data Edge External FQDN, Status
- MSLync Monitoring Database
- Attributes: Name, Site, Computer, SQL Instance Name
Performance Monitoring
Perfmon counters are collected using the PowerShell Get-Counter Cmdlet within a remote shell (WinRS). The following metrics will be collected every 5 minutes by default. Any other Windows Perfmon counters can also be collected by adding them to the appropriate monitoring template.
- MSLync User Server
- DBStore: Queue Latency, Sproc Latency
- Incoming Messages Processing Time: Avg. Processing Time, Avg. Holding Time
- Peers: Outgoing Queue Delay, Sends Timed-Out
- Requests and Responses Dropped: Requests Dropped, Responces Dropped
- Timed-Out Messages: Incoming Messages Timed-Out
- MSLync Web Server
- Address Book Failed Requests: Failed File Requests, Failed Search Requests
- MSLync Conferencing Server
- MCU Health state: Instant Messages, Application Sharing, Data, Audio/Video
- Active Conferences: Instant Messages, Application Sharing, Data, Audio/Video
- Throtted Sip Connections: Throtted Sip Connections
- MSLync Mediation Server
- Media Relay: Candidates Missing, Media Connectivity Check Failure
- Health: Local Call Failure Index
- Total Failed Calls: Calls Failed from Gateway, Calls Failed from Proxy
- MSLync Monitoring Database
- QoE Metrics: Listening MOS, Sending MOS, Network MOS, Network MOS Degradation, Jitter, Packet Loss Rate, Round Trip Time
Note: Note that QoE Metrics will only be monitored if the monitoring role is installed
and the QoEMetrics database is installed and configured. The monitoring plugin collects
the average values form the QoEMetrics database for the last hour of call activity on the server.
- MSLync Edge Server
- Metrics: Authentication Failures (TCP/UDP), Packets Dropped (TCP/UDP), Allocate Requests Exceeding Port Limit (TCP/UDP)
Note: As the Edge server machine is not accessible by the domain credentials supplied for the CMS,
the above metrics are to be monitored directly on the Edge device with the help of
MSLyncEdgeServer2010/MSLyncEdgeServer2013 monitoring templates.
Event Monitoring
According to the following MSLync states this ZenPack will trigger events with an appropriate summary message.
- MSLync Computer
- Warning event:
- The replication state is not up to date,
- One or more Lync windows services are stopped.
- Critical event:
- The server is Down.
- MSLync User Server
- Warning event:
- The server is stopped,
- DBStore Queue Latency or Sproc Latency is above 100ms,
- Incoming Messages Processing Time or Holding Time is above 6 seconds,
- More than 1 Requests or Responses Dropped,
- Peers - Outgoing Queue Delay is above 2 seconds.
- Critical event:
- DBStore Queue Latency or Sproc Latency is above 6000ms.
- MSLync Web Server
- Warning event:
- More than 5 Address Book Failed File or Search Request.
- MSLync Conferencing Server
- Warning event:
- The server is stopped,
- More than 1 Throttled Sip Connections,
- The health state of any MCU is above 1. (MCU states: 1 - Loaded, 2 - Full, 3 - Unavailable)
- MSLync Mediation Server
- Warning event:
- The server is stopped,
- Load Call Failure Index due to heavy load is above 10.
- MSLync Edge Server
- Warning event:
- The per-second rate of packets over TCP or UDP dropped by the relay is above 300,
- The per-second rate of allocate requests over TCP or UDP that exceeded the port limit is above 20,
- The per-second rate of failed attempts to authenticate with the relay over TCP or UDP is above 20.
- MSLync Monitoring Database
- Warning event:
- The monitoring database is not configured properly or the hosting machine is Down.
Service Impact
When combined with the Zenoss Service Dynamics product, this ZenPack adds built-in service impact capability for MS Lync. The following service impact relationships are automatically added. These will be included in any services that contain one or more of the explicitly mentioned entities.
- Service Impact Relationships
- Site failure affects related device.
- Computer failure affects related site.
Auto-discovery of Lync Computers' Guest Devices
You can optionally configure each monitored windows server to attempt to discover and monitor the guest systems for each Lync Computer component. This requires that your Zenoss system has the network and server access it needs to monitor the guest system.
- Lync Edge Discovery
Lync Computer component hosting the Edge role is modeled with it's internal FQDN, therefore the guest device for this computer will be created using it's AV Edge External FQDN. The Edge host is not accessible by the domain credentials supplied for the CMS, therefore Lync Edge metrics should be monitored directly from the guest device, using the following steps:
- Go to the Edge Server device.
- Bind MSLyncEdgeServer2010 or MSLyncEdgeServer2013 monitoring template (according to the Lync server version).
Requirements
This ZenPack has the following requirements.
- PythonCollector ZenPack
- This ZenPack depends on PythonCollector being installed, and having the associated zenpython collector process running.
- Microsoft Windows ZenPack
- This ZenPack depends on Microsoft Windows ZenPack being installed, and uses its zProperties and tools. Due to this, servers running Lync services need to be in the /Server/Microsoft/Windows device class for proper modeling and monitoring.
Usage
To start monitoring your Microsoft Lync server you will need to setup connection to it as well as bind modeler plugin to the device or device class containing your hosting Microsoft Windows device.
Use the following steps to start monitoring Microsoft Lync using the Zenoss web interface.
- Navigate to the Configuration Properties page of the device containing your MS Lync server.
- Set zWinRMUser, zWinRMPassword and zWinKDC properties.
- Navigate to the Modeler plugins page of the device, add the zenoss.winrm.MSLync modeler plugin and remodel the device. This will automatically find the MS Lync components and start monitoring them immediately for the previously mentioned metrics.
Troubleshooting
Please refer the the Zenoss Service Dynamics documentation if you run into any of the following problems:
- ZenPack will not install
- Adding a device fails
- Don't understand how to add a device
- Don't understand how to model a device
If you cannot find the answer in the documentation, then Resource Manager (Service Dynamics) users should contact Zenoss Customer Support. Core users can use the #zenoss IRC channel or the community.zenoss.org forums.
Installed Items
Installing this ZenPack will add the following items to your Zenoss system.
- Modeler Plugins
- zenoss.winrm.MSLync
- Monitoring Templates
- MSLyncComputer (in /Server/Microsoft)
- MSLyncConferencingServer (in /Server/Microsoft)
- MSLyncMediationServer (in /Server/Microsoft)
- MSLyncMonitoringDatabase (in /Server/Microsoft)
- MSLyncUserServer (in /Server/Microsoft)
- MSLyncWebServer (in /Server/Microsoft)
- MSLyncEdgeServer2010 (in /Server/Microsoft)
- MSLyncEdgeServer2013 (in /Server/Microsoft)
- Component Types
- MSLyncSite (on related device)
- MSLyncComputer (on MSLyncSite)
- MSLyncConferencingServer (on MSLyncComputer)
- MSLyncMediationServer (on MSLyncComputer)
- MSLyncMonitoringDatabase (on MSLyncComputer)
- MSLyncUserServer (on MSLyncComputer)
- MSLyncWebServer (on MSLyncComputer)
- MSLyncEdgeServer (on MSLyncComputer)
Changes
- 1.0.0
- Initial Release
Installation
Normal Installation (packaged egg)
- Download the appropriate egg file for the version of Zenoss you are running.
- Ensure you are logged in as the zenoss user:
$ sudo su - zenoss
- Install the ZenPack:
$ zenpack --install ZenPacks.zenoss.Microsoft.Lync-*.egg
- Restart these services:
$ zenoss restart
Discuss
New: Don't forget to add yourself to the Zenoss User Map!