google.appengine.api.logservice.logservice モジュール

概要

LogService API。

このモジュールは、アプリがログをフラッシュし、ステータス メッセージを提供して、リクエストおよびアプリケーション ログにプログラムからアクセスできるようにします。

内容

class google.appengine.api.logservice.logservice.AppLog(time=None, level=None, message=None, source_location=None)ソース

ベース: object

リクエストの処理中に生成されたアプリケーション ログ行。

level

ログのレベルまたは重大度(int)。

message

アプリケーション提供のログメッセージ(文字列)。

source_location

ログ ステートメントのソースの source_location。サポートされていない場合は None。

time

UNIX エポック時刻からの秒数で時間ログエントリが作成されました(浮動小数点数)。

exception google.appengine.api.logservice.logservice.Errorソース

ベース: exceptions.Exception

このモジュールのベース エラー クラス。

exception google.appengine.api.logservice.logservice.InvalidArgumentErrorソース

ベース: google.appengine.api.logservice.logservice.Error

関数の引数の値が無効です。

google.appengine.api.logservice.logservice.LogsBuffer(stream=None, stderr=False)ソース
class google.appengine.api.logservice.logservice.RequestLog(request_log=None)ソース

ベース: object

アプリケーションへの単一のリクエストに関する完全なログ情報。

api_mcycles

リクエストの処理中に API 呼び出しに費やされたマシンサイクルの数。

非推奨。もうこの値に意味はありません。

戻り値

long 値として使用される API マシンサイクルの数。該当しない場合は None。

app_engine_release

このリクエストを処理した App Engine インフラストラクチャのリリース。

戻り値

このリクエストを処理した App Engine のバージョンを含む文字列。該当しない場合は None。

app_id

このリクエストを処理したアプリケーションの ID(文字列)。

app_logs

このリクエストの処理中にアプリケーションによって生成されたログ。

戻り値

このリクエストのログ行を表す AppLog オブジェクトのリスト。何も生成されなかったか、またはクエリが要求しなかった場合は空のリスト。

combined

リクエストの Apache コンバインド ログのエントリ。

このフィールド内の情報はこのメッセージの残りの部分から構成できますが、このフィールドは便宜上提供されています。

戻り値

http://httpd.apache.org/docs/1.3/logs.html に記載されている形式の Apache 形式のログ行を含む文字列。

cost

このリクエストの見積もり費用(ドル単位、分数形式)。

戻り値

このリクエストの見積もり費用(見積もり費用)を表す浮動小数点数。該当しない場合は None。

end_time

リクエストが完了したことがわかった時刻。

戻り値

リクエスト完了時刻を表す浮動小数点数(UNIX エポックからの秒数)。

finished

このログが終了したリクエストを表すかどうか(ブール値)。

host

リクエストされているリソースのインターネット ホストとポート番号。

戻り値

リクエストを受け取ったホストとポートを表す文字列。該当しない場合は None。

http_version

リクエストの HTTP バージョン(文字列)。

instance_key

リクエストを処理したインスタンスのほぼ一意の識別子。

戻り値

該当する場合はインスタンス キーをエンコードする文字列。それ以外の場合は None。

ip

リクエストの発信元 IP アドレス(文字列)。

latency

リクエストの処理に要した時間(秒単位、浮動小数点数)。

mcycles

リクエストを処理するために使用されたマシンサイクル数(整数)。

method

リクエスト メソッド(GET、PUT、POST など)(文字列)。

module_id

このリクエストを処理したモジュール ID(文字列)。

nickname

既知でログインしている場合リクエストを行ったユーザーのニックネーム(わかっていてログインしている場合)。

戻り値

ログインしているユーザーのニックネームを表す文字列。または None。

offset

結果ストリーム内の現在の位置を示すバイナリ オフセット。

このリクエストの直後に続行するために、将来のログ読み取りリクエストに送信できます。

戻り値

アクティブな結果ストリームへのオフセットを表すバイト文字列。

pending_time

このリクエストが保留中のリクエスト キューで費やした時間。

戻り値

このリクエストが保留されていた時間(秒単位)を表す浮動小数点数。

referrer

リクエストの参照 URL(文字列)。または None。

replica_index

リクエストを処理したモジュール レプリカ(整数)。または None。

request_id

リクエストの開始時間に基づくリクエストのグローバル一意識別子。

後に開始したリクエストのリクエスト ID は、それより前に開始されたリクエストのリクエスト ID よりもバイナリ文字列として大きくなります。

戻り値

このリクエストの一意識別子を含むバイト文字列。

resource

クライアントによってリクエストされたサーバー上のリソースパス。

たとえば、http://nowhere.com/app のリソース文字列は「/app」になります。

戻り値

リクエスト URL のパス コンポーネントを含む文字列。

response_size

リクエストによってクライアントに返送されるバイト単位のサイズ(long 値)。

start_time

リクエストの処理が開始されたことがわかった時刻。

戻り値

リクエストの処理が始まった時刻(Unix エポックからの経過秒数)を表す浮動小数点数。

status

リクエストのレスポンス ステータス(int)。

task_name

リクエストのタスク名(Task Queue API によって生成された場合)。

戻り値

該当する場合はリクエストのタスク名を含む文字列。それ以外の場合は None。

task_queue_name

リクエストのキュー名(Task Queue API によって生成された場合)。

戻り値

該当する場合はリクエストのキュー名を含む文字列。それ以外の場合は None。

url_map_entry

リクエストに使用される URL マッピング内のファイルまたはクラス。

リクエストの管理に関与したソースコードの追跡に便利です(特に多重マッピングされたハンドラの場合)。

戻り値

ファイル名またはクラス名を含む文字列。

user_agent

リクエストを行うために使用されたユーザー エージェント(文字列)。または None。

version_id

このリクエストを処理したアプリケーションのバージョン(文字列)。

was_loading_request

このリクエストがインスタンスのロード リクエストであったかどうかを返します。

戻り値

このリクエストが読み込みリクエストであるかどうかを示すブール値。

exception google.appengine.api.logservice.logservice.TimeoutError(msg, offset, last_end_time)ソース

ベース: google.appengine.api.logservice.logservice.Error

結果の反復処理注に fetch() 呼び出しのリクエストされたタイムアウトの期限が切れました。

last_end_time

タイムアウトの前に検査された最後のリクエストの終了時間。または None。

戻り値

完了時間を表す浮動小数点数(検査された最後のリクエストの UNIX エポック時刻からの秒数)。

offset

結果ストリーム内の現在の位置を示すバイナリ オフセット。

このイテレータが中断した場所から引き続きログを反復処理するために、将来のログ読み取りリクエストに送信できます。

戻り値

ログストリームへのオフセットを表すバイト文字列。または None。

google.appengine.api.logservice.logservice.autoflush()ソース

AUTOFLUSH 条件が満たされている場合は、Flush API 呼び出しを実行します。

google.appengine.api.logservice.logservice.cleanup_message(message)ソース
google.appengine.api.logservice.logservice.clear()ソース

バッファに保存されたログをクリアし、自動フラッシュ状態をリセットします。

google.appengine.api.logservice.logservice.fetch(*args, **kwds)ソース

アプリケーションのリクエストとアプリケーション ログを生成するイテレータを返します。

ログは、イテレータによって、リクエスト終了時間または進行中のリクエスト(リクエストされている場合)の最後のフラッシュ時間ごとに、時刻の新しい順で返されます。生成されるアイテムは RequestLog オブジェクトであり、そのコンテンツには、メソッド呼び出しによってアクセスできます。

パラメータはすべてオプションです。

パラメータ
  • start_time - 結果を取得する必要があるリクエストの最も古い完了時間または最終更新時間。UNIX エポックからの秒数で指定します。

  • end_time - 結果を取得する必要があるリクエストの最も新しい完了時間または最終更新時間。UNIX エポックからの秒数で指定します。

  • offset - 以前に発行された RequestLog から取得されるログストリームへのオフセットを表すバイト文字列。このイテレータは、オフセットが生成されたレコードの直後に開始されます。

  • minimum_log_level - 返されたリクエストでフィルタとして機能するアプリケーション ログのレベル。指定したレベル以上のアプリケーション ログがないリクエストは省略されます。include_app_logs が True でない場合でも動作します。利用できるログレベルは、低い順に、次のとおりです。logservice.LOG_LEVEL_DEBUG、logservice.LOG_LEVEL_INFO、logservice.LOG_LEVEL_WARNING、logservice.LOG_LEVEL_ERROR、および logservice.LOG_LEVEL_CRITICAL。

  • include_incomplete - 開始しているが終了していないリクエストを含めるかどうか(ブール値)。デフォルトは False です。

  • include_app_logs - 結果にアプリケーション レベル ログを含めるかどうか(ブール値)。デフォルトは False です。

  • module_versions - 指定されたモジュールとバージョンの組み合わせのログを取得する必要があることを示す、フォーム(モジュール、バージョン)のタプルのリスト。重複するタプルは無視されます。この kwarg は、「version_ids」kwarg と組み合わせて使用することはできません。

  • version_ids - ログに対してクエリを実行するバージョン ID のリスト。デフォルトはアプリケーションの現在のバージョン ID のみに設定されます。この kwarg は、「module_versions」kwarg と組み合わせて使用することはできません。

  • request_ids - None でない場合は、時間ベースのスキャンの代わりに、指定されたリクエストのログを返す必要があることを示します。不正なリクエスト ID のためにリクエスト全体が拒否され、不明なリクエストは無視されます。このオプションは、start_time、end_time、offset、minimum_log_level などのフィルタ オプションと組み合わせることはできません。version_ids は無視されます。リクエストログに対応しない ID は無視されます。ログはリクエストされた順序で返されます。

  • **kwargs - 有効な値については、「_FETCH_KWARGS」をご覧ください。

戻り値

ユーザーがクエリを実行したログを含む反復可能なオブジェクト。

発生

InvalidArgumentError - 入力パラメータのいずれかが正しいタイプでない場合に発生します。

google.appengine.api.logservice.logservice.flush()ソース

現在バッファに保存されているログ行を破棄します。

google.appengine.api.logservice.logservice.flush_time()ソース

バッファに保存されたログが最後にフラッシュされた時刻を返します。

google.appengine.api.logservice.logservice.log_buffer_age()ソース

バッファに保存されたログがフラッシュされてからの秒数を返します。

google.appengine.api.logservice.logservice.log_buffer_bytes()ソース

バッファに保存されたログのサイズをバイト単位で返します。

google.appengine.api.logservice.logservice.log_buffer_contents()ソース

バッファに保存されたログのコンテンツを返します。

google.appengine.api.logservice.logservice.log_buffer_lines()ソース

現在バッファに保存されているログの行数を返します。

google.appengine.api.logservice.logservice.logs_buffer()ソース

現在のリクエストで使用されている LogsBuffer を返します。

google.appengine.api.logservice.logservice.source_location_to_tuple(locpb)ソース

SourceLocation proto をプリミティブ タイプのタプルに変換します。

google.appengine.api.logservice.logservice.write(message)ソース

バッファに保存されたログに「message」を追加し、自動フラッシュをチェックします。

パラメータ

message - アプリケーション ログに書き込まれるメッセージ(文字列)。

google.appengine.api.logservice.logservice.write_record(level, created, message, source_location=None)ソース

バッファに保存されたログに「レコード」を追加し、自動フラッシュをチェックします。

パラメータ
  • level - レコードのロギングレベル。0~4 です。

  • created - レコードが作成された時間(秒)。

  • message - 書式設定されたメッセージ。

  • source_location - ソースの場所。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Python の App Engine スタンダード環境