Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    View page history    Add new chapter    Reorder page    Raw


統計情報の有効化

Enable statistics

デフォルトでは、PlantUMLは統計情報を生成しません。統計情報の生成を有効化したい場合、次のいずれかを使用してください:
  • コマンドライン-enablestatsフラグ
  • Antタスクenablestats="true"設定
  • 環境変数のPLANTUML_STATStrueに設定
  • JavaコードからOptionFlags.getInstance().setEnableStats(true)を呼ぶ
統計情報は非常に一般的なものです。その目的は、ユーザを覗き見ることではなく、PlantUMLの利用方法とパフォーマンスを計測することです。 統計情報の生成が有効化されている場合、このことを知らせるメッセージがライセンス情報と共に出力されます。 (@startuml/license/@enduml).
By default, statistics generation is disabled in PlantUML. If you want to enable statistic generation, you can either:
  • Use -enablestats flag in the command line
  • Use enablestats="true" setting with the ANT task
  • Globally set the environment variable PLANTUML_STATS to true
  • Call OptionFlags.getInstance().setEnableStats(true) from your Java code
Thoses statistics are very general. The goal is to measure PlantUML usage and performance and not to spy on users. When statistics generation is on, a message is printed within the license to inform users about this. (@startuml/license/@enduml).

統計情報レポート

Statistics Report

PlantUMLの使用状況に関する統計情報をXMLまたはHTML形式で生成することができます。

この機能は、コマンドライン-xmlstatsまたは-htmlstatsフラグを追加することで有効化されます。 処理完了時にplantuml-stats.xmlまたはplantuml-stats.htmlというファイルに出力されます:

処理完了時ではなくリアルタイムに統計情報を生成したい場合は、-realtimestatsフラグを使用します。

-loopstatsフラグを使用すると、ダイアグラムの生成中の統計情報をコンソールに出力し続けることができます。 これは、PlantUMLをバックグラウンドで実行するデーモンがある場合に便利かもしれません。

これらのオプションにはAntタスクで利用可能なものもあります。
You can generate statistics about your PlantUML usage either at XML or HTML format.

To do so, you can add -xmlstats or -htmlstats flag in the command line. A file plantuml-stats.xml or plantuml-stats.html will be written at the end of the process:

If you want to generate statistics on the fly (rather than at the end of the process), you can use the flag -realtimestats.

There is also a -loopstats flag in the command line that continuously prints to the console statistics about diagram generations. This could be useful if you have some background daemon running PlantUML.

Some of those options are also available with the ANT task.

Java統合API

Java Integration API

PlantUMLをライブラリとして利用する場合、StatsUtils.getStats()メソッドを呼ぶと、すべてのデータを含むStatsオブジェクトを返します。

それを取り出して自由に利用することができます。

この このAPIの簡単なクラス図です:

@startuml
class StatsUtil {
{static} +Stats getStats()
}
interface Stats {
+StatsTable getLastSessions()
+StatsTable getCurrentSessionByDiagramType()
+StatsTable getCurrentSessionByFormat()
+StatsTable getAllByDiagramType()
+StatsTable getAllByFormat()
}
StatsUtil -> Stats: build
Stats o--> "5" StatsTable: contains
enum StatsColumn {
SESSION_ID
VERSION
PARSED_COUNT
...
}
interface StatsTable {
+ Collection<StatsColumn> getColumnHeaders()
+ List<StatsLine> getLines()
}
StatsTable o-> StatsColumn: headers
StatsTable *--> StatsLine: contains
interface StatsLine {
}
interface StatsLine {
+Collection<StatsColumn> getColumnHeaders()
+Object getValue(StatsColumn column)
}
StatsLine o--> StatsColumn: headers
@enduml

Implementation note: The storage of historical data are provided through the Preference API.
If you use PlantUML as a library, you can use the StatsUtils.getStats() methods that return a Stats object with all datas.

You can retrieve it to use it as you wish.

Here is a short class diagram about this API:

@startuml
class StatsUtil {
{static} +Stats getStats()
}
interface Stats {
+StatsTable getLastSessions()
+StatsTable getCurrentSessionByDiagramType()
+StatsTable getCurrentSessionByFormat()
+StatsTable getAllByDiagramType()
+StatsTable getAllByFormat()
}
StatsUtil -> Stats: build
Stats o--> "5" StatsTable: contains
enum StatsColumn {
SESSION_ID
VERSION
PARSED_COUNT
...
}
interface StatsTable {
+ Collection<StatsColumn> getColumnHeaders()
+ List<StatsLine> getLines()
}
StatsTable o-> StatsColumn: headers
StatsTable *--> StatsLine: contains
interface StatsLine {
}
interface StatsLine {
+Collection<StatsColumn> getColumnHeaders()
+Object getValue(StatsColumn column)
}
StatsLine o--> StatsColumn: headers
@enduml

Implementation note: The storage of historical data are provided through the Preference API.


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.