Skip to content

Latest commit

 

History

History
931 lines (600 loc) · 72.7 KB

File metadata and controls

931 lines (600 loc) · 72.7 KB

nsTelemetry

Contents

ITelemetry type

Namespace

NishySoftware.Telemetry

Summary

[en] Interface for Telemetry

[ja] Telemetry用のインターフェース

GlobalExceptionMetrics property

Summary

[en] The property that holds the metrics to be sent by default when using ITelemetry.TrackException(). Since this property is shared globally, you need to lock the GlobalSyncObject when manipulating or referencing this property.

[ja] ITelemetry.TrackException() を使用するときに既定で送信するメトリックを保持するプロパティ。 このプロパティはグローバルで共有されるため、このプロパティを操作・参照するときは、GlobalSyncObject でLockする必要があります。

Remarks

[en] The metrics held by this property will be sent by all ITelemetry.TrackException(), regardless of the Interface instance. If a metric with the same name is specified in an instance of Interface or in an argument of ITelemetry.TrackException(), the value with the same name will take precedence over the value in the order of argument and Interface

[ja] このプロパティが保持するメトリックはInterfaceのインスタンスによらず、すべての ITelemetry.TrackException() で送信されます。 Interfaceのインスタンスや ITelemetry.TrackException() の引数で同じ名前のメトリックが指定された場合は、同じ名前の値は、引数、Interfaceの順で優先されます。

GlobalExceptionProperties property

Summary

[en] The property that holds the properties to be sent by default when using ITelemetry.TrackException(). Since this property is shared globally, you need to lock the GlobalSyncObject when manipulating or referencing this property.

[ja] ITelemetry.TrackException() を使用するときに既定で送信するプロパティを保持するプロパティ。 このプロパティはグローバルで共有されるため、このプロパティを操作・参照するときは、GlobalSyncObject でLockする必要があります。

Remarks

[en] The properties held by this property will be sent by all ITelemetry.TrackException(), regardless of the Interface instance. If a property with the same name is specified in an instance of Interface or in an argument of ITelemetry.TrackException(), the value with the same name will take precedence over the value in the order of argument and Interface

[ja] このプロパティが保持するプロパティはInterfaceのインスタンスによらず、すべての ITelemetry.TrackException() で送信されます。 Interfaceのインスタンスや ITelemetry.TrackException() の引数で同じ名前のプロパティが指定された場合は、同じ名前の値は、引数、Interfaceの順で優先されます。

GlobalMetrics property

Summary

[en] The property that holds the metrics to be sent by default. Since this property is shared globally, you need to lock the GlobalSyncObject when manipulating or referencing this property.

[ja] 既定で送信するメトリックを保持するプロパティ。 このプロパティはグローバルで共有されるため、このプロパティを操作・参照するときは、GlobalSyncObject でLockする必要があります。

Remarks

[en] The metrics held by this property will be sent by all ITelemetry.TrackXXXX(), regardless of the Interface instance. If a metric with the same name is specified in an instance of Interface or in an argument of ITelemetry.TrackXXXX(), the value with the same name will take precedence over the value in the order of argument and Interface

[ja] このプロパティが保持するメトリックはInterfaceのインスタンスによらず、すべての ITelemetry.TrackXXXX() で送信されます。 Interfaceのインスタンスや ITelemetry.TrackXXXX() の引数で同じ名前のメトリックが指定された場合は、同じ名前の値は、引数、Interfaceの順で優先されます。

GlobalProperties property

Summary

[en] The property that holds the properties to be sent by default. Since this property is shared globally, you need to lock the GlobalSyncObject when manipulating or referencing this property.

[ja] 既定で送信するプロパティを保持するプロパティ。 このプロパティはグローバルで共有されるため、このプロパティを操作・参照するときは、GlobalSyncObject でLockする必要があります。

Remarks

[en] The properties held by this property will be sent by all ITelemetry.TrackXXXX(), regardless of the Interface instance. If a property with the same name is specified in an instance of Interface or in an argument of ITelemetry.TrackXXXX(), the value with the same name will take precedence over the value in the order of argument and Interface

[ja] このプロパティが保持するプロパティはInterfaceのインスタンスによらず、すべての ITelemetry.TrackXXXX() で送信されます。 Interfaceのインスタンスや ITelemetry.TrackXXXX() の引数で同じ名前のプロパティが指定された場合は、同じ名前の値は、引数、Interfaceの順で優先されます。

GlobalSyncObject property

Summary

[en] LockObject to use when manipulating and referencing GlobalProperties / GlobalMetrics / GlobalExceptionProperties / GlobalExceptionMetrics. GlobalProperties / GlobalMetrics / GlobalExceptionProperties / GlobalExceptionMetrics are shared globally, so we don't know which thread is using them. Therefore, we can use this object to Lock and then manipulate and reference it.

[ja] GlobalProperties / GlobalMetrics / GlobalExceptionProperties / GlobalExceptionMetrics を操作・参照するときに使用するLockObject。 GlobalProperties / GlobalMetrics / GlobalExceptionProperties / GlobalExceptionMetrics は、グローバルで共有されるため、どのスレッドで使用されているかわかりません。 そのため、このオブジェクトを使ってLockしてから、操作・参照します。

Metrics property

Summary

[en] The property that holds the metrics that an instance of this interface sends by default.

[ja] このインターフェースのインスタンスが既定で送信するメトリックを保持するプロパティ。

Remarks

[en] The metrics held by this property will be sent in all ITelemetry.TrackXXXX() issued by instances of this Interface. If a metric with the same name is specified in the argument of ITelemetry.TrackXXXX(), the value of the argument will take precedence over the value of the same name

[ja] このプロパティが保持するメトリックはこのInterfaceのインスタンスから発行するすべての ITelemetry.TrackXXXX() で送信されます。 ITelemetry.TrackXXXX() の引数で同じ名前のメトリックが指定された場合は、同じ名前の値は、引数の値が優先されます。

Properties property

Summary

[en] The property that holds the properties that an instance of this interface sends by default.

[ja] このインターフェースのインスタンスが既定で送信するプロパティを保持するプロパティ。

Remarks

[en] The properties held by this property will be sent in all ITelemetry.TrackXXXX() issued by instances of this Interface. If a property with the same name is specified in the argument of ITelemetry.TrackXXXX(), the value of the argument will take precedence over the value of the same name

[ja] このプロパティが保持するプロパティはこのInterfaceのインスタンスから発行するすべての ITelemetry.TrackXXXX() で送信されます。 ITelemetry.TrackXXXX() の引数で同じ名前のプロパティが指定された場合は、同じ名前の値は、引数の値が優先されます。

Flush() method

Summary

[en] Flushes the unsent telemetry data in the in-memory buffer. This method is an asynchronous function, so if you want to ensure data protection (sending or saving files) when the application is closed, wait a little while after the call before closing the application.

[ja] メモリ内バッファにある未送信のTelemetryデータを送信をフラッシュする このメソッドは非同期関数なので、アプリの終了時に確実にデータ保護(送信またはファイル保存)をしたい場合は、呼び出し後、少し待ってから、アプリを終了すること。

Parameters

This method has no parameters.

TrackEvent(eventName,prop1key,prop1value,prop2key,prop2value,prop3key,prop3value) method

Summary

[en] Send information about the custom event (such as usage of features and commands) in the application. For ApplicationInsight, send an EventTelemetry for display in Diagnostic Search and in the Analytics Portal.

[ja] アプリのカスタムイベント(機能やコマンドの利用状況など)についての情報を送信する。 ApplicationInsightにおいては、解析ポータルや診断検索で表示する EventTelemetry を送信します。

Parameters
Name Type Description
eventName System.String [en] A name for the event.[ja]イベントの名前。
prop1key System.String [en] Key name of string property value #1.[ja] 文字列プロパティ値1のキー名。
prop1value System.String [en] String property value #1.[ja] 文字列プロパティ値1。
prop2key System.String [en] Key name of string property value #2.[ja] 文字列プロパティ値2のキー名。
prop2value System.String [en] String property value #2.[ja] 文字列プロパティ値2。
prop3key System.String [en] Key name of string property value #3.[ja] 文字列プロパティ値3のキー名。
prop3value System.String [en] String property value #3.[ja] 文字列プロパティ値3。
Remarks

[en]To send more than four string properties, use TrackEvent instead of this method.

[ja] 4個以上の文字列プロパティを送信する場合は、このメソッドの代わりに TrackEvent を使用します。

TrackEvent(eventName,metric1key,metric1value,prop1key,prop1value,prop2key,prop2value,prop3key,prop3value) method

Summary

[en] Send information about the custom event (such as usage of features and commands) in the application. For ApplicationInsight, send an EventTelemetry for display in Diagnostic Search and in the Analytics Portal.

[ja] アプリのカスタムイベント(機能やコマンドの利用状況など)についての情報を送信する。 ApplicationInsightにおいては、解析ポータルや診断検索で表示する EventTelemetry を送信します。

Parameters
Name Type Description
eventName System.String [en] A name for the event. [ja]イベントの名前。
metric1key System.String [en] Key name of measurement value #1. [ja] 計測値1のキー名。
metric1value System.Double [en] Measurement value #1. [ja] 計測値1。
prop1key System.String [en] Key name of string property value #1. [ja] 文字列プロパティ値1のキー名。
prop1value System.String [en] String property value #1. [ja] 文字列プロパティ値1。
prop2key System.String [en] Key name of string property value #2. [ja] 文字列プロパティ値2のキー名。
prop2value System.String [en] String property value #2. [ja] 文字列プロパティ値2。
prop3key System.String [en] Key name of string property value #3. [ja] 文字列プロパティ値3のキー名。
prop3value System.String [en] String property value #3. [ja] 文字列プロパティ値3。
Remarks

[en]To more than two metrics or send more than four string properties, use TrackEvent instead of this method.

[ja] 2個以上のメトリック、または、4個以上の文字列プロパティを送信する場合は、このメソッドの代わりに TrackEvent を使用します。

TrackEvent(eventName,triggerType,prop1key,prop1value,prop2key,prop2value,prop3key,prop3value) method

Summary

[en] Send information about the custom event (such as usage of features and commands) in the application. For ApplicationInsight, send an EventTelemetry for display in Diagnostic Search and in the Analytics Portal.

[ja] アプリのカスタムイベント(機能やコマンドの利用状況など)についての情報を送信する。 ApplicationInsightにおいては、解析ポータルや診断検索で表示する EventTelemetry を送信します。

Parameters
Name Type Description
eventName System.String [en] A name for the event. [ja]イベントの名前。
triggerType NishySoftware.Telemetry.TriggerType [en] Trigger type for the event. [ja]イベントのトリガーの種類。
prop1key System.String [en] Key name of string property value #1. [ja] 文字列プロパティ値1のキー名。
prop1value System.String [en] String property value #1. [ja] 文字列プロパティ値1。
prop2key System.String [en] Key name of string property value #2. [ja] 文字列プロパティ値2のキー名。
prop2value System.String [en] String property value #2. [ja] 文字列プロパティ値2。
prop3key System.String [en] Key name of string property value #3. [ja] 文字列プロパティ値3のキー名。
prop3value System.String [en] String property value #3. [ja] 文字列プロパティ値3。
Remarks

[en]To send more than four string properties, use TrackEvent instead of this method.

[ja] 4個以上の文字列プロパティを送信する場合は、このメソッドの代わりに TrackEvent を使用します。

TrackEvent(eventName,triggerType,metric1key,metric1value,prop1key,prop1value,prop2key,prop2value,prop3key,prop3value) method

Summary

[en] Send information about the custom event (such as usage of features and commands) in the application. For ApplicationInsight, send an EventTelemetry for display in Diagnostic Search and in the Analytics Portal.

[ja] アプリのカスタムイベント(機能やコマンドの利用状況など)についての情報を送信する。 ApplicationInsightにおいては、解析ポータルや診断検索で表示する EventTelemetry を送信します。

Parameters
Name Type Description
eventName System.String [en] A name for the event. [ja]イベントの名前。
triggerType NishySoftware.Telemetry.TriggerType [en] Trigger type for the event. [ja]イベントのトリガーの種類。
metric1key System.String [en] Key name of measurement value #1. [ja] 計測値1のキー名。
metric1value System.Double [en] Measurement value #1. [ja] 計測値1。
prop1key System.String [en] Key name of string property value #1. [ja] 文字列プロパティ値1のキー名。
prop1value System.String [en] String property value #1. [ja] 文字列プロパティ値1。
prop2key System.String [en] Key name of string property value #2. [ja] 文字列プロパティ値2のキー名。
prop2value System.String [en] String property value #2. [ja] 文字列プロパティ値2。
prop3key System.String [en] Key name of string property value #3. [ja] 文字列プロパティ値3のキー名。
prop3value System.String [en] String property value #3. [ja] 文字列プロパティ値3。
Remarks

[en]To more than two metrics or send more than four string properties, use TrackEvent instead of this method.

[ja] 2個以上のメトリック、または、4個以上の文字列プロパティを送信する場合は、このメソッドの代わりに TrackEvent を使用します。

TrackEvent(eventName,properties,metrics) method

Summary

[en] Send information about the custom event (such as usage of features and commands) in the application. For ApplicationInsight, send an EventTelemetry for display in Diagnostic Search and in the Analytics Portal.

[ja] アプリのカスタムイベント(機能やコマンドの利用状況など)についての情報を送信する。 ApplicationInsightにおいては、解析ポータルや診断検索で表示する EventTelemetry を送信します。

Parameters
Name Type Description
eventName System.String [en] A name for the event. [ja]イベントの名前。
properties System.Collections.Generic.IDictionary{System.String,System.String} [en] Named string values you can use to search and classify events. [ja] イベントの検索や分類に使用できる名前付きの文字列値。
metrics System.Collections.Generic.IDictionary{System.String,System.Double} [en] Named measurements associated with this event. [ja] このイベントに関連する名前付きの測定値。

TrackEvent(eventName,triggerType,properties,metrics) method

Summary

[en] Send information about the custom event (such as usage of features and commands) in the application. For ApplicationInsight, send an EventTelemetry for display in Diagnostic Search and in the Analytics Portal.

[ja] アプリのカスタムイベント(機能やコマンドの利用状況など)についての情報を送信する。 ApplicationInsightにおいては、解析ポータルや診断検索で表示する EventTelemetry を送信します。

Parameters
Name Type Description
eventName System.String [en] A name for the event. [ja]イベントの名前。
triggerType NishySoftware.Telemetry.TriggerType [en] Trigger type for the event. [ja]イベントのトリガーの種類。
properties System.Collections.Generic.IDictionary{System.String,System.String} [en] Named string values you can use to search and classify events. [ja] イベントの検索や分類に使用できる名前付きの文字列値。
metrics System.Collections.Generic.IDictionary{System.String,System.Double} [en] Named measurements associated with this event. [ja] このイベントに関連する名前付きの測定値。

TrackException(exception,level,prop1key,prop1value,prop2key,prop2value,prop3key,prop3value) method

Summary

[en] Send information about the exception event in the application. For ApplicationInsight, send a separate ExceptionTelemetry for display in Diagnostic Search for each call to this method.

[ja] アプリのExceptionイベントについての情報を送信する。 ApplicationInsightにおいては、診断検索で表示するための ExceptionTelemetry をこのメソッドの呼び出しごとに個別に送信します。

Parameters
Name Type Description
exception System.Exception [en] The exception to log. [ja] 記録するException
level NishySoftware.Telemetry.SeverityLevel [en] Severity level. [ja] 深刻度
prop1key System.String [en] Key name of string property value #1. [ja] 文字列プロパティ値1のキー名。
prop1value System.String [en] String property value #1. [ja] 文字列プロパティ値1。
prop2key System.String [en] Key name of string property value #2. [ja] 文字列プロパティ値2のキー名。
prop2value System.String [en] String property value #2. [ja] 文字列プロパティ値2。
prop3key System.String [en] Key name of string property value #3. [ja] 文字列プロパティ値3のキー名。
prop3value System.String [en] String property value #3. [ja] 文字列プロパティ値3。
Remarks

[en]To send more than four string properties, use TrackException instead of this method.

[ja] 4個以上の文字列プロパティを送信する場合は、このメソッドの代わりに TrackException を使用します。

TrackException(exception,level,properties,metrics) method

Summary

[en] Send information about the exception event in the application. For ApplicationInsight, send a separate ExceptionTelemetry for display in Diagnostic Search for each call to this method.

[ja] アプリのExceptionイベントについての情報を送信する。 ApplicationInsightにおいては、診断検索で表示するための ExceptionTelemetry をこのメソッドの呼び出しごとに個別に送信します。

Parameters
Name Type Description
exception System.Exception [en] The exception to log. [ja] 記録するException
level NishySoftware.Telemetry.SeverityLevel [en] Severity level. [ja] 深刻度
properties System.Collections.Generic.IDictionary{System.String,System.String} [en] Named string values you can use to search and classify events. [ja] イベントの検索や分類に使用できる名前付きの文字列値。
metrics System.Collections.Generic.IDictionary{System.String,System.Double} [en] Named measurements associated with this event. [ja] このイベントに関連する名前付きの測定値。

TrackPageView(pageName,properties,metrics) method

Summary

[en] Send information about the pages, windows, and dialogs displayed by the app. For ApplicationInsight, send a separate PageViewTelemetry for each call to this method.

[ja] アプリで表示されたページ、ウィンドウ、ダイアログについての情報を送信する。 ApplicationInsightにおいては、PageViewTelemetry をこのメソッドの呼び出しごとに個別に送信します。

Parameters
Name Type Description
pageName System.String [en] A name for the page. [ja]ページの名前。
properties System.Collections.Generic.IDictionary{System.String,System.String} [en] Named string values you can use to search and classify events. [ja] イベントの検索や分類に使用できる名前付きの文字列値。
metrics System.Collections.Generic.IDictionary{System.String,System.Double} [en] Named measurements associated with this event. [ja] このイベントに関連する名前付きの測定値。

TrackPageView(pageName,duration,properties,metrics) method

Summary

[en] Send information about the pages, windows, and dialogs displayed by the app. For ApplicationInsight, send a separate PageViewTelemetry for each call to this method.

[ja] アプリで表示されたページ、ウィンドウ、ダイアログについての情報を送信する。 ApplicationInsightにおいては、PageViewTelemetry をこのメソッドの呼び出しごとに個別に送信します。

Parameters
Name Type Description
pageName System.String [en] A name for the page. [ja]ページの名前。
duration System.TimeSpan [en] Page view duration. [ja] ページ閲覧時間。
properties System.Collections.Generic.IDictionary{System.String,System.String} [en] Named string values you can use to search and classify events. [ja] イベントの検索や分類に使用できる名前付きの文字列値。
metrics System.Collections.Generic.IDictionary{System.String,System.Double} [en] Named measurements associated with this event. [ja] このイベントに関連する名前付きの測定値。

TrackPageView(pageName,duration,metric1key,metric1value,prop1key,prop1value,prop2key,prop2value,prop3key,prop3value) method

Summary

[en] Send information about the pages, windows, and dialogs displayed by the app. For ApplicationInsight, send a separate PageViewTelemetry for each call to this method.

[ja] アプリで表示されたページ、ウィンドウ、ダイアログについての情報を送信する。 ApplicationInsightにおいては、PageViewTelemetry をこのメソッドの呼び出しごとに個別に送信します。

Parameters
Name Type Description
pageName System.String [en] A name for the page. [ja]ページの名前。
duration System.TimeSpan [en] Page view duration. [ja] ページ閲覧時間。
metric1key System.String [en] Key name of measurement value #1. [ja] 計測値1のキー名。
metric1value System.Double [en] Measurement value #1. [ja] 計測値1。
prop1key System.String [en] Key name of string property value #1. [ja] 文字列プロパティ値1のキー名。
prop1value System.String [en] String property value #1. [ja] 文字列プロパティ値1。
prop2key System.String [en] Key name of string property value #2. [ja] 文字列プロパティ値2のキー名。
prop2value System.String [en] String property value #2. [ja] 文字列プロパティ値2。
prop3key System.String [en] Key name of string property value #3. [ja] 文字列プロパティ値3のキー名。
prop3value System.String [en] String property value #3. [ja] 文字列プロパティ値3。
Remarks

[en]To more than two metrics or send more than four string properties, use TrackPageView instead of this method.

[ja] 2個以上のメトリック、または、4個以上の文字列プロパティを送信する場合は、このメソッドの代わりに TrackPageView を使用します。

ITelemetryContract type

Namespace

NishySoftware.Telemetry

GlobalExceptionMetrics property

Summary

Inherit from parent.

GlobalExceptionProperties property

Summary

Inherit from parent.

GlobalMetrics property

Summary

Inherit from parent.

GlobalProperties property

Summary

Inherit from parent.

GlobalSyncObject property

Summary

Inherit from parent.

Metrics property

Summary

Inherit from parent.

Properties property

Summary

Inherit from parent.

Flush() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackEvent() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackEvent() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackEvent() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackEvent() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackEvent() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackEvent() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackException() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackException() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackPageView() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackPageView() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

TrackPageView() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

SeverityLevel type

Namespace

NishySoftware.Telemetry

Summary

[en] Enumeration values used by ExceptionTelemetry (TrackException) and TraceTelemetry to identify severity levels

[ja] ExceptionTelemetry (TrackException) および TraceTelemetry が重大度レベルを識別するために使用する列挙値

Critical constants

Summary

[en] Critical severity level

[ja] 致命的な重要度

Error constants

Summary

[en] Error severity level

[ja] エラーの重要度

Information constants

Summary

[en] Information severity level

[ja] 情報の重要度

Verbose constants

Summary

[en] Verbose severity level

[ja] 冗長の重要度

Warning constants

Summary

[en] Warning severity level

[ja] 警告の重要度

TelemetryDataKinds type

Namespace

NishySoftware.Telemetry

Summary

[en] Flags to specify the Telemetry Data to be applied globally.

[ja] 全体に適用するTelemetry Dataを指定するためのフラグ

All constants

Summary

[en] Add all common global properties to GlobalProperties

[ja] すべての共通グローバルプロパティをGlobalPropertiesに追加します

Default constants

Summary

[en] Add default common global properties to GlobalProperties

[ja] 既定の共通グローバルプロパティをGlobalPropertiesに追加します

DeviceManufacturer constants

Summary

[en] Add Manufacture to GlobalProperties

[ja] Manufacture をGlobalPropertiesに追加します

DeviceName constants

Summary

[en] Add DeviceName to GlobalProperties

[ja] DeviceName をGlobalPropertiesに追加します

ExeName constants

Summary

[en] Add ExeName to GlobalProperties

[ja] ExeName をGlobalPropertiesに追加します

HostName constants

Summary

[en] Add HostName to GlobalProperties

[ja] HostName をGlobalPropertiesに追加します

Language constants

Summary

[en] Add Language to GlobalProperties

[ja] Language をGlobalPropertiesに追加します

NetworkSpeed constants

Summary

[en] Add NetworkType to GlobalProperties

[ja] NetworkType をGlobalMetricsに追加します

NetworkType constants

Summary

[en] Add NetworkType to GlobalProperties

[ja] NetworkType をGlobalPropertiesに追加します

ScreenResolution constants

Summary

[en] Add ScreenResolution to GlobalProperties

[ja] ScreenResolution をGlobalPropertiesに追加します

UserName constants

Summary

[en] Add UserName to GlobalProperties

[ja] UserName をGlobalPropertiesに追加します

TriggerType type

Namespace

NishySoftware.Telemetry

Summary

[en] TriggerType

[ja] TriggerType

Click constants

Summary

click operation on mouse

ContextMenu constants

Summary

context menu operation

Flick constants

Summary

flick operation on touch panel

Key constants

Summary

key operation

None constants

Summary

None

Other constants

Summary

other operation

Tap constants

Summary

tap operation on touch panel