Trendüberwachung

CppDepend bietet leistungsstarke Trendüberwachung Funktionen, mit denen Sie Code-Metriken über die Zeit verfolgen können. Trend-Charts bestehen aus Trendmetriken Werte, die im Laufe der Zeit zur Analysezeit protokolliert werden. Standardmäßig sind mehr als 50 Trendmetriken verfügbar, und es ist einfach, eigene Trendmetriken zu erstellen.

• Einführung
• Trendmetriken
• Trenddiagramme
• Berichts-Trenddiagramme
• Protokollieren von Trendmetriken

Trenddiagramme werden auf dem CppDepend-Dashboard angezeigt. Einige Trenddiagramme sind standardmäßig verfügbar, um Folgendes zu zeigen:

• Codezeilen
• Anzahl verletzter Coderegeln und Anzahl der Regelverstöße
• Maximal- und Durchschnittswerte für verschiedene Codequalitätsmetriken
• Nutzung von Drittanbieter-Tools

Trenddiagramme können angepasst werden, und es ist einfach, eigene Trenddiagramme zu erstellen, um Standard-Trendmetriken und/oder eigene Trendmetriken anzuzeigen.

Für alle trendbezogenen Vorgänge wird Trendmenü ist verfügbar.

Nach oben

Um die Standard-Trendmetriken aufzulisten, sehen Sie sich an: Abfragen- und Regeln-Explorer-Panel und wählen Sie die Gruppe namens Trendmetriken.

Wenn Trendmetriken im Code-Abfragen-Panel gelistet sind, dann deshalb, weil eine Trendmetrik eine CQLinq-Code-Abfrage ist. Es ist eine besondere Code-Abfrage:

• Eine Trendmetrik ist eine Codeabfrage, die einen Skalar zurückgibt. Daher verwenden Trendmetrik-Abfragen oft LINQ-Aggregatoperatoren, die einen Skalar zurückgeben. Dazu gehören Operatoren wie Count() Sum() Average() Min() Max() ...
• Der Header einer Code-Abfrage ist eine auf diese Weise formatierte Kommentarzeile // <TrendMetric Name="Metric Name" Unit="Metric Unit Name" />

Hier ist zum Beispiel # Codezeilen Trendmetrik-Codeabfrage:

Da eine Trendmetrik eine Codeabfrage ist, ist es einfach, eigene Trendmetriken zu erstellen oder vorhandene zu ändern. Hier ist beispielsweise eine Codeabfrage, die die Anzahl der Typen zählt, die erben von Poco.Exception:

Es gibt sechs Standard-Trendmetriken, die keine Codeabfragen sind. Sie beziehen sich auf die Anzahl der verletzten Coderegeln und die Anzahl der Coderegelverletzungen:

Trendmetriken werden zur Analysezeit protokolliert, wie im Abschnitt Protokollieren von Trendmetriken.

Nach oben

Der Dialog Create or Edit trend charts ermöglicht es Ihnen, alle Trenddiagramm-Eigenschaften zu definieren. Die Liste der Trendmetrik-Serien ist verfügbar, und das Aktivieren einer Serie lässt Sie sie im Trenddiagramm visualisieren. Das Erscheinungsbild einer Serie kann angepasst werden, einschließlich:

• Die Farbe der Reihe
• Wenn die Reihe als Linie oder als Fläche dargestellt wird
• Definition der Reihenskala. Die Skaleneinstellung ist nützlich, um mehrere Reihenskalen anzupassen und sie im selben Trend-Chart zu vergleichen.

Nach oben

Im Bild oben sehen wir ein Kontrollkästchen mit der Bezeichnung: Dieses Trenddiagramm im Bericht anzeigen Trend-Charts können in der Tat im Bericht angezeigt werden.

Dafür muss das Kontrollkästchen CppDepend-Projekteigenschaften > Registerkarte Report > Use standard report aktiviert > Trend Charts muss aktiviert sein.

Nach oben

Trendmetrikwerte werden zur Analysezeit protokolliert. Durch tägliche Analysen entsteht eine Reihe von Trendmetrikwerten.

Einstellungen zur Protokollierung von Trendmetrikwerten sind verfügbar, sowohl in CppDepend-Optionen > Trend Abschnitt und im CppDepend-Projekteigenschaften > Analysis > Trend Metrics Log Abschnitt. Wenn Einstellungen in den Projekteigenschaften gesetzt sind, überschreiben sie die globalen Einstellungen in den Optionen.

Die Einstellungen des Trendmetrik-Protokolls umfassen:

• Die Häufigkeit der Protokollierung, etwa höchstens einmal pro Tag oder Woche
• Die Definition eines Labels für jedes Protokoll, das die Version der analysierten Codebasis darstellt. Im Screenshot des Trenddiagramms oben sehen Sie, dass dieses Versionslabel auf den Trenddiagrammen auf der Zeitachse (X-Achse) angezeigt wird.
• Der Ordner, in dem Dateien mit Trendmetrikwerten gespeichert werden. Um zu große Dateien zu vermeiden, wird pro Jahr eine Datei erstellt.

Beachten Sie, dass unabhängig von den Trendmetrik-Log-Einstellungen die Verwendung von CppDepend.Console.exe Befehlszeilenparameter /LogTrendMetrics erzwingt die Protokollierung der Trendmetriken während der Analyse.