Lync Server 2013 での集中ログサービスのシナリオの構成Configuring scenarios for the Centralized Logging Service in Lync Server 2013

 

トピックの最終更新日: 2014-02-05Topic Last Modified: 2014-02-05

シナリオでは、集中ログサービスで使用するスコープ (グローバル、サイト、プール、またはコンピューター) とプロバイダーを定義します。Scenarios define the scope (that is, global, site, pool, or computer) and what providers to use in the Centralized Logging Service. シナリオを使用して、プロバイダー (S4、SIPStack、IM、プレゼンスなど) のトレースを有効または無効にします。By using scenarios, you enable or disable tracing on providers (for example, S4, SIPStack, IM, and Presence). シナリオを構成することで、特定の問題の条件に対応する特定の論理コレクションのすべてのプロバイダーをグループ化できます。By configuring a scenario, you can group all of the providers for a given logical collection that address a specific problem condition. トラブルシューティングとログのニーズに合わせてシナリオを変更する必要があることが判明した場合は、Lync Server 2013 デバッグツールによって、 clscontroller.psm1 という名前の Windows PowerShell モジュールが提供されます。このモジュールには、「 Edit-csclsscenario」という名前の関数が含まれています。If you find that a scenario needs to be modified to meet your troubleshooting and logging needs, the Lync Server 2013 Debug Tools provides you a Windows PowerShell module named ClsController.psm1 that contains a function named Edit-CsClsScenario. このモジュールの目的は、指定したシナリオのプロパティを編集することです。The purpose of the module is to edit the properties of the named scenario. このトピックでは、このモジュールの使用方法の例を示します。Examples of how this module works are provided in this topic. Lync Server 2013 デバッグツールは、次のリンクからダウンロードされます。 https://go.microsoft.com/fwlink/?LinkId=285257The Lync Server 2013 Debug Tools are downloaded from the following link: https://go.microsoft.com/fwlink/?LinkId=285257

重要

どのスコープ (サイト、グローバル、プール、またはコンピューター) でも、一度に最大で 2 つのシナリオを実行できます。For any given scope—site, global, pool or computer—you can run a maximum of two scenarios at any given time. 現在実行されているシナリオを確認するには、Windows PowerShell を使用して、 -CsClsScenario を取得します。To determine which scenarios are currently running, use Windows PowerShell and Get-CsClsScenario. Windows PowerShell と 設定-CsClsScenarioを使用すると、実行するシナリオを動的に変更できます。By using Windows PowerShell and Set-CsClsScenario, you can dynamically change which scenarios are running. ログ セッション中に実行するシナリオを変更して、収集するデータや収集元のプロバイダーを変更または微調整することができます。You can modify which scenarios are running during a logging session to adjust or refine the data you are collecting and from which providers.

Lync Server 管理シェルを使用して集中ログサービスの機能を実行するには、CsAdministrator または CsServerAdministrator の役割ベースのアクセス制御 (RBAC) セキュリティグループのメンバーであるか、またはこれら2つのグループのどちらかを含むカスタムの RBAC の役割を持っている必要があります。To run the Centralized Logging Service functions by using the Lync Server Management Shell, you must be a member of either the CsAdministrator or the CsServerAdministrator role-based access control (RBAC) security groups, or a custom RBAC role that contains either of these two groups. このコマンドレットが割り当てられているすべての RBAC の役割の一覧を返すには、自分で作成したカスタムの RBAC の役割を含めて、Lync Server 管理シェルまたは Windows PowerShell プロンプトから次のコマンドを実行します。To return a list of all the RBAC roles this cmdlet has been assigned to, including any custom RBAC roles you have created yourself, run the following command from the Lync Server Management Shell or the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Lync Server 2013 cmdlet"}

次に例を示します。For example:

Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Set-CsClsConfiguration"}

このトピックの残りの部分では、シナリオを定義する方法、シナリオを変更する方法、実行しているシナリオを取得する方法、シナリオを削除する方法、およびシナリオの内容を指定してトラブルシューティングを最適化する方法について取り上げます。The remainder of this topic focuses on how to define a scenario, modify a scenario, retrieve what scenarios are running, remove a scenario, and specify what a scenario contains to optimize your troubleshooting. 集中ログサービスのコマンドを発行するには、2つの方法があります。There are two ways to issue Centralized Logging Service commands. 既定では、ディレクトリ C: \ Program Files \ Common Files \ Microsoft Lync Server 2013 clsagent にある CLSController.exe を使用でき \ ます。You can use the CLSController.exe that is located, by default, in the directory C:\Program Files\Common Files\Microsoft Lync Server 2013\CLSAgent. または、Lync Server 管理シェルを使用して、Windows PowerShell コマンドを発行することもできます。Or, you can use the Lync Server Management Shell to issue Windows PowerShell commands. 重要な違いは、コマンドラインで CLSController.exe を使用する場合は、使用可能なシナリオが限られているということです。The important distinction is that when you use CLSController.exe at the command line there is a finite selection of scenarios available. Windows PowerShell を使用すると、ログセッションで使用するための新しいシナリオを定義できます。When you use Windows PowerShell, you can define new scenarios for use in your logging sessions.

Lync Server 2013 の集中ログサービスの概要で説明されているように、シナリオの要素は次のとおりです。As introduced in Overview of the Centralized Logging Service in Lync Server 2013, the elements of a scenario are:

  • Providers    OCSLogger を熟知している場合、プロバイダーは、トレースエンジンがログを収集する内容を OCSLogger に通知するために選択するコンポーネントです。Providers   If you are familiar with OCSLogger, providers are the components that you choose to tell OCSLogger what the tracing engine should collect logs from. プロバイダーは同じコンポーネントで、多くの場合、OCSLogger のコンポーネントと同じ名前になります。The providers are the same components, and in many cases have the same name as the components in OCSLogger. OCSLogger を使い慣れていない場合、プロバイダーは、集中ログサービスがログを収集できるサーバーロール固有のコンポーネントです。If you are not familiar with OCSLogger, providers are server role specific components that the Centralized Logging Service can collect logs from. プロバイダーの構成の詳細については、「 Lync Server 2013 の集中ログサービスのプロバイダーの構成」を参照してください。For details about the configuration of providers, see Configuring providers for Centralized Logging Service in Lync Server 2013.

  • Identity    パラメーター– Identity は、シナリオのスコープと名前を設定します。Identity   The parameter –Identity sets the scope and name of the scenario. たとえば、"グローバル" の範囲を設定し、"LyssServiceScenario" を使用してシナリオを特定することができます。For example, you could set a scope of “global” and identify the scenario with “LyssServiceScenario”. 2つを組み合わせる場合は、Id (たとえば、"global/LyssServiceScenario") を定義します。When you combine the two, you define the Identity (for example, “global/LyssServiceScenario”).

    また、–Name パラメーターと –Parent パラメーターを使用することもできます。Name パラメーターは、シナリオを一意に識別するために定義します。Name を使用する場合は、Parent も使用して、グローバルまたはサイトにシナリオを追加する必要があります。Optionally, you can use the –Name and –Parent parameters. You define the Name parameter to uniquely identify the scenario. If you use Name, you must also use Parent to add the scenario to either global or site.

    重要

    Name パラメーターと Parent パラメーターを使用する場合は、–Identity パラメーターは使用できません。If you use the Name and Parent parameters, you cannot use the –Identity parameter.

New-CsClsScenario コマンドレットを使用して新しいシナリオを作成するにはTo create a new scenario with the New-CsClsScenario cmdlet

  1. Lync Server 管理シェルを以下の手順で起動します。[スタート]、[すべてのプログラム]、[Microsoft Lync Server 2013]、[Lync Server 管理シェル] の順にクリックします。Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

  2. ログセッションの新しいシナリオを作成するには、 新しい-CsClsProvider を使用して、シナリオの名前 (一意に識別される方法) を定義します。To create a new scenario for a logging session, use New-CsClsProvider and define the name of the scenario (that is, how it will be uniquely identified). WPP からのログ形式の種類 (つまり、Windows software tracing プリプロセッサと既定値)、EventLog (Windows イベントログの形式)、または IISLog (つまり、IIS ログファイル形式に基づいた ASCII 形式ファイル) を選択します。Choose a type of logging format from WPP (that is, Windows software tracing preprocessor and is the default), EventLog (that is, Windows event log format), or IISLog (that is, ASCII format file based on the IIS log file format). 次に、レベルを定義します (このトピックのログレベルで定義されています)。フラグ (このトピックのフラグの下で定義されています)。Next, define Level (as the defined under Logging Levels in this topic), and Flags (as defined under Flags in this topic).

    このシナリオ例では、プロバイダー変数の例として LyssProvider を使用します。For this example scenario, we use LyssProvider as the example provider variable.

    定義されたオプションを使用してシナリオを作成するには、次のように入力します。To create a scenario using the options defined, type:

    New-CsClsScenario -Identity <scope>/<unique scenario name> -Provider <provider variable>
    

    次に例を示します。For example:

    New-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider $LyssProvider
    

    これに代わる、–Name と –Parent を使用する形式は次のとおりです。The alternate format using –Name and –Parent:

    New-CsClsScenario -Name "LyssServiceScenario" -Parent "site:Redmond" -Provider $LyssProvider
    

複数のプロバイダーを指定した新しいシナリオを New-CsClsScenario コマンドレットを使用して作成するにはTo create a new scenario with multiple providers with the New-CsClsScenario cmdlet

  1. Lync Server 管理シェルを以下の手順で起動します。[スタート]、[すべてのプログラム]、[Microsoft Lync Server 2013]、[Lync Server 管理シェル] の順にクリックします。Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

  2. スコープごとのシナリオ数は 2 つまでに制限されています。You are limited to two scenarios per scope. しかし、設定するプロバイダーの数に制限はありません。However, you are not limited to a set number of providers. この例では、3 つのプロバイダーを作成済みで、定義するシナリオに 3 つのプロバイダーをすべて割り当てる必要があるとします。In this example, assume that we have created three providers, and you want to assign all three to the scenario you are defining. プロバイダー変数の名前は LyssProvider、ABServerProvider、および SIPStackProvider です。The provider variable names are LyssProvider, ABServerProvider, and SIPStackProvider. 複数のプロバイダーを定義してシナリオに割り当てるには、Lync Server 管理シェルまたは Windows PowerShell コマンドプロンプトで次のように入力します。To define and assign multiple providers to a scenario, type the following at a Lync Server Management Shell or Windows PowerShell command prompt:

    New-CsClsScenario -Identity "site:Redmond/CollectDataScenario" -Provider @{Add=$LyssProvider, $ABServerProvider,  $SIPStackProvider}
    

    注意

    Windows PowerShell で認識されているように、を使用してハッシュテーブルを作成する規則 @{<variable>=<value1>, <value2>, <value>...} は、 スプラッティングと呼ばれます。As it is known in Windows PowerShell, the convention for creating a hash table of values using @{<variable>=<value1>, <value2>, <value>...} is known as splatting. Windows PowerShell のスプラッティングの詳細については、「」を参照してください https://go.microsoft.com/fwlink/p/?LinkId=267760For details about splatting in Windows PowerShell, see https://go.microsoft.com/fwlink/p/?LinkId=267760.

Set-CsClsScenario コマンドレットを使用して既存のシナリオを変更するにはTo modify an existing scenario with the Set-CsClsScenario cmdlet

  1. Lync Server 管理シェルを以下の手順で起動します。[スタート]、[すべてのプログラム]、[Microsoft Lync Server 2013]、[Lync Server 管理シェル] の順にクリックします。Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

  2. スコープごとのシナリオ数は 2 つまでに制限されています。実行するシナリオは、ログ キャプチャ セッションの実行中を含め、いつでも変更できます。実行するシナリオを再定義すると、現在のログ セッションは削除されたシナリオの使用を停止し、新しいシナリオの使用を開始します。ただし、削除されたシナリオでキャプチャされたログ情報はキャプチャされたログに残ります。新しいシナリオを定義するには、次のようにします (ここでは、定義済みのプロバイダー "S4Provider" を追加するものとします)。You are limited to two scenarios per scope. You can change which scenarios are running at any time, even when a logging capture session is in process. If you redefine the running scenarios, the current logging session will stop using the scenario that was removed and then begin using the new scenario. However, the logging information that was captured with the removed scenario remains in the captured logs. To define a new scenario, do the following (that is, assuming the addition of an already defined provider named “S4Provider”):

    Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Add=<new provider to add>}
    

    次に例を示します。For example:

    Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Add=$S4Provider}
    

    プロバイダーを置き換える場合は、現在のセットと置き換える単一のプロバイダーか、プロバイダーのコンマ区切りリストを定義します。多数のプロバイダーのうち 1 つだけを置き換える場合は、現在のプロバイダーに新しいプロバイダーを追加して、新しいプロバイダーと既存のプロバイダーの両方を含む新しいプロバイダーのセットを作成します。すべてのプロバイダーを新しいセットで置き換える場合は、次のように入力します。If you want to replace providers, define a single provider or a comma separated list of providers to replace the current set. If you only want to replace one of many providers, add the current providers with the new providers to create a new set of providers that contains both new providers and existing providers. To replace all providers with a new set, type the following:

    Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Replace=<providers to replace existing provider set>}
    

    たとえば、現在の $LyssProvider、$ABServerProvider、および $SIPStackProvider のセットを $LyssServiceProvider に置き換えるには、次のように入力します。For example, to replace the current set of $LyssProvider, $ABServerProvider, and $SIPStackProvider with $LyssServiceProvider:

    Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider}
    

    現在の $LyssProvider、$ABServerProvider、および $SIPStackProvider のセットのうち、$LyssProvider プロバイダーだけを $LyssServiceProvider に置き換えるには、次のように入力します。To replace just the $LyssProvider provider from the current set of $LyssProvider, $ABServerProvider, and $SIPStackProvider with $LyssServiceProvider, type the following:

    Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider, $ABServerProvider, $SIPStackProvider}
    

Remove-CsClsScenario コマンドレットを使用して既存のシナリオを削除するにはTo remove an existing scenario with the Remove-CsClsScenario cmdlet

  1. Lync Server 管理シェルを以下の手順で起動します。[スタート]、[すべてのプログラム]、[Microsoft Lync Server 2013]、[Lync Server 管理シェル] の順にクリックします。Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

  2. 定義済みのシナリオを削除する場合は、次のように入力します。If you want to remove a scenario that has been previously defined, type the following:

    Remove-CsClsScenario -Identity <name of scope and scenario>
    

    たとえば、定義済みのシナリオ site:Redmond/LyssServiceScenario を削除するには、次のようにします。For example, to remove the defined scenario site:Redmond/LyssServiceScenario:

    Remove-CsClsScenario -Identity "site:Redmond/LyssServiceScenario"
    

Remove-CsClsScenario コマンドレットでは指定したシナリオが削除されますが、キャプチャ済みのトレースはログに残り、検索に利用できます。The Remove-CsClsScenario cmdlet removes the specified scenario, but the traces that have been captured are still available in the logs for you to search on.

ClsController.psm1 モジュールを使用して Edit-CsClsScenario コマンドレットをロードおよびアンロードするにはTo load and unload the Edit-CsClsScenario cmdlet using the ClsController.psm1 module

  1. Lync Server 管理シェルを以下の手順で起動します。[スタート]、[すべてのプログラム]、[Microsoft Lync Server 2013]、[Lync Server 管理シェル] の順にクリックします。Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

    重要

    ClsController.psm1 モジュールは個別の Web ダウンロードとして提供されます。The ClsController.psm1 module is provided as a separate Web download. このモジュールは、Lync Server 2013 デバッグツールに含まれています。The module is part of the Lync Server 2013 Debugging tools. 既定では、デバッグ ツールは C:\Program Files\Lync Server 2013\Debugging Tools ディレクトリにインストールされます。By default, the debugging tools are installed in the directory C:\Program Files\Lync Server 2013\Debugging Tools.

  2. Windows PowerShell で、次のように入力します。From the Windows PowerShell, type:

    Import-Module "C:\Program Files\Lync Server 2013\Debugging Tools\ClsController.psm1"
    

    ヒント

    モジュールの読み込みが成功すると、Windows PowerShell コマンドプロンプトに戻ります。Successful loading of the module returns you to the Windows PowerShell command prompt. モジュールが読み込まれ、Edit-CsClsScenario が使用可能であることを確認するには、「」と入力 Get-Help Edit-CsClsScenario します。To confirm that the module is loaded and that Edit-CsClsScenario is available, type Get-Help Edit-CsClsScenario. すると、EditCsClsScenario の構文の基本的な概要が表示されます。You should see the basic synopsis of the syntax for EditCsClsScenario.

  3. モジュールをアンロードするには、次のように入力します。To unload the modules, type:

    Remove-Module ClsController
    

    ヒント

    モジュールが正常にアンロードされると、Windows PowerShell コマンドプロンプトに戻ります。Successful unloading of the module returns you to the Windows PowerShell command prompt. モジュールがアンロードされたことを確認するには、「」と入力 Get-Help Edit-CsClsScenario します。To confirm that the module is unloaded, type Get-Help Edit-CsClsScenario. Windows PowerShell は、コマンドレットのヘルプを検索して失敗します。Windows PowerShell will attempt to locate the help for the cmdlet and fail.

Edit-ClsController モジュールを使用してシナリオから既存のプロバイダーを削除するにはTo remove an existing provider from a scenario with the Edit-ClsController module

  1. Lync Server 管理シェルを以下の手順で起動します。[スタート]、[すべてのプログラム]、[Microsoft Lync Server 2013]、[Lync Server 管理シェル] の順にクリックします。Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

  2. AlwaysOn シナリオからプロバイダーを削除するには、次のように入力します。To remove a provider from the AlwaysOn scenario, type:

    Edit-CsClsScenario -ScenarioName <string of the scenario to edit> -ProviderName <string of the provider to remove> -Remove
    

    次に例を示します。For Example:

    Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Remove
    

    パラメーター ScenarioName および ProviderName は、位置指定 (コマンド ライン内の指定された位置に定義する必要がある) パラメーターです。コマンドレット名を位置 1 として、シナリオ名が位置 2、プロバイダーが位置 3 にある場合は、パラメーター名を明示的に定義する必要はありません。この情報を使用すると、上記のコマンドは次のように入力できます。The parameters ScenarioName and ProviderName are positional (that is, they must be defined in the expected position in the command line) parameters. The parameter name does not have to be explicitly defined if the scenario name is in position two and the provider is in position three, relative to the name of the cmdlet as position one. Using this information, the previous command would be typed as:

    Edit-CsClsScenario AlwaysOn ChatServer -Remove
    

    パラメーター値の位置指定は、–Scenario と –Provider にのみ適用されます。他のすべてのパラメーターは明示的に定義する必要があります。The positional placing of the parameter values applies only to –Scenario and –Provider. All other parameters must be explicitly defined.

Edit-ClsController モジュールを使用してシナリオにプロバイダーを追加するにはTo add a provider to a scenario with the Edit-ClsController module

  1. Lync Server 管理シェルを以下の手順で起動します。[スタート]、[すべてのプログラム]、[Microsoft Lync Server 2013]、[Lync Server 管理シェル] の順にクリックします。Start the Lync Server Management Shell: Click Start, click All Programs, click Microsoft Lync Server 2013, and then click Lync Server Management Shell.

  2. AlwaysOn シナリオにプロバイダーを追加するには、次のように入力します。To add a provider to the AlwaysOn scenario, type:

    Edit-CsClsScenario -ScenarioName <string of the scenario to edit> -ProviderName <string of the provider to add> -Level <string of type level> -Flags <string of type flags>
    

    次に例を示します。For Example:

    Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Level Info -Flags TF_COMPONENT
    

    -Loglevel には、Fatal、Error、Warning、Info、Verbose、Debug、または All の種類を指定できます。-Loglevel can be of the type Fatal, Error, Warning, Info, Verbose, Debug, or All. – Flags には、プロバイダーがサポートする任意のフラグ (TF COMPONENT、TF DIAG など) を指定でき _ _ ます。–Flags can be any of the flags that the provider supports, such as TF_COMPONENT, TF_DIAG. また、値 ALL も指定できます。–Flags can also be of value ALL

    上記の例を、コマンドレットの位置指定機能を使用して入力することもできます。たとえば、プロバイダー ChatServer を AlwaysOn シナリオに追加するには、次のように入力します。The previous example can also be typed using the positional feature of the cmdlet. For example, to add the provider ChatServer to the AlwaysOn scenario, type:

    Edit-CsClsScenario AlwaysOn ChatServer -Level Info -Flags ALL