ttExporter

Linux x8664システムでは、ttExporterユーティリティを使用するとPrometheusでTimesTenのヘルスと操作を監視できます。Prometheusは、オープン・ソース・システムの監視およびアラート・ツールキットです。様々なソースからメトリックを収集して格納します。独自の時系列データベースと時系列問合せ言語があります。

TimesTenエクスポータは、TimesTenメトリックをPrometheusによって使用される形式に変換します。この統合により、Prometheusで監視するシステムにTimesTenを追加できます。

Prometheusの構成および監視されるメトリックの詳細とメトリックの表示方法については、Oracle TimesTen In-Memoryモニタリングおよびトラブルシューティング・ガイドTimesTen Prometheusエクスポータを参照してください。

必要な権限

オペレーティング・システム・ユーザーは、Prometheusが監視するインスタンス内の各TimesTenデータベースのユーザーと一致する必要があります。インスタンス管理者ユーザーとしてttExporterを実行する場合、さらに権限は必要ありません。ただし、ttExporterを別のオペレーティング・システム・ユーザーとして実行する場合は、そのユーザーがPrometheusによって監視されるインスタンスの各TimesTenデータベースに存在する必要があります。また、オペレーティング・システム・ユーザーにはCREATE SESSION権限が付与されている必要があります。たとえば、osuser1オペレーティング・システム・ユーザーがttExporterを実行する場合、Prometheusによって監視されるインスタンス内の各TimesTenデータベースで次の操作を実行する必要があります。
Command> CREATE USER osuser1 IDENTIFIED EXTERNALLY;

User created.

Command> GRANT CREATE SESSION TO osuser1;

TimesTen ScaleoutおよびTimesTen Classicでの使用

このユーティリティは、TimesTen ClassicとTimesTen Scaleoutの両方でサポートされています。

TimesTen Scaleoutでは、データ・インスタンスまたは管理インスタンスのいずれかを実行している各ホストでエクスポータがサポートされています。1つのホストに複数のデータ・インスタンスがある場合は、データ・インスタンスごとに1つのエクスポータをデプロイします。

構文

ttExporter -h | -help

ttExporter -create-server-certificate [-rsa-key-size bits][-certificate-common-name dnsip1] [-certificate-alt-names dnsip2]  [-certificate-directory mycertdir]

ttExporter -export-server-certificate serverfilename [-certificate-directory mycertdir]

ttExporter -export-client-certificate clientfilename -export-client-private-key keyfile 
  [-certificate-directory mycertdir]

ttExporter [-insecure] [-limit-rate r] -port p [-pid-file pidfilename] [-d]
  [-certificate-directory mycertdir]

オプション

ttExporterには次のオプションがあります。

オプション 説明

-h

-help

使用方法のメッセージを出力して終了します。

-certificate-directory mycertdir

エクスポータが使用する証明書情報を含むOracleウォレットが格納されるディレクトリを定義します。(mycertdirは、この例のディレクトリの場所です。)-certificate-directoryを指定する場合は、ttExporterのすべての呼出しに対してこのオプションを指定する必要があります。これには、サーバー証明書の作成時、サーバー証明書のエクスポート時、クライアント証明書とクライアント秘密キーの両方の作成とエクスポート時、およびエクスポータの起動時が含まれます。

ディレクトリを指定しない場合、証明書はユーザーのホーム・ディレクトリ($HOME)のOracleウォレットに格納されます。

-create-server-certificate [-rsa-key-size bits]

新規サーバー証明書を作成します。エクスポータはサーバー証明書を使用して、クライアントに対する自己認証とクライアント証明書の認証を行います。

新しいサーバー証明書を作成すると、以前にエクスポートされたクライアント証明書が無効になります。

-rsa-key-sizeで指定されたキー・サイズは、2048以上のビット数値にすることができます。指定しない場合、デフォルトは2048です。-rsa-key-sizeオプションは不要です。

このオプションを指定すると、エクスポータが起動しません。

[-certificate-common-name dnsip1] [-certificate-alt-names dnsip2]

サーバー証明書を作成するための追加オプションを定義します。-create-server-certificateオプションを付けて使用する必要があります。TimesTen Kubernetesオペレータでエクスポータを使用している場合、-certificate-common-nameおよび-certificate-alt-namesオプションは必須です。使用方法および例については、『Oracle TimesTen In-Memory Database Kubernetesオペレータ・ユーザーズ・ガイド』「独自のOracle Wallet、証明書およびKubernetes Secretの作成」および「証明書の作成」を参照してください。

-certificate-common-name dnsip1オプションによって、証明書の共通(CN)を指定できます。これは、証明書がインストールされているDNS名またはIPアドレスと一致します。このCNには1つの名前のみを含めることができます。単一レベルのワイルドカードを使用できます。dnsip1変数をこのCNに置き換えます。

-certificate-alt-names dnsip2オプションによって、サブジェクト代替(SAN)を指定できます。これは、証明書によって保護され、証明書に含まれているすべてのドメイン名およびIPアドレスを示す構造化された方法です。dnsip2変数をこのSANに置き換えます。SANには、前述のCNとともに、TimesTenエクスポータにアクセスする必要があるその他のDNS名またはIPアドレスが含まれます。単一レベルのワイルドカードを使用できます。

-d エクスポータをデバッグ・モードで起動し、ログ・メッセージをsyslogではなく標準出力に書き込みます。(デフォルトでは、ログ・メッセージはsyslogに書き込まれます。)
-export-server-certificate serverfilename

サーバー証明書をPEM形式でエクスポートします。この例では、証明書をserverfilenameファイルにエクスポートします。

このオプションを指定すると、エクスポータが起動しません。

-export-client-certificate clientfilename -export-client-private-key keyfile

クライアント証明書を作成してファイル(この例ではclientfilename)にエクスポートし、クライアント秘密キーをファイル(この例ではkeyfile)にエクスポートします。これらの2つのオプションを一緒に指定する必要があります。

このオプションを指定すると、エクスポータが起動しません。

-insecure HTTPプロトコルを使用して、セキュアでないモード(認証なし)でエクスポータを起動します。

このモードでは、エクスポータはサーバー証明書を使用して自身を認証せず、クライアント証明書も認証しません。

-limit-rate r

1分当たりのHTTP (またはHTTPS) GETリクエストの制限を設定します。ここで、rはリクエストの数と同じです。rの値は、1から15の任意の整数値にできます。

このオプションを指定しない場合、エクスポータは1分当たり最大10個のHTTP (またはHTTPS) GETリクエストに応答します。

-pid-file pidfilename

エクスポータの起動時に、オプションで-pid-fileオプションを指定できます。指定した場合、ttExporterはプロセスIDをファイルに書き込みます(この例ではpidfilename)。その後、このファイルに格納されているプロセスIDを終了することで、エクスポータを停止できます。これは、SIGINTRまたはSIGTERMシグナルでエクスポータを停止する代替手段です。

-port p エクスポータのリスニング・ポート番号(この例ではp)を設定します。エクスポータを起動するたびにポート番号を設定する必要があります。

認証なしでエクスポータを起動するには、次を使用します。

% ttExporter -insecure -port 12345

クライアント証明書認証を使用するには:

サーバー証明書を1回作成します。-certificate-directoryで指定されたディレクトリにあるOracleウォレットに証明書を格納します。この例では、ディレクトリはmycertdirです。

% ttExporter -create-server-certificate -certificate-directory mycertdir

サーバー証明書を作成したら、PEM形式でファイルにエクスポートします。-certificate-directoryオプションは、(サーバー証明書の作成時に指定されたとおりに)指定する必要があります。

% ttExporter -export-server-certificate mycertdir/server.crt -certificate-directory mycertdir

サーバー証明書をエクスポートした後、クライアント証明書とクライアント秘密キーの両方を作成してエクスポートします。エクスポータからメトリックをスクレイプするPrometheusインスタンスごとに、クライアント証明書とクライアント秘密キーを作成してエクスポートする必要があります。-certificate-directoryオプションは、(サーバー証明書の作成時に指定されたとおりに)指定する必要があります。

% ttExporter -export-client-certificate mycertdir/client.crt 
    -export-client-private-key mycertdir/key.crt -certificate-directory mycertdir

クライアント証明書とクライアント秘密キーを作成してエクスポートした後、エクスポータを起動します。ttExporterでファイル(この例では、/tmp/ttexporter.pid)にプロセスIDを書き込む場合は、-pid-fileオプションを指定します。-certificate-directoryオプションは、(サーバー証明書の作成時に指定されたとおりに)指定する必要があります。

% ttExporter -port 12345 -pid-file /tmp/ttexporter.pid -certificate-directory mycertdir