Activity クラス

定義

ログ記録に使用されるコンテキストを使用して、操作を表します。Represents an operation with context to be used for logging.

public ref class Activity : IDisposable
public ref class Activity
public class Activity : IDisposable
public class Activity
type Activity = class
    interface IDisposable
type Activity = class
Public Class Activity
Implements IDisposable
Public Class Activity
継承
Activity
実装

注釈

Activity は、操作名、ID、開始時刻と期間、タグ、および荷物があります。An Activity has an operation name, an ID, a start time and duration, tags, and baggage.

現在のアクティビティには、静的なプロパティを使用してアクセスでき Activity.Current ます。The current activity can be accessed with the static Activity.Current property.

アクティビティを作成するには、コンストラクターを呼び出し、必要に応じて構成した後、 Start アクティビティとセットの親子関係を維持するメソッドを使用して作業を開始する必要があり Activity.Current ます。Activities should be created by calling the constructor, configured as necessary, and then started with the Start method, which maintains parent-child relationships for the activities and sets Activity.Current.

アクティビティが完了したら、メソッドを使用して停止する必要があり Activity.Stop() ます。When an activity is finished, it should be stopped with the Activity.Stop() method.

Activity無効な入力への応答として例外をエスケープするメソッドはありません。No Activity methods allow exceptions to escape as a response to bad inputs. これらはスローされ、キャッチされます (これにより、デバッガーとモニターはエラーを確認できます) が、例外は抑制され、操作は適切な処理を実行します (通常は何も行われません)。They are thrown and caught (which allows debuggers and monitors to see the error), but the exception is suppressed, and the operation does something reasonable (typically it does nothing).

コンストラクター

Activity(String)

Activity クラスの新しいインスタンスを初期化します。Initializes a new instance of the Activity class.

プロパティ

ActivityTraceFlags

アクティビティに関連付けられている (W3C ID 仕様によって定義された) フラグを取得または設定します。Gets or sets the flags (defined by the W3C ID specification) associated with the activity.

Baggage

この Activity の子に渡される情報を表すキーと値のペアのコレクションを取得します。Gets a collection of key/value pairs that represents information that is passed to children of this Activity.

Context

アクティビティのコンテキストを取得します。Gets the context of the activity. コンテキストは、アクティビティが開始されている場合にのみ有効になります。Context becomes valid only if the activity has been started.

Current

現在のスレッドの現在の操作 (Activity) を取得または設定します。Gets or sets the current operation (Activity) for the current thread. これは非同期呼び出し間でフローします。This flows across async calls.

DefaultIdFormat

Activity の既定の ID の形式を取得または設定します。Gets or sets the default ID format for the Activity.

DisplayName

アクティビティの表示名を取得または設定します。Gets or sets the display name of the activity.

Duration

操作の継続時間を取得します。Gets the duration of the operation.

Events

このアクティビティにアタッチされているすべてのアクティビティ イベントのリストを取得します。Gets the list of all the activity events attached to this activity.

ForceDefaultIdFormat

既定の ID 形式を定義するために DefaultIdFormat を常に使用するかどうかを決定する値を取得または設定します。Gets or sets a value that detrmines if the DefaultIdFormat is always used to define the default ID format.

Id

特定の要求に固有の識別子を取得します。Gets an identifier that is specific to a particular request.

IdFormat

Id の形式を取得します。Gets the format for the Id.

IsAllDataRequested

このアクティビティに、すべての伝達情報に加えて、リンク、タグ、イベントなどの他のすべてのプロパティを設定する必要があるかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether this activity should be populated with all the propagation information, as well as all the other properties, such as links, tags, and events.

Kind

トレースにおける、アクティビティ、その親、およびその子の間のリレーションシップを取得します。Gets the relationship between the activity, its parents, and its children in a trace.

Links

このアクティビティにアタッチされているすべてのアクティビティ リンクのリストを取得します。Gets the list of all the activity links attached to this activity.

OperationName

操作名を取得します。Gets the operation name.

Parent

このアクティビティを作成した親 Activity を取得します。Gets the parent Activity that created this activity.

ParentId

このアクティビティの親の ID を取得します。Gets the ID of this activity's parent.

ParentSpanId

親の SpanId を取得します。Gets the parent's SpanId.

Recorded

W3CIdFlags.Recorded フラグが設定されているかどうかを示す値を取得します。Gets a value that indicates whether the W3CIdFlags.Recorded flag is set.

RootId

この Activity のルート ID を取得します。Gets the root ID of this Activity.

Source

このアクティビティに関連付けられているアクティビティ ソースを取得します。Gets the activity source associated with this activity.

SpanId

Id の SPAN 部分を取得します。Gets the SPAN part of the Id.

StartTimeUtc

操作が開始された時間を取得します。Gets the time when the operation started.

TagObjects

アクティビティと共にログに記録する情報を表すタグのリストを取得します。Gets the list of tags that represent information to log along with the activity. この情報は、このアクティビティの子には渡されません。This information is not passed on to the children of this activity.

Tags

ログ システムに Activity と共に書き込まれる情報を表すキーと値のペアのコレクションを取得します。Gets a collection of key/value pairs that represent information that will be logged along with the Activity to the logging system.

TraceId

Id の TraceId 部分を取得します。Gets the TraceId part of the Id.

TraceStateString

W3C tracestate ヘッダーを取得または設定します。Gets or sets the W3C tracestate header.

メソッド

AddBaggage(String, String)

指定したキーと値の新しい baggage 項目を得られるように Activity を更新します。Updates the Activity to have a new baggage item with the specified key and value.

AddEvent(ActivityEvent)

指定したアクティビティ イベントをイベント リストに追加します。Adds the specified activity event to the events list.

AddTag(String, Object)

追加の keyvalue を含むタグを持つようにアクティビティを更新します。Updates the activity to have a tag with an additional key and value.

AddTag(String, String)

指定した keyvalue で新しいタグが得られるように Activity を更新します。Updates the Activity to have a new tag with the provided key and value.

Dispose()

アクティビティが既に開始されている場合は停止し、すべてのイベント リスナーに通知します。Stops the activity if it is already started and notifies any event listeners. それ以外の場合は、何も起こりません。Nothing will happen otherwise.

Dispose(Boolean)

このメソッドが派生型でオーバーライドされた場合、割り当てられたすべてのリソースが解放されます。When overriden by a derived type, this method releases any allocated resources.

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetBaggageItem(String)

AddBaggage(String, String) でアクティビティに追加されたキーと値のペアの値を返します。Returns the value of a key-value pair added to the activity with AddBaggage(String, String).

GetCustomProperty(String)

指定したプロパティ名にマップされたオブジェクトを返します。Returns the object mapped to the specified property name.

GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
SetCustomProperty(String, Object)

このアクティビティにカスタム オブジェクトをアタッチします。Attaches any custom object to this activity. 指定した propertyName が以前に別のオブジェクトに関連付けられていた場合は、代わりに新しい propertyValue に関連付けられるようにプロパティが更新されます。If the specified propertyName was previously associated with another object, the property will be updated to be associated with the new propertyValue instead. 同じ値を使用する他のユーザーとの競合を避けるために、一意のプロパティ名を使用することをお勧めします。It is recommended to use a unique property name to avoid conflicts with anyone using the same value.

SetEndTime(DateTime)

Activity を更新して、その DurationStartTimeUtc と指定した停止時間の差に設定します。Updates the Activity to set its Duration as the difference between StartTimeUtc and the specified stop time.

SetIdFormat(ActivityIdFormat)

開始される前に、この Activity で ID 形式を設定します。Sets the ID format on this Activity before it is started.

SetParentId(ActivityTraceId, ActivitySpanId, ActivityTraceFlags)

TraceId および SpanId の W3C 規約を使用して、親 ID を設定します。Sets the parent ID using the W3C convention of a TraceId and a SpanId.

SetParentId(String)

この Activity を更新して、parentId の ID の Activity がこの Activity を発生させたことを示します。Updates this Activity to indicate that the Activity with an ID of parentId caused this Activity.

SetStartTime(DateTime)

この Activity の開始時間を設定します。Sets the start time of this Activity.

SetTag(String, Object)

入力キーと値を使用してアクティビティ タグを追加または更新します。Adds or update the activity tag with the input key and value.

Start()

アクティビティを開始します。Starts the activity.

Stop()

アクティビティを停止します。Stops the activity.

ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(継承元 Object)

適用対象