Text Analytics の docker コンテナーの構成Configure Text Analytics docker containers

Text Analytics ではコンテナーごとに一般的な構成フレームワークが提供されているので、コンテナーのストレージ、ログとテレメトリ、セキュリティの設定を簡単に構成して、管理できます。Text Analytics provides each container with a common configuration framework, so that you can easily configure and manage storage, logging and telemetry, and security settings for your containers.

構成設定Configuration settings

このコンテナーには、次の構成設定があります。The container has the following configuration settings:

必須Required SettingSetting 目的Purpose
はいYes ApiKeyApiKey 課金情報を追跡します。Tracks billing information.
いいえNo ApplicationInsightsApplicationInsights お客様のコンテナーに対する Azure Application Insights テレメトリ サポートの追加を有効にします。Enables adding Azure Application Insights telemetry support to your container.
はいYes BillingBilling Azure 上のサービス リソースのエンドポイント URI を指定します。Specifies the endpoint URI of the service resource on Azure.
はいYes EulaEula コンテナーのライセンスに同意していることを示します。Indicates that you've accepted the license for the container.
いいえNo FluentdFluentd ログと (必要に応じて) メトリック データを Fluentd サーバーに書き込みます。Writes log and, optionally, metric data to a Fluentd server.
いいえNo Http ProxyHttp Proxy 送信要求を行うために、HTTP プロキシを構成します。Configures an HTTP proxy for making outbound requests.
いいえNo LoggingLogging ASP.NET Core のログ サポートをお客様のコンテナーに提供します。Provides ASP.NET Core logging support for your container.
いいえNo MountsMounts ホスト コンピューターからコンテナーに、またコンテナーからホスト コンピューターにデータを読み取ったり書き込んだりします。Reads and writes data from the host computer to the container and from the container back to the host computer.

重要

ApiKeyBillingEula の各設定は一緒に使用されるため、それらの 3 つすべてに有効な値を指定する必要があります。そうしないと、お客様のコンテナーは起動しません。The ApiKey, Billing, and Eula settings are used together, and you must provide valid values for all three of them; otherwise your container won't start. これらの構成設定を使用してコンテナーをインスタンス化する方法の詳細については、「課金」を参照してください。For more information about using these configuration settings to instantiate a container, see Billing.

ApiKey 構成設定ApiKey configuration setting

ApiKey 設定では、コンテナーの課金情報を追跡するために使用される Azure リソース キーを指定します。The ApiKey setting specifies the Azure resource key used to track billing information for the container. ApiKey の値を指定する必要があります。また、その値は、Billing 構成設定に指定された Cognitive Services リソースの有効なキーであることが必要です。You must specify a value for the ApiKey and the value must be a valid key for the Cognitive Services resource specified for the Billing configuration setting.

この設定は次の場所で確認できます。This setting can be found in the following place:

  • Azure portal:Cognitive Services の [リソース管理] の [キー] の下Azure portal: Cognitive Services resource management, under Keys

ApplicationInsights 設定ApplicationInsights setting

ApplicationInsights 設定を使用すると、Azure Application Insights テレメトリのサポートをお客様のコンテナーに追加できます。The ApplicationInsights setting allows you to add Azure Application Insights telemetry support to your container. Application Insights によってお客様のコンテナーを詳細に監視できます。Application Insights provides in-depth monitoring of your container. コンテナーの可用性、パフォーマンス、利用状況を簡単に監視できます。You can easily monitor your container for availability, performance, and usage. さらに、お客様のコンテナーのエラーを迅速に特定して診断することもできます。You can also quickly identify and diagnose errors in your container.

次の表に、ApplicationInsights セクションでサポートされている構成設定について説明します。The following table describes the configuration settings supported under the ApplicationInsights section.

必須Required NameName データ型Data type 説明Description
いいえNo InstrumentationKey stringString コンテナーのテレメトリ データの送信先の Application Insights インスタンスのインストルメンテーション キー。The instrumentation key of the Application Insights instance to which telemetry data for the container is sent. 詳細については、「Application Insights for ASP.NET Core」を参照してください。For more information, see Application Insights for ASP.NET Core.

例:Example:
InstrumentationKey=123456789

Billing 構成設定Billing configuration setting

Billing 設定は、コンテナーの課金情報を測定するために使用される Azure の Cognitive Services リソースのエンドポイント URI を指定します。The Billing setting specifies the endpoint URI of the Cognitive Services resource on Azure used to meter billing information for the container. この構成設定の値を指定する必要があり、値は Azure の Cognitive Services リソースの有効なエンドポイント URI である必要があります。You must specify a value for this configuration setting, and the value must be a valid endpoint URI for a _Cognitive Services resource on Azure. コンテナーから、約 10 ~ 15 分ごとに使用状況が報告されます。The container reports usage about every 10 to 15 minutes.

この設定は次の場所で確認できます。This setting can be found in the following place:

  • Azure portal:Cognitive Services の [概要]。Endpoint として表示されます。Azure portal: Cognitive Services Overview, labeled Endpoint

text/analytics/v2.0 ルーティングをエンドポイント URI に追加する必要があります。次の BILLING_ENDPOINT_URI の例を参照してください。You need to add the text/analytics/v2.0 routing to the endpoint URI as shown in the following BILLING_ENDPOINT_URI example.

必須Required NameName データ型Data type 説明Description
はいYes Billing stringString 課金エンドポイント URIBilling endpoint URI

例:Example:
Billing=https://westus.api.cognitive.microsoft.com/text/analytics/v2.1

Eula 設定Eula setting

Eula 設定は、コンテナーのライセンスに同意済みであることを示します。The Eula setting indicates that you've accepted the license for the container. この構成設定の値を指定する必要があり、値を accept に設定する必要があります。You must specify a value for this configuration setting, and the value must be set to accept.

必須Required NameName データ型Data type 説明Description
はいYes Eula stringString ライセンスへの同意License acceptance

例:Example:
Eula=accept

Cognitive Services のコンテナーは、Azure の使用について定める契約の下でライセンスされます。Cognitive Services containers are licensed under your agreement governing your use of Azure. Azure の使用について定める契約をまだ結んでいない場合、Azure の使用について定める契約がマイクロソフト オンライン サブスクリプション契約 (オンライン サービス規約を含む) であることに同意するものとします。If you do not have an existing agreement governing your use of Azure, you agree that your agreement governing use of Azure is the Microsoft Online Subscription Agreement, which incorporates the Online Services Terms. また、プレビューに関しては、「Microsoft Azure プレビューの追加使用条件」にも同意するものとします。For previews, you also agree to the Supplemental Terms of Use for Microsoft Azure Previews. コンテナーの使用をもって、お客様はこれらの規約に同意したものとします。By using the container you agree to these terms.

Fluentd の設定Fluentd settings

Fluentd は、ログの一元管理を実現するオープンソースのデータ コレクターです。Fluentd is an open-source data collector for unified logging. Fluentd サーバーに対するコンテナーの接続は、Fluentd の設定によって管理されます。The Fluentd settings manage the container's connection to a Fluentd server. コンテナーには、お客様のコンテナーでログ、および必要に応じてメトリック データを Fluentd サーバーに書き込むことができる Fluentd ログ プロバイダーが含まれます。The container includes a Fluentd logging provider, which allows your container to write logs and, optionally, metric data to a Fluentd server.

次の表に、Fluentd セクションでサポートされている構成設定について説明します。The following table describes the configuration settings supported under the Fluentd section.

NameName データ型Data type 説明Description
Host stringString Fluentd サーバーの IP アドレスまたは DNS ホスト名。The IP address or DNS host name of the Fluentd server.
Port 整数Integer Fluentd サーバーのポート。The port of the Fluentd server.
既定値は 24224 です。The default value is 24224.
HeartbeatMs 整数Integer ハートビート間隔 (ミリ秒)。The heartbeat interval, in milliseconds. この間隔が期限切れになるまでにイベント トラフィックが送信されなかった場合、ハートビートが Fluentd サーバーに送信されます。If no event traffic has been sent before this interval expires, a heartbeat is sent to the Fluentd server. 既定値は、60000 ミリ秒 (1 分) です。The default value is 60000 milliseconds (1 minute).
SendBufferSize 整数Integer 送信操作用に割り当てられたネットワーク バッファー領域 (バイト数)。The network buffer space, in bytes, allocated for send operations. 既定値は、32,768 バイト (32 キロバイト) です。The default value is 32768 bytes (32 kilobytes).
TlsConnectionEstablishmentTimeoutMs 整数Integer Fluentd サーバーとの SSL または TLS 接続を確立するためのタイムアウト (ミリ秒)。The timeout, in milliseconds, to establish a SSL/TLS connection with the Fluentd server. 既定値は、10000 ミリ秒 (10 秒) です。The default value is 10000 milliseconds (10 seconds).
UseTLS が false に設定されている場合、この値は無視されます。If UseTLS is set to false, this value is ignored.
UseTLS BooleanBoolean コンテナーで、Fluentd サーバーとの通信に SSL または TLS を使用する必要があるかどうかを示します。Indicates whether the container should use SSL/TLS for communicating with the Fluentd server. 既定値は false です。The default value is false.

Http プロキシ資格情報設定Http proxy credentials settings

送信要求を行うために HTTP プロキシを構成する必要がある場合は、次の 2 つの引数を使用します。If you need to configure an HTTP proxy for making outbound requests, use these two arguments:

NameName データ型Data type 説明Description
HTTP_PROXYHTTP_PROXY stringstring 使用するプロキシ。例: http://proxy:8888The proxy to use, for example, http://proxy:8888
HTTP_PROXY_CREDSHTTP_PROXY_CREDS stringstring プロキシで認証されるために必要な資格情報。例: ユーザー名:パスワード。Any credentials needed to authenticate against the proxy, for example, username:password.
<proxy-user> stringstring プロキシのユーザー。The user for the proxy.
proxy-password stringstring プロキシの <proxy-user> に関連付けられているパスワード。The password associated with <proxy-user> for the proxy.
docker run --rm -it -p 5000:5000 \
--memory 2g --cpus 1 \
--mount type=bind,src=/home/azureuser/output,target=/output \
<registry-location>/<image-name> \
Eula=accept \
Billing=<billing-endpoint> \
ApiKey=<api-key> \
HTTP_PROXY=<proxy-url> \
HTTP_PROXY_CREDS=<proxy-user>:<proxy-password> \

Logging の設定Logging settings

Logging の設定では、お客様のコンテナーの ASP.NET Core ログ サポートを管理します。The Logging settings manage ASP.NET Core logging support for your container. お客様が ASP.NET Core アプリケーションに対して使用するのと同じ構成設定と値をお客様のコンテナーに使用できます。You can use the same configuration settings and values for your container that you use for an ASP.NET Core application.

コンテナーでは、次のログ プロバイダーがサポートされています。The following logging providers are supported by the container:

プロバイダーProvider 目的Purpose
ConsoleConsole ASP.NET Core Console ログ プロバイダー。The ASP.NET Core Console logging provider. このログ プロバイダーのすべての ASP.NET Core 構成設定と既定値がサポートされています。All of the ASP.NET Core configuration settings and default values for this logging provider are supported.
デバッグDebug ASP.NET Core Debug ログ プロバイダー。The ASP.NET Core Debug logging provider. このログ プロバイダーのすべての ASP.NET Core 構成設定と既定値がサポートされています。All of the ASP.NET Core configuration settings and default values for this logging provider are supported.
ディスクDisk JSON ログ プロバイダー。The JSON logging provider. このログ プロバイダーは、ログ データを出力マウントに書き込みます。This logging provider writes log data to the output mount.

このコンテナー コマンドは、ログ情報を JSON 形式で出力マウントに格納します。This container command stores logging information in the JSON format to the output mount:

docker run --rm -it -p 5000:5000 \
--memory 2g --cpus 1 \
--mount type=bind,src=/home/azureuser/output,target=/output \
<registry-location>/<image-name> \
Eula=accept \
Billing=<billing-endpoint> \
ApiKey=<api-key> \
Logging:Disk:Format=json

このコンテナー コマンドは、コンテナーの実行中に、dbug で始まるデバッグ情報を表示します。This container command shows debugging information, prefixed with dbug, while the container is running:

docker run --rm -it -p 5000:5000 \
--memory 2g --cpus 1 \
<registry-location>/<image-name> \
Eula=accept \
Billing=<billing-endpoint> \
ApiKey=<api-key> \
Logging:Console:LogLevel:Default=Debug

Disk ログDisk logging

Disk ログ プロバイダーでは、次の構成設定がサポートされます。The Disk logging provider supports the following configuration settings:

NameName データ型Data type 説明Description
Format stringString ログ ファイルの出力形式。The output format for log files.
注: ログ プロバイダーを有効にするためにこの値を json に設定する必要があります。Note: This value must be set to json to enable the logging provider. コンテナーのインスタンス化中に、出力マウントを指定せずに、この値を指定した場合、エラーが発生します。If this value is specified without also specifying an output mount while instantiating a container, an error occurs.
MaxFileSize 整数Integer ログ ファイルの最大サイズ (メガバイト (MB))。The maximum size, in megabytes (MB), of a log file. 現在のログ ファイルのサイズがこの値を満たしているか、または超えている場合、ログ プロバイダーによって新しいログ ファイルが開始されます。When the size of the current log file meets or exceeds this value, a new log file is started by the logging provider. -1 が指定されている場合、ログ ファイルのサイズは、出力マウントの最大ファイル サイズ (存在する場合) によってのみ制限されます。If -1 is specified, the size of the log file is limited only by the maximum file size, if any, for the output mount. 既定値は 1 です。The default value is 1.

ASP.NET Core ログのサポートを構成する方法の詳細については、設定ファイル構成に関するページを参照してください。For more information about configuring ASP.NET Core logging support, see Settings file configuration.

マウントの設定Mount settings

コンテナーとの間でデータを読み書きするには、バインド マウントを使用します。Use bind mounts to read and write data to and from the container. 入力マウントまたは出力マウントは、docker run コマンドで --mount オプションを指定することによって指定できます。You can specify an input mount or output mount by specifying the --mount option in the docker run command.

Text Analytics コンテナーでは、トレーニングやサービスのデータを格納するために入力マウントまたは出力マウントが使用されることはありません。The Text Analytics containers don't use input or output mounts to store training or service data.

ホストのマウント場所の厳密な構文は、ホスト オペレーティング システムによって異なります。The exact syntax of the host mount location varies depending on the host operating system. また、Docker サービス アカウントによって使用されるアクセス許可とホストのマウント場所のアクセス許可とが競合するために、ホスト コンピューターのマウント場所にアクセスできないこともあります。Additionally, the host computer's mount location may not be accessible due to a conflict between permissions used by the docker service account and the host mount location permissions.

省略可能Optional NameName データ型Data type 説明Description
禁止Not allowed Input stringString Text Analytics コンテナーでは、これは使用されません。Text Analytics containers do not use this.
省略可能Optional Output stringString 出力マウントのターゲット。The target of the output mount. 既定値は /output です。The default value is /output. これはログの保存先です。This is the location of the logs. これには、コンテナーのログが含まれます。This includes container logs.

例:Example:
--mount type=bind,src=c:\output,target=/output

docker run コマンドの例Example docker run commands

以下の例では、docker run コマンドの記述方法と使用方法を示す構成設定が使用されています。The following examples use the configuration settings to illustrate how to write and use docker run commands. コンテナーは一度実行すると、お客様が停止するまで動作し続けます。Once running, the container continues to run until you stop it.

  • 行連結文字: 以降のセクションの Docker コマンドには、行連結文字としてバック スラッシュ (\) が使用されています。Line-continuation character: The docker commands in the following sections use the back slash, \, as a line continuation character. お客様のホスト オペレーティング システムの要件に応じて、置換または削除してください。Replace or remove this based on your host operating system's requirements.
  • 引数の順序: Docker コンテナーについて高度な知識がある場合を除き、引数の順序は変更しないでください。Argument order: Do not change the order of the arguments unless you are very familiar with docker containers.

text/analytics/v2.0 ルーティングをエンドポイント URI に追加する必要があります。次の BILLING_ENDPOINT_URI の例を参照してください。You need to add the text/analytics/v2.0 routing to the endpoint URI as shown in the following BILLING_ENDPOINT_URI example.

{ <引数名> } はお客様独自の値に置き換えてください。Replace {argument_name} with your own values:

プレースホルダーPlaceholder Value 形式または例Format or example
{BILLING_KEY}{BILLING_KEY} Azure Cognitive Services の [キー] ページで使用可能な Cognitive Services リソースのエンドポイント キー。The endpoint key of the Cognitive Services resource available on the Azure Cognitive Services Keys page. xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
{BILLING_ENDPOINT_URI}{BILLING_ENDPOINT_URI} 課金エンドポイントの値は、Azure Cognitive Services の [概要] ページで確認できます。The billing endpoint value is available on the Azure Cognitive Services Overview page. https://westus.api.cognitive.microsoft.com/text/analytics/v2.1

重要

コンテナーを実行するには、EulaBillingApiKey の各オプションを指定する必要があります。そうしないと、コンテナーが起動しません。The Eula, Billing, and ApiKey options must be specified to run the container; otherwise, the container won't start. 詳細については、「課金」を参照してください。For more information, see Billing. ApiKey の値は、Azure Cognitive Services リソース キー ページにあるキーです。The ApiKey value is the Key from the Azure Cognitive Services Resource keys page.

キー フレーズ抽出コンテナー docker の例Key phrase extraction container docker examples

次の docker 例はキー フレーズ抽出コンテナーに対するものです。The following docker examples are for the key phrase extraction container.

基本的な例Basic example

docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 mcr.microsoft.com/azure-cognitive-services/keyphrase Eula=accept Billing={BILLING_ENDPOINT_URI} ApiKey={BILLING_KEY} 

ログの例Logging example

docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 mcr.microsoft.com/azure-cognitive-services/keyphrase Eula=accept Billing={BILLING_ENDPOINT_URI} ApiKey={BILLING_KEY} Logging:Console:LogLevel:Default=Information

言語検出コンテナー docker の例Language detection container docker examples

次の docker 例は言語検出コンテナーに対するものです。The following docker examples are for the language detection container.

基本的な例Basic example

docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 mcr.microsoft.com/azure-cognitive-services/language Eula=accept Billing={BILLING_ENDPOINT_URI} ApiKey={BILLING_KEY} 

ログの例Logging example

docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 mcr.microsoft.com/azure-cognitive-services/language Eula=accept Billing={BILLING_ENDPOINT_URI} ApiKey={BILLING_KEY} Logging:Console:LogLevel:Default=Information

感情分析コンテナー docker の例Sentiment analysis container docker examples

次の docker 例は感情分析コンテナーに対するものです。The following docker examples are for the sentiment analysis container.

基本的な例Basic example

docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 mcr.microsoft.com/azure-cognitive-services/sentiment Eula=accept Billing={BILLING_ENDPOINT_URI} ApiKey={BILLING_KEY} 

ログの例Logging example

docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 mcr.microsoft.com/azure-cognitive-services/sentiment Eula=accept Billing={BILLING_ENDPOINT_URI} ApiKey={BILLING_KEY} Logging:Console:LogLevel:Default=Information

次の手順Next steps