search

kieker-monitoring / kieker

Kieker's main repository
Apache License 2.0
70 stars 41 forks source link

[KIEKER-519] Traceanalysis Command Line Help not readable #1087

Open rju opened 2 weeks ago

rju commented 2 weeks ago

JIRA Issue: KIEKER-519 Traceanalysis Command Line Help not readable Original Reporter: Jan Waller

At least with windows, the output looks something like this:

 -i,--inputdirs <dir1 ... dirN>                                       Log
                                                                      directorie
                                                                      s to read
                                                                      data from
 -o,--outputdir <dir>                                                 Directory
                                                                      for the
                                                                      generated
                                                                      file(s)
 -p,--output-filename-prefix <prefix>                                 Prefix for
                                                                      output
                                                                      filenames
    --plot-Deployment-Sequence-Diagrams                               Generate
                                                                      and store
                                                                      deployment
                                                                      -level
                                                                      sequence
                                                                      diagrams
                                                                      (.pic
                                                                      files)
    --plot-Assembly-Sequence-Diagrams                                 Generate
                                                                      and store
                                                                      assembly-l
                                                                      evel
                                                                      sequence
                                                                      diagrams
                                                                      (.pic
                                                                      files)
    --plot-Deployment-Component-Dependency-Graph <node decorations>   Generate
                                                                      and store
                                                                      a
                                                                      deployment
                                                                      -level
                                                                      component
                                                                      dependency
                                                                      graph
                                                                      (.dot
                                                                      file)
    --plot-Assembly-Component-Dependency-Graph <node decorations>     Generate
                                                                      and store
                                                                      an
                                                                      assembly-l
                                                                      evel
                                                                      component
                                                                      dependency
                                                                      graph
                                                                      (.dot

This is quite hard to read and use.

Checklist:

rju commented 2 weeks ago

author Jan Waller -- Wed, 27 Feb 2013 10:39:56 +0100

Something like this would be better (even better with color):

usage: kieker.tools.traceAnalysis.TraceAnalysisTool -i <dir1 ... dirN> -o <dir>
       [-p <prefix>] [--plot-Deployment-Sequence-Diagrams]
       [--plot-Assembly-Sequence-Diagrams]
       [--plot-Deployment-Component-Dependency-Graph <node decorations>]
       [--plot-Assembly-Component-Dependency-Graph <node decorations>]
       [--plot-Container-Dependency-Graph]
       [--plot-Deployment-Operation-Dependency-Graph <node decorations>]
       [--plot-Assembly-Operation-Dependency-Graph <node decorations>]
       [--plot-Aggregated-Deployment-Call-Tree]
       [--plot-Aggregated-Assembly-Call-Tree] [--plot-Call-Trees]
       [--print-Message-Traces] [--print-Execution-Traces]
       [--print-invalid-Execution-Traces]
       [--print-Deployment-Equivalence-Classes]
       [--print-Assembly-Equivalence-Classes] [--select-traces <id0 ... idn>]
       [--ignore-invalid-traces] [--max-trace-duration <duration in ms>]
       [--ignore-executions-before-date <yyyyMMdd-HHmmss>]
       [--ignore-executions-after-date <yyyyMMdd-HHmmss>] [--short-labels]
       [--include-self-loops] [--traceColoring <color map file>]
       [--addDescriptions <descriptions file>]
 -i,--inputdirs <dir1 ... dirN>
        Log directories to read data from
 -o,--outputdir <dir>
        Directory for the generated file(s)
 -p,--output-filename-prefix <prefix>
        Prefix for output filenames
    --plot-Deployment-Sequence-Diagrams
        Generate and store deployment-level sequence diagrams (.pic)
    --plot-Assembly-Sequence-Diagrams
        Generate and store assembly-level sequence diagrams (.pic)
    --plot-Deployment-Component-Dependency-Graph <node decorations>
        Generate and store a deployment-level component dependency graph (.dot)
    --plot-Assembly-Component-Dependency-Graph <node decorations>
        Generate and store an assembly-level component dependency graph (.dot)
    --plot-Container-Dependency-Graph
        Generate and store a container dependency graph (.dot file)
    --plot-Deployment-Operation-Dependency-Graph <node decorations>
        Generate and store a deployment-level operation dependency graph (.dot)
    --plot-Assembly-Operation-Dependency-Graph <node decorations>
        Generate and store an assembly-level operation dependency graph (.dot)
    --plot-Aggregated-Deployment-Call-Tree
        Generate and store an aggregated deployment -level call tree (.dot)
    --plot-Aggregated-Assembly-Call-Tree
        Generate and store an aggregated assembly-l evel call tree (.dot)
    --plot-Call-Trees
        Generate and store call trees for the selected traces (.dot)
    --print-Message-Traces
        Save message trace representations of valid traces (.txt)
    --print-Execution-Traces
        Save execution trace representations of valid traces (.txt)
    --print-invalid-Execution-Traces
        Save execution trace representations of invalid trace artifacts (.txt)
    --print-Deployment-Equivalence-Classes
        Output an overview about the deployment-level trace equivalence classes
    --print-Assembly-Equivalence-Classes
        Output an overview about the assembly-level trace equivalence classes
    --select-traces <id0 ... idn>
        Consider only the traces identified by the list of trace IDs.
        Defaults to all traces.
    --ignore-invalid-traces
        If selected, the execution aborts on the occurence of an invalid trace
    --max-trace-duration <duration in ms>
        Threshold (in ms) after which incomplete traces becomes invalid
        Defaults to 600000 (10 minutes).
    --ignore-executions-before-date <yyyyMMdd-HHmmss>
        Executions starting before this date (UTC timezone) are ignored
    --ignore-executions-after-date <yyyyMMdd-HHmmss>
        Executions ending after this date (UTC timezone) are ignored
    --short-labels
        If selected, abbreviated labels are used in the visualizations
    --include-self-loops
        If selected, self-loops are included in the visualizations
    --traceColoring <color map file>
        Color traces according to the given color map
    --addDescriptions <descriptions file>
        Adds descriptions to elements according to the given file
rju commented 2 weeks ago

author André van Hoorn -- Wed, 6 Mar 2013 15:05:54 +0100

jwa fixed some typos in comment:1; hence: diff after fix

rju commented 2 weeks ago

author André van Hoorn -- Mon, 11 Mar 2013 18:01:07 +0100

Fixed in changeset:6de43fff483502e6b261e3b350dc24a12e00a586/kieker-git by introducing the formatter class CLIHelpFormatter (extending Commons CLI's HelpFormatter and overwriting its renderOptions method).

This formatter is now used by each tool previously using the default HelpFormatter.

Example output for TraceAnalysis:

avhAndrè van Hoorn-ThinkPad-RSS:1:~/git_work/kieker <master> $ bin/trace-analysis.sh 
usage: kieker.tools.traceAnalysis.TraceAnalysisTool -i <dir1 ... dirN> -o <dir>
       [-p <prefix>] [--plot-Deployment-Sequence-Diagrams]
       [--plot-Assembly-Sequence-Diagrams]
       [--plot-Deployment-Component-Dependency-Graph <node decorations>]
       [--plot-Assembly-Component-Dependency-Graph <node decorations>]
       [--plot-Container-Dependency-Graph]
       [--plot-Deployment-Operation-Dependency-Graph <node decorations>]
       [--plot-Assembly-Operation-Dependency-Graph <node decorations>]
       [--plot-Aggregated-Deployment-Call-Tree]
       [--plot-Aggregated-Assembly-Call-Tree] [--plot-Call-Trees]
       [--print-Message-Traces] [--print-Execution-Traces]
       [--print-invalid-Execution-Traces]
       [--print-Deployment-Equivalence-Classes]
       [--print-Assembly-Equivalence-Classes] [--select-traces <id0 ... idn>]
       [--ignore-invalid-traces] [--max-trace-duration <duration in ms>]
       [--ignore-executions-before-date <yyyyMMdd-HHmmss>]
       [--ignore-executions-after-date <yyyyMMdd-HHmmss>] [--short-labels]
       [--include-self-loops] [--traceColoring <color map file>]
       [--addDescriptions <descriptions file>]
 --i,--inputdirs <dir1 ... dirN>
        Log directories to read data from

 --o,--outputdir <dir>
        Directory for the generated file(s)

 --p,--output-filename-prefix <prefix>
        Prefix for output filenames

    --plot-Deployment-Sequence-Diagrams
        Generate and store deployment-level sequence diagrams (.pic)

    --plot-Assembly-Sequence-Diagrams
        Generate and store assembly-level sequence diagrams (.pic)

    --plot-Deployment-Component-Dependency-Graph <node decorations>
        Generate and store a deployment-level component dependency graph (.dot)

    --plot-Assembly-Component-Dependency-Graph <node decorations>
        Generate and store an assembly-level component dependency graph (.dot)

    --plot-Container-Dependency-Graph
        Generate and store a container dependency graph (.dot file)

    --plot-Deployment-Operation-Dependency-Graph <node decorations>
        Generate and store a deployment-level operation dependency graph (.dot)

    --plot-Assembly-Operation-Dependency-Graph <node decorations>
        Generate and store an assembly-level operation dependency graph (.dot)

    --plot-Aggregated-Deployment-Call-Tree
        Generate and store an aggregated deployment-level call tree (.dot)

    --plot-Aggregated-Assembly-Call-Tree
        Generate and store an aggregated assembly-level call tree (.dot)

    --plot-Call-Trees
        Generate and store call trees for the selected traces (.dot)

    --print-Message-Traces
        Save message trace representations of valid traces (.txt)

    --print-Execution-Traces
        Save execution trace representations of valid traces (.txt)

    --print-invalid-Execution-Traces
        Save a execution trace representations of invalid trace artifacts (.txt)

    --print-Deployment-Equivalence-Classes
        Output an overview about the deployment-level trace equivalence classes

    --print-Assembly-Equivalence-Classes
        Output an overview about the assembly-level trace equivalence classes

    --select-traces <id0 ... idn>
        Consider only the traces identified by the list of trace IDs. Defaults
        to all traces.

    --ignore-invalid-traces
        If selected, the execution aborts on the occurence of an invalid trace.

    --max-trace-duration <duration in ms>
        Threshold (in ms) after which incomplete traces become invalid. Defaults
        to 600,000 (i.e, 10 minutes).

    --ignore-executions-before-date <yyyyMMdd-HHmmss>
        Executions starting before this date (UTC timezone) are ignored.

    --ignore-executions-after-date <yyyyMMdd-HHmmss>
        Executions ending after this date (UTC timezone) are ignored.

    --short-labels
        If selected, abbreviated labels (e.g., package names) are used in the
        visualizations.

    --include-self-loops
        If selected, self-loops are included in the visualizations.

    --traceColoring <color map file>
        Color traces according to the given color map.

    --addDescriptions <descriptions file>
        Adds descriptions to elements according to the given file.

Error parsing arguments: Missing required options: i, o