Einrichten einer Profilerstellungsumgebung

  • Artikel

Hinweis

Es gab beträchtliche Änderungen an der Profilerstellung in .NET Framework 4.

Wenn ein verwalteter Prozess (Anwendung oder Dienst) gestartet wird, wird die Common Language Runtime (CLR) geladen. Wenn die CLR initialisiert wird, werden die folgenden zwei Umgebungsvariablen ausgewertet, um zu entscheiden, ob der Prozess mit einem Profiler verbunden werden soll:

  • COR_ENABLE_PROFILING: Die CLR stellt nur dann eine Verbindung zu einem Profiler her, wenn diese Umgebungsvariable vorhanden und auf 1 gesetzt ist.

  • COR_PROFILER: Wenn die Prüfung auf die Variable COR_ENABLE_PROFILING erfolgreich abgeschlossen wurde, stellt die CLR eine Verbindung mit dem Profiler mit dieser CLSID oder ProgID her, die zuvor in der Registrierung abgelegt worden sein muss. Die COR_PROFILER-Umgebungsvariable ist als Zeichenfolge definiert, wie in den beiden folgenden Beispielen gezeigt.

    set COR_PROFILER={32E2F4DA-1BEA-47ea-88F9-C5DAF691C94A}  
set COR_PROFILER="MyProfiler"

Zur Profilerstellung für eine CLR-Anwendung müssen die Umgebungsvariablen COR_ENABLE_PROFILING und COR_PROFILER festgelegt werden, bevor Sie die Anwendung ausführen. Außerdem müssen Sie sicherstellen, dass die Profiler-DLL registriert ist.

Hinweis

Ab .NET Framework 4 müssen Profiler nicht registriert werden.

Hinweis

Um Profiler in den .NET Framework-Versionen 2.0, 3.0 und 3.5 in .NET Framework 4 und höheren Versionen verwenden zu können, muss die COMPLUS_ProfAPI_ProfilerCompatibilitySetting-Umgebungsvariable festgelegt werden.

Umgebungsvariablenbereich

Die Werte, die Sie für die Umgebungsvariablen COR_ENABLE_PROFILING und COR_PROFILER festlegen, bestimmen den Einflussbereich dieser Variablen. Sie haben folgende Möglichkeiten, diese Variablen festzulegen:

  • Wenn Sie die Variablen in einem ICorDebug::CreateProcess-Aufruf festlegen, gelten sie nur für die Anwendung, die Sie zu diesem Zeitpunkt ausführen. (Sie gelten auch für andere Anwendungen, die von dieser Anwendung gestartet werden und die die Umgebung erben.)

  • Wenn Sie die Variablen in einer Eingabeaufforderung festlegen, gelten sie für alle Anwendungen, die von diesem Fenster aus gestartet werden.

  • Wenn Sie die Variablen auf Benutzerebene festlegen, gelten sie für alle Anwendungen, die Sie mit Datei-Explorer starten. Eine Eingabeaufforderung, die Sie nach dem Festlegen dieser Variablen öffnen, hat diese Umgebungseinstellungen, ebenso wie jede Anwendung, die Sie aus diesem Fenster starten. Um die Umgebungsvariablen auf Benutzerebene festzulegen, klicken Sie mit der rechten Maustaste auf Arbeitsplatz, klicken dann auf Eigenschaften, klicken dann auf die Registerkarte Erweitert, klicken dann auf die Schaltfläche Umgebungsvariablen und fügen die Variablen der Liste Benutzervariablen hinzu.

  • Wenn Sie die Variablen auf Computerebene festlegen, gelten sie für alle Anwendungen, die auf diesem Computer gestartet werden. Eine Eingabeaufforderung, die Sie auf diesem Computer öffnen, hat diese Umgebungseinstellungen, ebenso wie jede Anwendung, die Sie aus diesem Fenster starten. Dies bedeutet, dass jeder verwaltete Prozess auf diesem Computer mit Ihrem Profiler startet. Um die Umgebungsvariablen auf Computerebene festzulegen, klicken Sie mit der rechten Maustaste auf Arbeitsplatz, klicken dann auf Eigenschaften, klicken dann auf die Registerkarte Erweitert, klicken dann auf die Schaltfläche Umgebungsvariablen, fügen die Variablen der Liste Systemvariablen hinzu und starten anschließend den Computer neu. Nach dem Neustart sind die Variablen systemweit verfügbar.

Wenn Sie ein Profil für einen Windows-Dienst erstellen, müssen Sie nach dem Festlegen der Umgebungsvariablen und dem Registrieren der Profiler-DLL den Computer neu starten. Weitere Informationen zu diesen Überlegungen finden Sie im Abschnitt Profilerstellung für einen Windows-Dienst.

Weitere Überlegungen

  • Die Profilerklasse implementiert die ICorProfilerCallback-Schnittstelle und die ICorProfilerCallback2-Schnittstelle. In .NET Framework, Version 2.0, muss ein Profiler ICorProfilerCallback2 implementieren. Wenn dies nicht geschieht, wird ICorProfilerCallback2 nicht geladen.

  • Nur ein einzelner Profiler kann ein Profil für einen Prozess zu einem gegebenen Zeitpunkt in einer gegebenen Umgebung erstellen. Sie können zwei verschiedene Profiler in anderen Umgebungen registrieren, doch in jedem müssen Profile für gesonderte Prozesse erstellt werden. Der Profiler muss als prozessinterne COM-Server-DLL implementiert werden, die im gleichen Adressbereich wie der Prozess zugeordnet wird, für den ein Profil erstellt wird. Dies bedeutet, dass der Profiler prozessintern ausgeführt wird. .NET Framework unterstützt keinen anderen Typ von COM-Server. Wenn beispielsweise ein Profiler Anwendungen von einem Remotecomputer aus überwachen möchte, muss er Collector-Agents auf jedem Computer implementieren. Diese Agents fassen die Ergebnisse in Stapeln zusammen und melden diese dem zentralen Datenerfassungscomputer.

  • Da der Profiler ein COM-Objekt ist, das prozessintern instanziiert wird, verfügt jede Anwendung mit Profil über eine eigene Kopie des Profilers. Daher muss eine einzelne Profilerinstanz nicht Daten von mehreren Anwendungen behandeln. Sie müssen jedoch eine Logik zum Protokollierungscode des Profilers hinzufügen, um zu verhindern, dass die Protokolldatei durch andere Anwendungen mit Profil überschrieben wird.

Initialisieren des Profilers

Wenn die Prüfung auf beide Umgebungsvariablen erfolgreich ist, erstellt die CLR eine Instanz des Profilers in ähnlicher Weise wie für die COM-CoCreateInstance-Funktion. Der Profiler wird nicht durch einen direkten Aufruf von CoCreateInstance geladen. Deshalb wird ein Aufruf von CoInitialize, der das Festlegen des Threadingmodells erfordert, vermieden. Die CLR ruft dann die ICorProfilerCallback::Initialize-Methode im Profiler auf. Die Signatur dieser Methode wird im Folgenden beschrieben.

HRESULT Initialize(IUnknown *pICorProfilerInfoUnk)

Der Profiler muss pICorProfilerInfoUnk nach einem ICorProfilerInfo-Schnittstellenzeiger oder einem ICorProfilerInfo2-Schnittstellenzeiger abfragen und diesen speichern, sodass er später während der Profilerstellung weitere Informationen abfragen kann.

Festlegen von Ereignisbenachrichtigungen

Der Profiler ruft anschließend die ICorProfilerInfo::SetEventMask-Methode auf, um anzugeben, welche Kategorien von Benachrichtigungen von Interesse sind. Wenn für den Profiler z. B. nur Benachrichtigungen zum Starten und Verlassen von Funktionen und an Garbage Collection-Benachrichtigungen von Belang sind, wird Folgendes angegeben.

ICorProfilerInfo* pInfo;  
pICorProfilerInfoUnk->QueryInterface(IID_ICorProfilerInfo, (void**)&pInfo);  
pInfo->SetEventMask(COR_PRF_MONITOR_ENTERLEAVE | COR_PRF_MONITOR_GC)

Durch das Festlegen der Benachrichtigungsmaske in dieser Weise kann der Profiler die Benachrichtigungen einschränken, die er empfängt. Dieser Ansatz hilft dem Benutzer dabei, einen einfachen oder zweckgebundenen Profiler zu erstellen. Er reduziert auch die CPU-Zeit, die durch das Senden von Benachrichtigungen verschwendet würde, die vom Profiler einfach ignoriert werden.

Bestimmte Profilerereignisse sind unveränderlich. Das bedeutet, dass diese Ereignisse unmittelbar nach ihrem Festlegen im ICorProfilerCallback::Initialize-Rückruf nicht deaktiviert und neue Ereignisse nicht aktiviert werden können. Versuche, ein unveränderliches Ereignis zu ändern, führen dazu, dass ICorProfilerInfo::SetEventMask ein fehlgeschlagenes HRESULT zurückgibt.

Profilerstellung für einen Windows-Dienst

Die Profilerstellung für einen Windows-Dienst ist mit der Profilerstellung für eine Common Language Runtime-Anwendung vergleichbar. Beide Profilerstellungsvorgänge werden durch Umgebungsvariablen aktiviert. Da ein Windows-Dienst gestartet wird, wenn das Betriebssystem gestartet wird, müssen die zuvor in diesem Thema erläuterten Umgebungsvariablen bereits vor dem Systemstart vorhanden und auf die erforderlichen Werte festgelegt sein. Außerdem muss die Profilerstellungs-DLL bereits auf dem System registriert sein.

Nachdem Sie die COR_ENABLE_PROFILING-Umgebungsvariable und die COR_PROFILER-Umgebungsvariable festgelegt und die Profiler-DLL registriert haben, sollten Sie den Zielcomputer neu starten, damit der Windows-Dienst diese Änderungen feststellen kann.

Beachten Sie, dass diese Änderungen die Profilerstellung auf einer systemweiten Basis aktivieren. Um zu verhindern, dass für jede nachfolgend ausgeführte verwaltete Anwendung ein Profil erstellt wird, sollten Sie die Systemumgebungsvariablen nach dem Neustart des Zielcomputers löschen.

Dieses Verfahren führt außerdem dazu, dass für jeden CLR-Prozess ein Profil erstellt wird. Der Profiler sollte seinem ICorProfilerCallback::Initialize-Rückruf Logik hinzufügen, um zu ermitteln, ob der aktuelle Prozess für ihn von Interesse ist. Wenn dies nicht der Fall ist, kann der Profiler den Rückruf mit einem Fehler abschließen, ohne die Initialisierung auszuführen.

Siehe auch