Package: collective.traceview
Thecollective.traceviewpackage adds support forTraceView, aka Tracelytics, to Plone. The fullTraceView documentationcan be read for more information.ContentsContentsContentsIntroductionRequirementsHow to installPlone tracing (NEW)Changelog1.4 (2016-04-13)1.3 (2014-07-24)1.2 - (2013-12-29)1.1 - (2013-06-18)1.0 - (2013-05-21)IntroductionTraceView times the full request from the browser through frontend servers to
application servers. collective.traceview gives you insight into Zope/Plone
internals and adds these layers to TraceView:Zope HTTP ServerZope publisherZODBPortal TransformsOutbound calls to e.g. webservicesPortal Catalog searchesChameleon ZPT engineIt also adds tags to the HTML header and footer to instrument TraceView Real User
Monitoring (RUM), so you’ll get metrics about user network connectivity and how
long time your site takes to render inside the browsers of the real users.RequirementsYou need a TraceView account, TraceView installed on the Plone server. And then the
TraceView Python oboe library must be installed with the same Python that runs Plone.collective.traceview has been tested with Plone 4.System dependencies: liboboe and liboboe-devel (for CentOS) or liboboe-dev (for Debian/Ubuntu)How to installUpdate yourbuildout.cfgfile:Add tracelytics pypi underfind-linksfind-links += http://pypi.tracelytics.com/oboeAdd package in develop modeauto-checkout = collective.traceviewAddoboeandcollective.traceviewto the list of eggs to install[instance]
recipe = plone.recipe.zope2instance
...
eggs =
  ...
  collective.traceview
  oboeGet package from collective sources (or create your own GitHub fork)[sources]
...
collective.traceview = git https://github.com/collective/collective.traceview.gitGetoboeegg version 1.3.8, the latest one released on pypi (version 1.4.2) is not yet fully tested (RUM not working)[versions]
...
oboe = 1.3.8Re-run buildout, e.g. with:$ ./bin/buildoutPlone tracing (NEW)Usually the X-Trace header is generated from a front-end webserver, typically apache. But
in some cases there is no such front-end webserver, so nowhere to start the trace. We
did now add the possibility to get Plone to start the tracing. Just install the product
in the usual way as described above and set the following environment variables. See example below:[instance]
recipe = plone.recipe.zope2instance
...
environment-vars =
  ...
  TRACEVIEW_IGNORE_EXTENSIONS js;css;png;jpeg;jpg;gif;pjpeg;x-png;pdf
  TRACEVIEW_IGNORE_FOUR_OH_FOUR 1
  TRACEVIEW_PLONE_TRACING 1
  TRACEVIEW_DETAILED_PARTITION 1
  TRACEVIEW_SAMPLE_RATE 1.0
  TRACEVIEW_TRACING_MODE alwaysTRACEVIEW_IGNORE_EXTENSIONStells TraceView not to trace urls with the following extensions,
default value no extension is defined.TRACEVIEW_IGNORE_EXTENSIONS=js;css;png;jpeg;jpg;gif;pjpeg;x-png;pdfTRACEVIEW_IGNORE_FOUR_OH_FOURtells TraceView not to record 404 pages, default value is0.TRACEVIEW_IGNORE_FOUR_OH_FOUR=1TRACEVIEW_PLONE_TRACINGtells Plone to do the tracing, do not set this if you have oboe
installed on apache in the front end, default value is0.TRACEVIEW_PLONE_TRACING=1TRACEVIEW_DETAILED_PARTITIONwill split trafic into detailed partition, where the partition
name will also include hostname and zope instance name. The default is to only partition for
Anonymous and Authenticated trafic.TRACEVIEW_DETAILED_PARTITION=1TRACEVIEW_SAMPLE_RATEthe sample rate,1.0means all requests,0.0means no requests,
default value is0.3.TRACEVIEW_SAMPLE_RATE=1.0TRACEVIEW_TRACING_MODEtracing mode,alwaysmeans that we will trace requests, none means no requests to be traced,
default value isnone.TRACEVIEW_TRACING_MODE=alwaysChangelog1.4 (2016-04-13)Added initial support for Chameleon
[bosim]Small markup fixes to CHANGES.txt and README.rst files
[alecghica]Fixed long_description under setup.py to make changelog appear under PyPi
package description page
[alecghica]Updated documentation.
[alecghica]Fix bug in httpserver patch when request.uri is None
[tiberiuichim]Added TRACEVIEW_DETAILED_PARTITION to split trafic in partitions
that include hostname and zope instance name
[tiberiuichim]1.3 (2014-07-24)Added initial plone tracing instrumentation
[bosim]Initial implementation of zserver (medusa) http server patch
[bosim]1.2 - (2013-12-29)Handle both Plone 3 and Plone 4
[stonor]Fixed oboe and unicode
[stonor]Fixed Zodb support to sends correct keys
[stonor]Fixed case when res is None under catalog.py
[alecghica]Updade package version under CHANGES.txt
[alecghica]1.1 - (2013-06-18)Fixed CHANGES.txt for better formatting and to reflect latest release
[alecghica]1.0 - (2013-05-21)Initial public development release
[bosim]