Activity Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет операцию с контекстом, который необходимо использовать для записи в журнал.
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
имя операции, идентификатор, время начала и длительность, теги и багаж.
Доступ к текущему действию можно получить с помощью статического Activity.Current свойства .
Действия должны создаваться путем вызова конструктора, при необходимости настроенного, а затем запускаемого с Start помощью метода , который поддерживает связи "родители-потомки" для действий и задает .Activity.Current
После завершения действия оно должно быть остановлено с помощью Activity.Stop() метода .
Однако при удалении Activity
объекта он останавливается, поэтому не нужно явно вызывать Activity.Stop(). Это упрощает шаблон кода. Дополнительные сведения см. в описании метода Dispose.
Никакие методы не Activity
позволяют исключениям экранироваться в ответ на неправильные входные данные. Они создаются и перехватываются (что позволяет отладчикам и мониторам видеть ошибку), но исключение подавляется, и операция выполняет что-то разумное (обычно ничего не делает).
Конструкторы
Activity(String) |
Инициализирует новый экземпляр класса Activity. |
Свойства
ActivityTraceFlags |
Получает или задает флаги (определенные в спецификации идентификаторов консорциума W3C), которые связаны с действием. |
Baggage |
Получает коллекцию пар "ключ-значение", которая представляет сведения, передаваемые дочерним элементам этого класса Activity. |
Context |
Получает контекст действия. Контекст станет допустимым, только если было запущено действие. |
Current |
Получает или задает текущую операцию (Activity) для текущего потока. Действует во всех асинхронных вызовах. |
DefaultIdFormat |
Возвращает или задает формат идентификатора по умолчанию для Activity. |
DisplayName |
Получает или задает отображаемое имя действия. |
Duration |
Получает значение длительности операции. |
Events |
Получает список всех событий действий, связанных с этим действием. |
ForceDefaultIdFormat |
Получает или задает значение, указывающее, должен ли объект DefaultIdFormat использоваться всегда для определения формата идентификатора по умолчанию. |
HasRemoteParent |
Возвращает значение, указывающее, был ли родительский контекст создан в результате удаленного распространения. |
Id |
Получает идентификатор, относящийся к конкретному запросу. |
IdFormat |
Возвращает формат Id. |
IsAllDataRequested |
Получает или задает значение, указывающее должно ли это действие быть заполнено всеми сведениями о распространении, а также всеми другими свойствами, такими как ссылки, теги и события. |
IsStopped |
Возвращает значение, указывающее, остановлен ли этот Activity объект. |
Kind |
Получает связь между действием, а также его родительскими и дочерними элементами в трассировке. |
Links |
Получает список всех ссылок на действие, связанных с этим действием. |
OperationName |
Получает имя операции. |
Parent |
Получает родительский класс Activity, создавший это действие. |
ParentId |
Получает идентификатор родительского элемента действия. |
ParentSpanId |
Возвращает идентификатор SpanId родительского объекта. |
Recorded |
Возвращает значение, указывающее, установлен ли флаг W3CIdFlags.Recorded. |
RootId |
Получает корневой идентификатор этого класса Activity. |
Source |
Получает источник действия, связанный с этим действием. |
SpanId |
Возвращает часть SPAN идентификатора Id. |
StartTimeUtc |
Получает значение времени запуска операции. |
Status |
Возвращает код состояния текущего объекта действия. |
StatusDescription |
Возвращает описание состояния текущего объекта действия. |
TagObjects |
Получает список тегов, представляющих сведения для записи в журнал вместе с действием. Эти сведения не передаются дочерним элементам этого действия. |
Tags |
Получает коллекцию пар "ключ-значение", представляющих сведения, которые будут регистрироваться вместе с классом Activity в системе ведения журналов. |
TraceId |
Возвращает часть TraceId идентификатора Id. |
TraceIdGenerator |
При запуске действия, которое не имеет родительского контекста, идентификатор трассировки будет автоматически создан с использованием случайных чисел. TraceIdGenerator можно использовать для переопределения стандартного алгоритма создания идентификаторов трассировки среды выполнения. |
TraceStateString |
Получает или задает W3C-заголовок |
Методы
AddBaggage(String, String) |
Обновляет класс Activity так, чтобы он содержал новый элемент коллекции с указанным ключом и значением. |
AddEvent(ActivityEvent) |
Добавляет указанное событие действия в список событий. |
AddException(Exception, TagList, DateTimeOffset) |
Представляет операцию с контекстом, который необходимо использовать для записи в журнал. |
AddLink(ActivityLink) |
Представляет операцию с контекстом, который необходимо использовать для записи в журнал. |
AddTag(String, Object) |
Обновляет действие, чтобы получить тег с дополнительными |
AddTag(String, String) |
Обновляет класс Activity так, чтобы он содержал новый тег с указанными |
Dispose() |
Останавливает действие, если оно уже запущено, и уведомляет прослушиватели событий. Иначе ничего не произойдет. |
Dispose(Boolean) |
При переопределении производным типом этот метод освобождает все выделенные ресурсы. |
EnumerateEvents() |
Перечисляет объекты, ActivityEvent присоединенные к этому объекту Activity. |
EnumerateLinks() |
Перечисляет объекты, ActivityLink присоединенные к этому объекту Activity. |
EnumerateTagObjects() |
Перечисляет теги, присоединенные к этому объекту Activity. |
Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
GetBaggageItem(String) |
Возвращает значение пары "ключ-значение", добавляемое в действие с помощью метода AddBaggage(String, String). |
GetCustomProperty(String) |
Возвращает объект , сопоставленный с указанным именем свойства. |
GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
GetTagItem(String) |
Возвращает значение тега Activity, сопоставленного с ключом ввода.
Возвращает значение |
GetType() |
Возвращает объект Type для текущего экземпляра. (Унаследовано от Object) |
MemberwiseClone() |
Создает неполную копию текущего объекта Object. (Унаследовано от Object) |
SetBaggage(String, String) |
Добавьте или обновите багаж активности с помощью входного ключа и значения.
Если входное значение равно |
SetCustomProperty(String, Object) |
Связывает любой пользовательский объект с этим действием. Если указанное имя |
SetEndTime(DateTime) |
Обновляет класс Activity, чтобы задать его свойство Duration в виде разницы между значением свойства StartTimeUtc и заданным временем остановки. |
SetIdFormat(ActivityIdFormat) |
Задает формат идентификатора для этого Activity перед запуском. |
SetParentId(ActivityTraceId, ActivitySpanId, ActivityTraceFlags) |
Задает родительский идентификатор, используя соглашение W3C для TraceId и SpanId. |
SetParentId(String) |
Обновляет класс Activity, чтобы указать, что этот класс Activity был создан из класса Activity с идентификатором |
SetStartTime(DateTime) |
Задает время запуска данного класса Activity. |
SetStatus(ActivityStatusCode, String) |
Задает код состояния и описание для текущего объекта действия. |
SetTag(String, Object) |
Добавляет или обновляет тег действия с помощью входного ключа и значения. |
Start() |
Запускает действие. |
Stop() |
Останавливает действие. |
ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
События
CurrentChanged |
Происходит при изменении значения свойства Current. |