Lync Server 2013 – Centralised Logging

Tom ArbuthnotSenor Consultant, Modality

@tomarbuthnot

http://www.lyncdup.com

tom@tomarbuthnot.com

Credit For ContentBryan NyceUC Voice Architect Microsoft

13/04/2023 Microsoft Unified Communications User Group London (MUCUGL) 2

Good old OCSLogger

• Microsoft Lync Server 2013 Debugging Tools– Snooper– OCSLogger– OCSTracer– ClsController.psm1

http://www.microsoft.com/en-us/download/details.aspx?id=35453

3

• New in Lync Server 2013• “Replaces” Lync Server Logging Tool• Enables IT admin to manage logging and search logs

across all Lync Servers in a deployment centrallyStart, stop, and flush trace logging for any/all machines in a deployment from one placeStart/stop logging based on scenariosSee what logging is turned on per pool/machine for the entire deploymentSearch trace logs based on specified parameters from a centralized place

Centralized Logging Service (CLS)

4

CLSController.exeSends Start, Stop, Flush, and Search commands to all the CLSAgents in the deploymentAggregates search results from CLSAgentsAvailable on every Lync Server in “C:\Program Files\Common Files\Microsoft Lync Server 2013\ClsAgent”(PowerShell Module for Management)

CLSAgent (Service)Runs on every Lync ServerControls logging based on commands from CLSControllerManages log files to ensure drive space is not consumed, moves old logs to fileshare

CLS Architecture

CLSControllerFE

CLSAgent

FE

CLSAgent

FE

CLSAgent

Start, Stop, Search commands

Start, Stop, Search commandsStart, Stop, Search commands

Search results

Search results

Search results

On Every FE in the pool under the Network Service Temp Location

%TEMP%\Tracing

C:\Windows\ServiceProfiles\NetworkService\AppData\Local\Temp\Tracing

Can be changed, Set-CsCLSConfiguration –CacheFileNetworkFolder

Note that’s disk use %!

“Gathered”/Compiled with Search-CsCLsLogging

Where do the Logs go?

5

6

Logging is based on scenariosBuilt in scenarios specify a group of components and log levels to be started and stopped together

Scenarios

AddressBookAlwaysOnApplicationSharingAudioVideoConferencingIssueCAACLSCPSDeviceUpdate

HostedMigration“HybridVoice”IMAndPresenceIncomingAndOutgoingCallLILRLegacyLILRLYSSLYSSAndUCSMediaConnectivity

MeetingJoinMonitoringAndArchivingRGSSPUserReplicatorVoiceMailWACXMPP

Components Logged by Scenarios

Scenario details can be discovered

$scenario=Get-CsClsScenario global/IncomingAndOutgoingCallforeach ($sc in $scenario.provider) { $sc.name }

Get-CsClsScenario global/<ScenarioName> |Select -ExpandProperty Provider |Format-Table Name,Level,Flags -a

For scenario:

IncomingAndOutgoingCall

7

Component Name Level

MediationServer Info

S4 Info

Sipstack Info

TranslationApplication Info

OutboundRouting Info

InboundRouting Info

UserServices Verbose

Managing CLS (PowerShell)

Managing CLS If you Love GUIs

Randy Wintel/James Cussen have written a GUI to run the PowerShell commands

http://www.mylynclab.com/2013/04/lync-2013-centralised-logging-tool.html

10

What is it?The special scenario “AlwaysOn” can be on all the time. It logs INFO level for many (70) common componentsWhen an issue occurs there may be enough info in the AlwaysOn component logs to debug the issueThis avoids having to turn on logging and repro the issue, which was always required in Lync Server 2010At any given time, you can have one extra scenario enabled along with AlwaysOn (2 scenarios logging in total)

When do I use it?Always. Not enabled by default.

The “AlwaysOn” Scenario

Examples

Turn on a logging scenario (-Duration days,hours,minutes, 4hr)

Run a Search (gather Logs) -Components -StartTime –EndTime –Uri, -sipcontents, -phone

Output

Gotcha’s

Watch for default scenario log levels:

$provider = New-CsClsProvider -Name “SIPVerbose" –Flags “SIPStack”-Type "WPP" -Level “All" New-CsClsScenario -Identity "global/SIPVerbose"-Provider $provider