Перейти к основному содержимому

ProfilerMarkers

Маркеры профилировщика одной строкой, без полей и имён, которые приходится поддерживать вручную.

Быстрый старт​

До — Unity APIПосле — FastTools
private static readonly
ProfilerMarker _marker =
new("FlockSimulation.Step");

public void Step()
{
using var _ = _marker.Auto();
Integrate();
}
public void Step()
{
using var _ = this.Marker();
Integrate();
}

Marker()​

Имя маркера включает тип, имя метода или свойства и номер строки вызова:

Где вызван this.Marker()Имя маркера
void Step()FlockSimulation.Step (строка)
FlockSimulation()FlockSimulation.Ctor (строка)
float Speed { get; }FlockSimulation.Speed (строка)
Agent this[int i] { get; }FlockSimulation.Indexer (строка)
event Action ChangedFlockSimulation.Changed (строка)
Явная реализация void ISimulation.Step()FlockSimulation.Step (строка)

Номер строки меняется при перемещении вызова в коде.

Вложенные и обобщённые типы
Место вызоваИмя маркера
Метод Move() во вложенном FlockSimulation.AgentAgent.Move (строка)
Step() в классе FlockSimulation<Int32>FlockSimulation<Int32>.Step (строка)
Step() в структуре FlockSimulation<T>FlockSimulation<T>.Step (строка) для любого T
Обобщённый метод Step<T>()FlockSimulation.Step (строка) для любого T

WithName()​

WithName("Steering") заменяет имя метода, сохраняя тип и номер строки.

public void Step()
{
using var _ = this.Marker();

using (this.Marker().WithName("Steering"))
{
foreach (var agent in _agents)
{
using (this.Marker().WithName("Steering.Agent"))
ComputeSteering(agent);
}
}

using (this.Marker().WithName("Integrate"))
Integrate();
}

Имя должно быть константой: строковым литералом, const, nameof или строкой, собранной из них. Имя, известное только во время выполнения, оставляет имя метода.

В Profiler​

Маркеры создаются один раз. После инициализации повторные замеры не выделяют память. В сборке плеера без Development Build this.Marker() ничего не замеряет: символ ENABLE_PROFILER не определён.

HierarchyFrame 1284

Маркеры пакета​

Пакет ставит маркеры и на свои горячие пути, например на первое обращение к EnumValues, которое строит записи, или на разрешение типа в SerializableType. Поиск в уже построенном EnumValues маркер не открывает. Чтобы вырезать эти маркеры, добавьте символ ASPID_FASTTOOLS_UNITY_PROFILER_DISABLED в Scripting Define Symbols. Маркеры от ваших вызовов this.Marker() остаются.

Ограничения​

  • Вызывайте this.Marker() внутри собственного типа. Вызовы на объекте другого типа, в статическом классе или вложенном private/protected типе ненадёжны: замер может отсутствовать или попасть в чужой маркер.
  • Marker() объявлен без пространства имён, поэтому using не нужен, а автодополнение предлагает его у любого выражения, даже если вызов не получит маркер.
  • Используйте using. Отдельный вызов this.Marker(); начинает замер и не завершает его.
  • Закрывайте using до yield return или await. Корутина или async-метод продолжают работу в другом кадре или потоке, поэтому незакрытый замер оставляет в Profiler несбалансированные сэмплы.
внимание

Вызовы внутри одного типа с одинаковым номером строки делят один маркер, даже если находятся в разных файлах partial. Давайте каждой точке замера свой номер строки, иначе замеры объединятся под именем первого вызова.

Пример в пакете​

Маркеры из WithName() работают в сцене ProfilerMarkers.

Стая агентов в сцене ProfilerMarkersСтая агентов в сцене ProfilerMarkers