Interface ITracerService
Tracing service.
Namespace: MAT.Atlas.Automation.Api
Assembly: MAT.Atlas.Automation.Api.dll
Syntax
[AutomationService("Tracing")]
public interface ITracerService : IAutomationService
Methods
DisableResourceUsageMonitoring()
Disable resource usage monitoring.
Declaration
void DisableResourceUsageMonitoring()
EnableResourceUsageMonitoring(Int32, Int32)
Enable resource usage monitoring.
Declaration
void EnableResourceUsageMonitoring(int sampleRateInMs, int summaryIntervalInMs)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | sampleRateInMs | How often resources are sampled. |
System.Int32 | summaryIntervalInMs | Over how long samples are summerised. |
EnableResourceUsageMonitoringWithDefaults()
Enable resource usage monitoring with default settings.
Declaration
void EnableResourceUsageMonitoringWithDefaults()
GetEventsReport()
Get events report.
Declaration
string GetEventsReport()
Returns
Type | Description |
---|---|
System.String | Events report. |
GetOperationsReport(Int32, Boolean)
Get operations report.
Declaration
string GetOperationsReport(int sortByIndex, bool sortAscending)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | sortByIndex | Sort operations by index. |
System.Boolean | sortAscending | Sort operations ascending. |
Returns
Type | Description |
---|---|
System.String | Operations report. |
GetResourceUsageReport()
Get resource usage report.
Declaration
string GetResourceUsageReport()
Returns
Type | Description |
---|---|
System.String | Resource usage report. |
GetThreadsReport(Boolean, Boolean)
Get threads report.
Declaration
string GetThreadsReport(bool onlyActiveThreads, bool combineAllThreads)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | onlyActiveThreads | Only include active threads. |
System.Boolean | combineAllThreads | Combine all threads into a single report. |
Returns
Type | Description |
---|---|
System.String | Threads report. |
GetTracerSettings()
Get tracing settings.
Declaration
TracerSettings GetTracerSettings()
Returns
Type | Description |
---|---|
TracerSettings | Tracer settings. |
LogEvents()
Log events.
Declaration
void LogEvents()
LogOperations(Int32, Boolean)
Log operations.
Declaration
void LogOperations(int sortByIndex, bool sortAscending)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | sortByIndex | Sort operations by index. |
System.Boolean | sortAscending | Sort operations ascending. |
LogResourceUsage()
Log resource usage.
Declaration
void LogResourceUsage()
LogThreads(Boolean, Boolean)
Log threads.
Declaration
void LogThreads(bool onlyActiveThreads, bool combineAllThreads)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | onlyActiveThreads | Only include active threads. |
System.Boolean | combineAllThreads | Combine all threads into a single report. |
RemoveAllOperations()
Remove all operations.
Declaration
void RemoveAllOperations()
RemoveAllOperationsOfCategory(String)
Remove all operations of a category.
Declaration
void RemoveAllOperationsOfCategory(string categoryName)
Parameters
Type | Name | Description |
---|---|---|
System.String | categoryName | Name of category. |
RemoveOperation(String, String)
Remove an operation of a category.
Declaration
void RemoveOperation(string categoryName, string operationName)
Parameters
Type | Name | Description |
---|---|---|
System.String | categoryName | Name of category. |
System.String | operationName | Name of operation. |
ResetAllOperations()
Reset all operations.
Declaration
void ResetAllOperations()
ResetAllOperationsOfCategory(String)
Reset all operations of a category.
Declaration
void ResetAllOperationsOfCategory(string categoryName)
Parameters
Type | Name | Description |
---|---|---|
System.String | categoryName | Name of category. |
ResetOperation(String, String)
Reset an operation of a category.
Declaration
void ResetOperation(string categoryName, string operationName)
Parameters
Type | Name | Description |
---|---|---|
System.String | categoryName | Name of category. |
System.String | operationName | Name of operation. |
SetCategoryTracingEnabled(String, Boolean)
Enable/disable tracing for a category.
Declaration
void SetCategoryTracingEnabled(string categoryName, bool enabled)
Parameters
Type | Name | Description |
---|---|---|
System.String | categoryName | Name of category. |
System.Boolean | enabled | Whether category tracing is enabled. |
SetTracingEnabled(Boolean)
Enable/disable tracing.
Declaration
void SetTracingEnabled(bool enabled)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | enabled | Whether tracing is enabled. |
Trace(String, String)
Trace message.
Declaration
void Trace(string categoryName, string text)
Parameters
Type | Name | Description |
---|---|---|
System.String | categoryName | Name of category. |
System.String | text | Text. |