Changes between Version 44 and Version 45 of AnalyzePlugin


Ignore:
Timestamp:
May 10, 2022, 5:47:05 AM (3 months ago)
Author:
figaro
Comment:

Move examples to functional description

Legend:

Unmodified
Added
Removed
Modified
  • AnalyzePlugin

    v44 v45  
    1818[[Image(ask_analyze.png, border=2)]]
    1919
    20 See below for further examples.
    21 
    22 == Bugs/Feature Requests
    23 
    24 Existing bugs and feature requests for AnalyzePlugin are
    25 [report:9?COMPONENT=AnalyzePlugin here].
    26 
    27 If you have any issues, create a
    28 [/newticket?component=AnalyzePlugin new ticket].
    29 
    30 [[TicketQuery(component=AnalyzePlugin&group=type,format=progress)]]
    31 
    32 == Download
    33 
    34 Download the zipped source from [export:analyzeplugin here].
    35 
    36 == Source
    37 
    38 You can check out AnalyzePlugin from [/svn/analyzeplugin here] using Subversion, or [source:analyzeplugin browse the source] with Trac.
    39 
    40 == Installation
    41 
    42  1. Download and unzip the plugin.
    43  2. Install the plugin:
    44  {{{#!sh
    45 cd analyzeplugin/0.12
    46 sudo python setup.py bdist_egg
    47 sudo cp dist/TracAnalyze*.egg /your/trac/location/plugins/
    48 }}}
    49 
    50  See [t:TracPlugins TracPlugins] for more installation details and options. You'll likely need to restart Trac's web server after installation.
    51 
    52  3. Enable the plugin by adding the following to your `trac.ini` file:
    53  {{{#!ini
    54 [components]
    55 analyze.* = enabled
    56 }}}
    57 
    58  You can alternatively use the Trac Web Admin GUI to enable any or all rules.
    59 
    60 == Configuration
    61 
    62 Enable the {{{ANALYZE_VIEW}}} permission for those users who are allowed to execute analyses.
    63 
    64 == Examples
    65 
    66 This plugin currently includes four analyses that can each be individually enabled for one or more reports. Each analysis is configured by modifying the {{{[analyze]}}} section of {{{trac.ini}}}, see below for examples. When an analysis is enabled for a report, an '''Analyze...''' button appears at the top of the report and the analysis' name will appear in the subsequent dialog box when the button is clicked. You can either choose a single analysis or all analyses in this dialog box. Selecting "All" will run them serially.
    67 
    68 '''Important:''' The current analyses do not, for example, detect circular dependencies nor can they handle complex relationships all in one pass. This means that after a pass of fixes, the changes may have caused or exposed other issues that another analysis pass will uncover. So the general usage pattern is to continue re-running analyses until "quiescence" is reached, ie until there are no more issues to fix.
     20=== Examples
     21
     22The four analyses can be individually enabled for one or more reports. Each analysis is configured by modifying the {{{[analyze]}}} section of {{{trac.ini}}}, see below for examples. When an analysis is enabled for a report, an '''Analyze...''' button appears at the top of the report and the analysis' name will appear in the subsequent dialog box when the button is clicked. You can either choose a single analysis or all analyses in this dialog box. Selecting "All" will run them serially.
     23
     24'''Note:''' The current analyses do not, for example, detect circular dependencies nor can they handle complex relationships all in one pass. This means that after a pass of fixes, the changes may have caused or exposed other issues that another analysis pass will uncover. So the general usage pattern is to continue re-running analyses until "quiescence" is reached, ie until there are no more issues to fix.
    6925
    7026==== Milestone Dependency Analysis
     
    189145Detected changes to rollup field values are shown with an option to automatically update the value, see screenshot above.
    190146
    191 == Tips and hints
     147=== Tips and hints
    192148
    193149A few ideas to optimize your analysis experience:
     
    199155 * The core analyses are maintained in Python modules that require no imports. This was intentional so that they may be easily wrapped and called from a monitoring script, eg [https://github.com/trifthen/NagAconda nagaconda] for nagios, so that you can be proactively alerted to ticket scheduling issues without needing to manually run analyses in Trac.
    200156
    201 == Extensibility (implementation details)
     157=== Extensibility (implementation details)
    202158
    203159Each analysis is implemented as a Trac extension point to allow for new analyses to be added fairly easily. See [browser:analyzeplugin/0.12/analyze/analysis.py analysis.py] for the {{{IAnalysis}}} interface. In brief, you only need to define two methods for each analysis:
     
    211167
    212168See the code for examples and other smaller tweaks to the {{{IAnalysis}}} interface and base {{{Analysis}}} class.
     169
     170== Bugs/Feature Requests
     171
     172Existing bugs and feature requests for AnalyzePlugin are
     173[report:9?COMPONENT=AnalyzePlugin here].
     174
     175If you have any issues, create a
     176[/newticket?component=AnalyzePlugin new ticket].
     177
     178[[TicketQuery(component=AnalyzePlugin&group=type,format=progress)]]
     179
     180== Download
     181
     182Download the zipped source from [export:analyzeplugin here].
     183
     184== Source
     185
     186You can check out AnalyzePlugin from [/svn/analyzeplugin here] using Subversion, or [source:analyzeplugin browse the source] with Trac.
     187
     188== Installation
     189
     190 1. Download and unzip the plugin.
     191 2. Install the plugin:
     192 {{{#!sh
     193cd analyzeplugin/0.12
     194sudo python setup.py bdist_egg
     195sudo cp dist/TracAnalyze*.egg /your/trac/location/plugins/
     196}}}
     197
     198 See [t:TracPlugins TracPlugins] for more installation details and options. You'll likely need to restart Trac's web server after installation.
     199
     200 3. Enable the plugin by adding the following to your `trac.ini` file:
     201 {{{#!ini
     202[components]
     203analyze.* = enabled
     204}}}
     205
     206 You can alternatively use the Trac Web Admin GUI to enable any or all rules.
     207
     208== Configuration
     209
     210Enable the {{{ANALYZE_VIEW}}} permission for those users who are allowed to execute analyses.
    213211
    214212== Recent Changes