diff --git a/CHANGELOG b/CHANGELOG --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,10 @@ +0.11.0 release 2024-02-06 + +* Add sorting by numbers [#183](https://github.com/mpickering/eventlog2html/pull/183) +* Refactoring and modernization of the UI [#178](https://github.com/mpickering/eventlog2html/pull/178) +* Compatibility with 9.0, 9.2, 9.4, 9.6 and 9.8 which are now also checked in CI. + ([#180](https://github.com/mpickering/eventlog2html/pull/180) and [#181](https://github.com/mpickering/eventlog2html/pull/181)) + 0.10.0 release 2023-03-31 * Add support for rendering ticky profiles @@ -6,7 +13,7 @@ * Add "--version" flag for eventlog2html which prints the version, git commit and git branch used to build eventlog2html. -* Compatability with 9.4.* and 9.2.* compilers. +* Compatibility with 9.4.* and 9.2.* compilers. 0.9.2 release 2021-11-24 diff --git a/eventlog2html.cabal b/eventlog2html.cabal --- a/eventlog2html.cabal +++ b/eventlog2html.cabal @@ -1,6 +1,6 @@ cabal-version: 2.4 Name: eventlog2html -Version: 0.10.0 +Version: 0.11.0 Synopsis: Visualise an eventlog Description: eventlog2html is a library for visualising eventlogs. At the moment, the intended use is to visualise eventlogs @@ -28,29 +28,31 @@ javascript/generated/vega-embed@6.14.0 javascript/generated/vega@5.17.0 javascript/generated/vega-lite@4.17.0 + javascript/generated/popper.js@1.14.3 + inline-docs/*.html extra-doc-files: README.md CHANGELOG -Tested-With: GHC ==9.2.5, GHC ==9.4.3 +Tested-With: GHC ==9.0.2, GHC ==9.2.7, GHC ==9.4.7, GHC ==9.6.2, GHC ==9.8.1 Library Build-depends: - aeson >= 1.4.3 && < 1.6 || >= 2.0 && < 2.2, + aeson >= 1.4.3 && < 1.6 || >= 2.0 && < 2.3, attoparsec >= 0.13.2 && < 0.15, array >= 0.5.3 && < 0.6, base >= 4 && < 5, blaze-html >= 0.9.1 && < 0.10, - bytestring >= 0.10.8 && < 0.12, + bytestring >= 0.10.8 && < 0.13, blaze-markup, - containers >= 0.5.0 && < 0.7, + containers >= 0.5.0 && < 0.8, file-embed >= 0.0.11 && < 0.1, - filepath >= 1.4.2 && < 1.5, + filepath >= 1.4.2 && < 1.6, ghc-events >= 0.19.0 && < 0.20, hashtables >= 1.2.3 && < 1.4, hvega >= 0.11.0 && < 0.13, - mtl >= 2.2.2 && < 2.3, - optparse-applicative >= 0.14.3 && < 0.18, + mtl >= 2.2.2 && < 2.4, + optparse-applicative >= 0.14.3 && < 0.19, semigroups >= 0.18 && < 0.21, - text >= 1.2.3 && < 1.3 || >= 2.0 && < 2.1, + text >= 1.2.3 && < 1.3 || >= 2.0 && < 2.2, time >= 1.8.0 && < 2.0, vector >= 0.11, trie-simple >= 0.4, @@ -74,6 +76,8 @@ Eventlog.HeapProf Eventlog.Vega Eventlog.HtmlTemplate + Eventlog.Rendering.Bootstrap + Eventlog.Rendering.Types Eventlog.VegaTemplate Eventlog.AssetVersions Eventlog.Detailed diff --git a/inline-docs/heap.html b/inline-docs/heap.html new file mode 100644 --- /dev/null +++ b/inline-docs/heap.html @@ -0,0 +1,31 @@ +
+
Heap Size
+
Total size of megablocks allocated by the RTS
+
Blocks Size
+
Total size of blocks allocated by the RTS
+
Live bytes
+
Total size of objects live on the heap (should match top of area pane)
+
+ +

Process memory usage (as reported by the OS) should correspond roughly to the heap size, +except for data allocated through the FFI (and the RTS also calls malloc() itself in a few places). +

+ +

+When heap profiling is enabled, blocks +size and live bytes +will typically differ by the size of the nursery. +For understanding the relationship between blocks +size and live bytes, +this blog +post contains more information.

+ +

+When heap profiling is not enabled, live bytes will be updated only on a major GC, but heap size and blocks size are updated more frequently. (Enabling heap profiling causes more frequent major GCs to collect heap samples.) +

+ +

+This view can also be useful in identifying +fragmentation. A very badly fragmented heap will have low live bytes but +much higher blocks size. +

diff --git a/inline-docs/no-cost-centres.html b/inline-docs/no-cost-centres.html new file mode 100644 --- /dev/null +++ b/inline-docs/no-cost-centres.html @@ -0,0 +1,3 @@ +

+The cost centres view is available only when executing the program with +RTS -hc. +

diff --git a/inline-docs/no-detailed.html b/inline-docs/no-detailed.html new file mode 100644 --- /dev/null +++ b/inline-docs/no-detailed.html @@ -0,0 +1,3 @@ +

+No detailed data to display. +

diff --git a/inline-docs/no-heap-profile.html b/inline-docs/no-heap-profile.html new file mode 100644 --- /dev/null +++ b/inline-docs/no-heap-profile.html @@ -0,0 +1,14 @@ +

+This eventlog was generated without heap profiling. +

+ +

+To create a heap profile, you need to run the program with one of the +RTS +-h... options. The -hT (closure type) and -hi (info +table) heap profiling options are available for all programs. If you compile +with profiling enabled, more options are available. +

+ +

+See the GHC user's guide on profiling memory usage for more information. +

diff --git a/inline-docs/no-ticky.html b/inline-docs/no-ticky.html new file mode 100644 --- /dev/null +++ b/inline-docs/no-ticky.html @@ -0,0 +1,3 @@ +

+No ticky data to display. +

diff --git a/javascript/generated/fancyTable.min.js b/javascript/generated/fancyTable.min.js --- a/javascript/generated/fancyTable.min.js +++ b/javascript/generated/fancyTable.min.js @@ -1,9 +1,9 @@ /*! - * jQuery fancyTable plugin v1.0.26 + * jQuery fancyTable plugin v1.0.34 * https://github.com/myspace-nu * * Copyright 2018 Johan Johansson * Released under the MIT license */ -!function(l){l.fn.fancyTable=function(a){var s=l.extend({inputStyle:"",inputPlaceholder:"Search...",pagination:!1,paginationClass:"btn btn-light",paginationClassActive:"active",pagClosest:3,perPage:10,sortable:!0,searchable:!0,matchCase:!1,exactMatch:!1,onInit:function(){},onUpdate:function(){},sortFunction:function(a,e,t){return"numeric"==t.sortAs[t.sortColumn]?0n.fancyTable.perPage*(n.fancyTable.page-1)&&n.fancyTable.matches<=n.fancyTable.perPage*n.fancyTable.page?l(this).show():l(this).hide()):l(this).hide()}),n.fancyTable.pages=Math.ceil(n.fancyTable.matches/n.fancyTable.perPage),s.pagination){var a=n.fancyTable.paginationElement?l(n.fancyTable.paginationElement):l(n).find(".pag");a.empty();for(var e,t=1;t<=n.fancyTable.pages;t++)(1==t||t>n.fancyTable.page-(s.pagClosest+1)&&t",{html:t,"data-n":t,style:"margin:0.2em",class:s.paginationClass+" "+(t==n.fancyTable.page?s.paginationClassActive:"")}).css("cursor","pointer").bind("click",function(){n.fancyTable.page=l(this).data("n"),o.tableUpdate(n)}),t==n.fancyTable.pages&&n.fancyTable.page...")),a.append(e),1==t&&n.fancyTable.page>s.pagClosest+2&&a.append(l("...")))}s.onUpdate.call(this,n)},this.isSearchMatch=function(a,e){s.matchCase||(a=a.toUpperCase(),e=e.toUpperCase());var t=s.exactMatch;return"auto"==t&&e.match(/^\".*?\"$/)?(t=!0,e=e.substring(1,e.length-1)):t=!1,t?a==e:new RegExp(e).test(a)},this.reinit=function(a){l(this).each(function(){l(this).find("th a").contents().unwrap(),l(this).find("tr.fancySearchRow").remove()}),l(this).fancyTable(this.settings)},this.tableSort=function(t){var a,e;void 0!==t.fancyTable.sortColumn&&t.fancyTable.sortColumn",{class:"sortArrow"}).css({margin:"0.1em",display:"inline-block",width:0,height:0,"border-left":"0.4em solid transparent","border-right":"0.4em solid transparent"})).css(0").append(l(e))),0==l(r).find("thead").length&&l(r).prepend(l("")),s.sortable&&(n=0,l(r).find("thead th").each(function(){r.fancyTable.sortAs.push("numeric"==l(this).data("sortas")?"numeric":"case-insensitive"==l(this).data("sortas")?"case-insensitive":null);var a=l(this).html(),a=l("",{href:"#","aria-label":"Sort by "+l(this).text(),html:a,"data-n":n,class:""}).css({cursor:"pointer",color:"inherit","text-decoration":"none"}).bind("click",function(){return r.fancyTable.sortColumn==l(this).data("n")?r.fancyTable.sortOrder=-r.fancyTable.sortOrder:r.fancyTable.sortOrder=1,r.fancyTable.sortColumn=l(this).data("n"),o.tableSort(r),o.tableUpdate(r),!1});l(this).empty(),l(this).append(a),n++})),s.searchable&&(t=l("").addClass("fancySearchRow"),s.globalSearch?(a=l("",{"aria-label":"Search table",placeholder:s.inputPlaceholder,style:"width:100%;box-sizing:border-box;"+s.inputStyle}).bind("change paste keyup",function(){r.fancyTable.search=l(this).val(),r.fancyTable.page=1,o.tableUpdate(r)}),e=l("",{style:"padding:2px;"}).attr("colspan",r.fancyTable.nColumns),l(a).appendTo(l(e)),l(e).appendTo(l(t))):(n=0,l(r).find("td").first().parent().find("td").each(function(){r.fancyTable.searchArr.push("");var a=l("",{"aria-label":"Search column","data-n":n,placeholder:s.inputPlaceholder,style:"width:100%;box-sizing:border-box;"+s.inputStyle}).bind("change paste keyup",function(){r.fancyTable.searchArr[l(this).data("n")]=l(this).val(),r.fancyTable.page=1,o.tableUpdate(r)}),e=l("",{style:"padding:2px;"});l(a).appendTo(l(e)),l(e).appendTo(l(t)),n++})),t.appendTo(l(r).find("thead"))),o.tableSort(r),s.pagination&&!s.paginationElement&&(l(r).find("tfoot").remove(),l(r).append(l("")),l(r).find("tfoot tr").append(l("",{}).attr("colspan",r.fancyTable.nColumns))),o.tableUpdate(r),s.onInit.call(this,r)}),this}}(jQuery); +!function(i){i.fn.fancyTable=function(a){var o=i.extend({inputStyle:"",inputPlaceholder:"Search...",pagination:!1,paginationClass:"btn btn-light",paginationClassActive:"active",pagClosest:3,perPage:10,sortable:!0,searchable:!0,matchCase:!1,exactMatch:!1,localeCompare:!1,onInit:function(){},beforeUpdate:function(){},onUpdate:function(){},sortFunction:function(a,e,t,n,r){return a==e&&n&&r?t.rowSortOrder[i(n).data("rowid")]>t.rowSortOrder[i(r).data("rowid")]:"numeric"==t.sortAs[t.sortColumn]?0n.fancyTable.perPage*(n.fancyTable.page-1)&&n.fancyTable.matches<=n.fancyTable.perPage*n.fancyTable.page?i(this).show():i(this).hide()):i(this).hide()}),n.fancyTable.pages=Math.ceil(n.fancyTable.matches/n.fancyTable.perPage),o.pagination){var a=n.fancyTable.paginationElement?i(n.fancyTable.paginationElement):i(n).find(".pag");a.empty();for(var e,t=1;t<=n.fancyTable.pages;t++)(1==t||t>n.fancyTable.page-(o.pagClosest+1)&&t",{html:t,"data-n":t,style:"margin:0.2em",class:o.paginationClass+" "+(t==n.fancyTable.page?o.paginationClassActive:"")}).css("cursor","pointer").bind("click",function(){n.fancyTable.page=i(this).data("n"),l.tableUpdate(n)}),t==n.fancyTable.pages&&n.fancyTable.page...")),a.append(e),1==t&&n.fancyTable.page>o.pagClosest+2&&a.append(i("...")))}o.onUpdate.call(this,n)},this.isSearchMatch=function(a,e){if(o.matchCase||(a=a.toUpperCase(),e=e.toUpperCase()),"auto"==o.exactMatch&&e.match(/^".*?"$/))return a==(e=e.substring(1,e.length-1));if("auto"==o.exactMatch&&e.replace(/\s+/g,"").match(/^[<>]=?/)){var t=e.replace(/\s+/g,"").match(/^[<>]=?/)[0],n=e.replace(/\s+/g,"").substring(t.length);return">"==t&&+n<+a||"<"==t&&+a<+n||">="==t&&+n<=+a||"<="==t&&+a<=+n}if("auto"==o.exactMatch&&e.replace(/\s+/g,"").match(/^.+(\.\.|-).+$/)){n=e.replace(/\s+/g,"").split(/\.\.|-/);return+a>=+n[0]&&+a<=+n[1]}try{return!0===o.exactMatch?a==e:new RegExp(e).test(a)}catch{return!1}},this.reinit=function(){i(this).each(function(){i(this).find("th a").contents().unwrap(),i(this).find("tr.fancySearchRow").remove()}),i(this).fancyTable(this.settings)},this.tableSort=function(r){var a,e;void 0!==r.fancyTable.sortColumn&&r.fancyTable.sortColumn",{class:"sortArrow"}).css({margin:"0.1em",display:"inline-block",width:0,height:0,"border-left":"0.4em solid transparent","border-right":"0.4em solid transparent"})).css(0").append(i(n))),0==i(s).find("thead").length&&i(s).prepend(i("")),i(s).find("tbody tr").each(function(a){i(this).data("rowid",a)}),o.sortable&&(e=0,i(s).find("thead th").each(function(){s.fancyTable.sortAs.push("numeric"==i(this).data("sortas")?"numeric":"case-insensitive"==i(this).data("sortas")?"case-insensitive":null);var a=i(this).html(),a=i("",{href:"#","aria-label":"Sort by "+i(this).text(),html:a,"data-n":e,class:""}).css({cursor:"pointer",color:"inherit","text-decoration":"none","white-space":"nowrap"}).bind("click",function(){return s.fancyTable.sortColumn==i(this).data("n")?s.fancyTable.sortOrder=-s.fancyTable.sortOrder:s.fancyTable.sortOrder=1,s.fancyTable.sortColumn=i(this).data("n"),l.tableSort(s),l.tableUpdate(s),!1});i(this).empty(),i(this).append(a),e++})),o.searchable&&(t=i("").addClass("fancySearchRow"),o.globalSearch?(a=i("",{"aria-label":"Search table",placeholder:o.inputPlaceholder,style:"width:100%;box-sizing:border-box;"+o.inputStyle}).bind("change paste keyup",function(){s.fancyTable.search=i(this).val(),s.fancyTable.page=1,l.tableUpdate(s)}),n=i("",{style:"padding:2px;"}).attr("colspan",s.fancyTable.nColumns),i(a).appendTo(i(n)),i(n).appendTo(i(t))):(r=0,i(s).find("td").first().parent().find("td").each(function(){s.fancyTable.searchArr.push("");var a=i("",{"aria-label":"Search column","data-n":r,placeholder:o.inputPlaceholder,style:"width:100%;box-sizing:border-box;"+o.inputStyle}).bind("change paste keyup",function(){s.fancyTable.searchArr[i(this).data("n")]=i(this).val(),s.fancyTable.page=1,l.tableUpdate(s)}),e=i("",{style:"padding:2px;"});i(a).appendTo(i(e)),i(e).appendTo(i(t)),r++})),t.appendTo(i(s).find("thead"))),l.tableSort(s),o.pagination&&!o.paginationElement&&(i(s).find("tfoot").remove(),i(s).append(i("")),i(s).find("tfoot tr").append(i("",{}).attr("colspan",s.fancyTable.nColumns))),l.tableUpdate(s),o.onInit.call(this,s)}),this}}(jQuery); diff --git a/javascript/generated/popper.js@1.14.3 b/javascript/generated/popper.js@1.14.3 new file mode 100644 --- /dev/null +++ b/javascript/generated/popper.js@1.14.3 @@ -0,0 +1,5 @@ +/* + Copyright (C) Federico Zivolo 2018 + Distributed under the MIT License (license terms are at http://opensource.org/licenses/MIT). + */(function(e,t){'object'==typeof exports&&'undefined'!=typeof module?module.exports=t():'function'==typeof define&&define.amd?define(t):e.Popper=t()})(this,function(){'use strict';function e(e){return e&&'[object Function]'==={}.toString.call(e)}function t(e,t){if(1!==e.nodeType)return[];var o=getComputedStyle(e,null);return t?o[t]:o}function o(e){return'HTML'===e.nodeName?e:e.parentNode||e.host}function n(e){if(!e)return document.body;switch(e.nodeName){case'HTML':case'BODY':return e.ownerDocument.body;case'#document':return e.body;}var i=t(e),r=i.overflow,p=i.overflowX,s=i.overflowY;return /(auto|scroll|overlay)/.test(r+s+p)?e:n(o(e))}function r(e){return 11===e?re:10===e?pe:re||pe}function p(e){if(!e)return document.documentElement;for(var o=r(10)?document.body:null,n=e.offsetParent;n===o&&e.nextElementSibling;)n=(e=e.nextElementSibling).offsetParent;var i=n&&n.nodeName;return i&&'BODY'!==i&&'HTML'!==i?-1!==['TD','TABLE'].indexOf(n.nodeName)&&'static'===t(n,'position')?p(n):n:e?e.ownerDocument.documentElement:document.documentElement}function s(e){var t=e.nodeName;return'BODY'!==t&&('HTML'===t||p(e.firstElementChild)===e)}function d(e){return null===e.parentNode?e:d(e.parentNode)}function a(e,t){if(!e||!e.nodeType||!t||!t.nodeType)return document.documentElement;var o=e.compareDocumentPosition(t)&Node.DOCUMENT_POSITION_FOLLOWING,n=o?e:t,i=o?t:e,r=document.createRange();r.setStart(n,0),r.setEnd(i,0);var l=r.commonAncestorContainer;if(e!==l&&t!==l||n.contains(i))return s(l)?l:p(l);var f=d(e);return f.host?a(f.host,t):a(e,d(t).host)}function l(e){var t=1=o.clientWidth&&n>=o.clientHeight}),l=0a[e]&&!t.escapeWithReference&&(n=J(f[o],a[e]-('right'===e?f.width:f.height))),ae({},o,n)}};return l.forEach(function(e){var t=-1===['left','top'].indexOf(e)?'secondary':'primary';f=le({},f,m[t](e))}),e.offsets.popper=f,e},priority:['left','right','top','bottom'],padding:5,boundariesElement:'scrollParent'},keepTogether:{order:400,enabled:!0,fn:function(e){var t=e.offsets,o=t.popper,n=t.reference,i=e.placement.split('-')[0],r=Z,p=-1!==['top','bottom'].indexOf(i),s=p?'right':'bottom',d=p?'left':'top',a=p?'width':'height';return o[s]r(n[s])&&(e.offsets.popper[d]=r(n[s])),e}},arrow:{order:500,enabled:!0,fn:function(e,o){var n;if(!q(e.instance.modifiers,'arrow','keepTogether'))return e;var i=o.element;if('string'==typeof i){if(i=e.instance.popper.querySelector(i),!i)return e;}else if(!e.instance.popper.contains(i))return console.warn('WARNING: `arrow.element` must be child of its popper element!'),e;var r=e.placement.split('-')[0],p=e.offsets,s=p.popper,d=p.reference,a=-1!==['left','right'].indexOf(r),l=a?'height':'width',f=a?'Top':'Left',m=f.toLowerCase(),h=a?'left':'top',c=a?'bottom':'right',u=S(i)[l];d[c]-us[c]&&(e.offsets.popper[m]+=d[m]+u-s[c]),e.offsets.popper=g(e.offsets.popper);var b=d[m]+d[l]/2-u/2,y=t(e.instance.popper),w=parseFloat(y['margin'+f],10),E=parseFloat(y['border'+f+'Width'],10),v=b-e.offsets.popper[m]-w-E;return v=$(J(s[l]-u,v),0),e.arrowElement=i,e.offsets.arrow=(n={},ae(n,m,Q(v)),ae(n,h,''),n),e},element:'[x-arrow]'},flip:{order:600,enabled:!0,fn:function(e,t){if(W(e.instance.modifiers,'inner'))return e;if(e.flipped&&e.placement===e.originalPlacement)return e;var o=v(e.instance.popper,e.instance.reference,t.padding,t.boundariesElement,e.positionFixed),n=e.placement.split('-')[0],i=T(n),r=e.placement.split('-')[1]||'',p=[];switch(t.behavior){case he.FLIP:p=[n,i];break;case he.CLOCKWISE:p=z(n);break;case he.COUNTERCLOCKWISE:p=z(n,!0);break;default:p=t.behavior;}return p.forEach(function(s,d){if(n!==s||p.length===d+1)return e;n=e.placement.split('-')[0],i=T(n);var a=e.offsets.popper,l=e.offsets.reference,f=Z,m='left'===n&&f(a.right)>f(l.left)||'right'===n&&f(a.left)f(l.top)||'bottom'===n&&f(a.top)f(o.right),g=f(a.top)f(o.bottom),b='left'===n&&h||'right'===n&&c||'top'===n&&g||'bottom'===n&&u,y=-1!==['top','bottom'].indexOf(n),w=!!t.flipVariations&&(y&&'start'===r&&h||y&&'end'===r&&c||!y&&'start'===r&&g||!y&&'end'===r&&u);(m||b||w)&&(e.flipped=!0,(m||b)&&(n=p[d+1]),w&&(r=G(r)),e.placement=n+(r?'-'+r:''),e.offsets.popper=le({},e.offsets.popper,C(e.instance.popper,e.offsets.reference,e.placement)),e=P(e.instance.modifiers,e,'flip'))}),e},behavior:'flip',padding:5,boundariesElement:'viewport'},inner:{order:700,enabled:!1,fn:function(e){var t=e.placement,o=t.split('-')[0],n=e.offsets,i=n.popper,r=n.reference,p=-1!==['left','right'].indexOf(o),s=-1===['top','left'].indexOf(o);return i[p?'left':'top']=r[o]-(s?i[p?'width':'height']:0),e.placement=T(t),e.offsets.popper=g(i),e}},hide:{order:800,enabled:!0,fn:function(e){if(!q(e.instance.modifiers,'hide','preventOverflow'))return e;var t=e.offsets.reference,o=D(e.instance.modifiers,function(e){return'preventOverflow'===e.name}).boundaries;if(t.bottomo.right||t.top>o.bottom||t.right FilePath -> FilePath -> IO () doOneJson a fin fout = do - HeapProfile (_, val, _, _) <- generateJson fin a + Just (HeapProfileData val _ _) <- eventlogHeapProfile <$> generateJson fin a encodeFile fout val doOneHtml :: Args -> FilePath -> FilePath -> IO () doOneHtml a fin fout = do prof_type <- generateJsonValidate checkTraces fin a - let html = case prof_type of - HeapProfile (header, data_json, descs, closure_descs) -> - templateString header data_json descs closure_descs a - TickyProfile (header, tallocs, ticked_per, dat) -> - tickyTemplateString header tallocs ticked_per dat a + let html = templateString prof_type a writeFile fout html where checkTraces :: ProfData -> IO () diff --git a/src/Eventlog/Args.hs b/src/Eventlog/Args.hs --- a/src/Eventlog/Args.hs +++ b/src/Eventlog/Args.hs @@ -21,7 +21,7 @@ = ShowVersion | Run Args -data Sort = Size | StdDev | Name | Gradient +data Sort = Size | StdDev | Name | Gradient | Number data Args = Args { @@ -47,7 +47,7 @@ argParser = Run <$> (Args <$> option parseSort ( long "sort" - <> help "How to sort the bands. One of: size (default), stddev, name, gradient." + <> help "How to sort the bands. One of: size (default), stddev, name, number, gradient." <> value Size <> metavar "FIELD" ) <*> switch @@ -118,8 +118,9 @@ "size" -> Right Size "stddev" -> Right StdDev "name" -> Right Name + "number" -> Right Number "gradient" -> Right Gradient - _ -> Left "expected one of: size, stddev, name" + _ -> Left "expected one of: size, stddev, name, number" args :: IO Option args = execParser argsInfo diff --git a/src/Eventlog/AssetVersions.hs b/src/Eventlog/AssetVersions.hs --- a/src/Eventlog/AssetVersions.hs +++ b/src/Eventlog/AssetVersions.hs @@ -39,3 +39,6 @@ datatablesButtonsHTML5Version,datatablesButtonsHTML5URL :: String datatablesButtonsHTML5Version = "2.0.1" datatablesButtonsHTML5URL = "https://cdn.datatables.net/buttons/2.0.1/js/buttons.html5.min.js" +popperVersion,popperURL :: String +popperVersion = "1.14.3" +popperURL = "https://cdn.jsdelivr.net/npm/popper.js@1.14.3" diff --git a/src/Eventlog/Data.hs b/src/Eventlog/Data.hs --- a/src/Eventlog/Data.hs +++ b/src/Eventlog/Data.hs @@ -1,10 +1,18 @@ {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE TupleSections #-} -module Eventlog.Data (generateJson, generateJsonValidate, generateJsonData, EventlogType(..) ) where +module Eventlog.Data + ( generateJson + , generateJsonValidate + , generateJsonData + , EventlogType(..) + , HeapProfileData(..) + , TickyProfileData(..) + ) where import Prelude hiding (readFile) -import Data.Aeson (Value(..), (.=), object) +import Data.Aeson ((.=), object) import qualified Data.Map as Map +import Data.Maybe import Eventlog.Args (Args(..)) import Eventlog.Bands (bands) @@ -12,25 +20,19 @@ import qualified Eventlog.HeapProf as H import Eventlog.Prune import Eventlog.Vega -import Eventlog.Types (Header(..), ProfData(..), HeapProfBreakdown(..)) +import Eventlog.Types import Data.List import Data.Ord import Eventlog.Trie import Eventlog.Detailed -import Text.Blaze.Html import Eventlog.Ticky -import Data.Word - -data EventlogType = HeapProfile (Header, Value, Maybe Value, Maybe Html) - | TickyProfile (Header, Word64, Double, Html) - -generateJsonData :: Args -> ProfData -> IO (Header, Value, Maybe Value, Maybe Html) -generateJsonData a (ProfData h binfo ccMap fs traces heap_info ipes _ticky_counter _ticky_samples _total_allocs) = do +generateJsonData :: Args -> ProfData -> HeapProfileData +generateJsonData a (ProfData h binfo ccMap fs traces heap_info ipes _ticky_counter _ticky_samples _total_allocs) = let keeps = pruneBands a binfo bs = bands h (Map.map fst keeps) fs combinedJson = object [ - "samples" .= bandsToVega keeps bs + "samples" .= bandsToVega bucket_desc keeps bs , "traces" .= tracesToVega traces , "heap" .= heapToVega heap_info ] @@ -41,16 +43,27 @@ Just HeapProfBreakdownCostCentre -> Just (outputTree ccMap mdescs) _ -> Nothing - let use_ipes = case hHeapProfileType h of + use_ipes = case hHeapProfileType h of Just HeapProfBreakdownInfoTable -> Just ipes _ -> Nothing + + -- If we have IPE info, try to translate info table pointers to names + bucket_desc bucket_info = fromMaybe desc $ do + ipe_map <- use_ipes + iptr <- toItblPointer_maybe (Bucket desc) + itl <- Map.lookup iptr ipe_map + pure (itlName itl <> " (" <> desc <> ")") + where + desc = shortDescription bucket_info + desc_buckets = pruneDetailed a binfo bs' = bands h (Map.map fst desc_buckets) fs closure_table = case detailedLimit a of Just 0 -> Nothing + _ | null desc_buckets -> Nothing _ -> Just (renderClosureInfo bs' use_ipes desc_buckets) - return (h, combinedJson, cc_descs, closure_table) + in HeapProfileData combinedJson cc_descs closure_table generateJson :: FilePath -> Args -> IO EventlogType generateJson = generateJsonValidate (const (return ())) @@ -61,14 +74,12 @@ let chunk = if heapProfile a then H.chunk else E.chunk a dat <- chunk file validate dat - case profTickySamples dat of - [] -> HeapProfile <$> generateJsonData a dat - -- If there are any ticky samples then generate a ticky profile - _ -> do - let (percen, html) = renderTicky (profTotalAllocations dat) (profTickyCounters dat) (profItl dat) (profTickySamples dat) - return $ TickyProfile ( profHeader dat - , profTotalAllocations dat - , percen - , html ) - + pure $ EventlogType (profHeader dat) + (Just (generateJsonData a dat)) + (if not (null (profTickySamples dat)) then Just (generateTickyData dat) else Nothing) + -- If there are any ticky samples then generate a ticky profile +generateTickyData :: ProfData -> TickyProfileData +generateTickyData dat = + let (percen, html) = renderTicky (profTotalAllocations dat) (profTickyCounters dat) (profItl dat) (profTickySamples dat) + in TickyProfileData (profTotalAllocations dat) percen html diff --git a/src/Eventlog/Detailed.hs b/src/Eventlog/Detailed.hs --- a/src/Eventlog/Detailed.hs +++ b/src/Eventlog/Detailed.hs @@ -29,7 +29,7 @@ Just ipes -> mkClosureInfo (\k _ -> toItblPointer k) raw_bs ipes Nothing -> Map.map (\v -> (None, v)) raw_bs - H.table ! A.id "closure_table" ! A.class_ "table table-striped closureTable" ! A.hidden "true" $ do + H.table ! A.id "closure_table" ! A.class_ "table table-striped closureTable" $ do H.thead $ H.tr $ do H.th "Profile" numTh "n" @@ -114,7 +114,6 @@ \$.fn.sparkline.defaults.common.chartRangeMin = 0;\ \$.fn.sparkline.defaults.common.width = 200;\ \$('.linechart').sparkline();\ - \$(\".closureTable\").removeAttr(\"hidden\")\ \});" getBandValues :: Int diff --git a/src/Eventlog/HtmlTemplate.hs b/src/Eventlog/HtmlTemplate.hs --- a/src/Eventlog/HtmlTemplate.hs +++ b/src/Eventlog/HtmlTemplate.hs @@ -1,4 +1,5 @@ {-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TemplateHaskell #-} module Eventlog.HtmlTemplate where import Data.Aeson (Value, encode) @@ -6,38 +7,42 @@ import Data.String import Data.Text (Text, append) import qualified Data.Text as T -import qualified Data.Text.Lazy.Encoding as T +import qualified Data.Text.Encoding as T +import qualified Data.Text.Lazy.Encoding as TL import qualified Data.Text.Lazy as TL --import Text.Blaze.Html import Text.Blaze.Html5 as H import Text.Blaze.Html5.Attributes as A import Text.Blaze.Html.Renderer.String +import Data.FileEmbed +import Eventlog.Data import Eventlog.Javascript import Eventlog.Args import Eventlog.Types (Header(..), HeapProfBreakdown(..)) +import Eventlog.Rendering.Bootstrap +import Eventlog.Rendering.Types import Eventlog.VegaTemplate import Eventlog.AssetVersions +import Eventlog.Ticky (tickyTab) import Paths_eventlog2html import Data.Version import Control.Monad import Data.Maybe -type VizID = Int - insertJsonData :: Value -> Html insertJsonData dat = preEscapedToHtml $ T.unlines [ "data_json= " `append` dat' `append` ";" , "console.log(data_json);" ] where - dat' = TL.toStrict (T.decodeUtf8 (encode dat)) + dat' = TL.toStrict (TL.decodeUtf8 (encode dat)) insertJsonDesc :: Value -> Html insertJsonDesc dat = preEscapedToHtml $ T.unlines [ "desc_json= " `append` dat' `append` ";" , "console.log(desc_json);" ] where - dat' = TL.toStrict (T.decodeUtf8 (encode dat)) + dat' = TL.toStrict (TL.decodeUtf8 (encode dat)) -- Dynamically bound in ccs tree insertColourScheme :: Text -> Html @@ -51,16 +56,14 @@ where line t = "res.view.insert(\"data_json_" <> t <>"\", data_json."<> t <>");" -data IncludeTraceData = TraceData | NoTraceData - -encloseScript :: [Text] -> VizID -> Text -> Html +encloseScript :: [Text] -> TabID -> Text -> Html encloseScript = encloseScriptX -encloseRawVegaScript :: VizID -> Text -> Html +encloseRawVegaScript :: TabID -> Text -> Html encloseRawVegaScript = encloseScriptX [] -encloseScriptX :: [Text] -> VizID -> Text -> Html -encloseScriptX insert_data_sets vid vegaspec = preEscapedToHtml $ T.unlines ([ +encloseScriptX :: [Text] -> TabID -> Text -> Html +encloseScriptX insert_data_sets (TabID vidt) vegaspec = preEscapedToHtml $ T.unlines ([ "var yourVlSpec" `append` vidt `append`"= " `append` vegaspec `append` ";" , "vegaEmbed('#vis" `append` vidt `append` "', yourVlSpec" `append` vidt `append` ")" , ".then((res) => { " ] @@ -71,24 +74,24 @@ [ "; res.view.resize()" , "; res.view.runAsync()" , "})" ]) - where - vidt = T.pack $ show vid jsScript :: String -> Html jsScript url = script ! src (fromString $ url) $ "" css :: AttributeValue -> Html css url = link ! rel "stylesheet" ! href url -htmlHeader :: Value -> Maybe Value -> Args -> Html -htmlHeader dat desc as = +htmlHeader :: Maybe HeapProfileData -> Maybe TickyProfileData -> Args -> Html +htmlHeader mb_hpd mb_ticky as = H.head $ do H.title "eventlog2html - Heap Profile" meta ! charset "UTF-8" - script $ insertJsonData dat - maybe (return ()) (script . insertJsonDesc) desc + forM_ mb_hpd $ \ (HeapProfileData dat desc _) -> do + script $ insertJsonData dat + maybe (return ()) (script . insertJsonDesc) desc script $ insertColourScheme (userColourScheme as) if not (noIncludejs as) then do + script $ preEscapedToHtml popper script $ preEscapedToHtml vegaLite script $ preEscapedToHtml vega script $ preEscapedToHtml vegaEmbed @@ -97,81 +100,73 @@ script $ preEscapedToHtml bootstrap script $ preEscapedToHtml fancytable script $ preEscapedToHtml sparkline + when has_ticky $ do + H.style $ preEscapedToHtml datatablesCSS + H.style $ preEscapedToHtml datatablesButtonsCSS + script $ preEscapedToHtml datatables + script $ preEscapedToHtml datatablesButtons + script $ preEscapedToHtml datatablesHtml5 + H.style $ preEscapedToHtml imagesCSS else do + jsScript popperURL jsScript vegaURL jsScript vegaLiteURL jsScript vegaEmbedURL jsScript jqueryURL css (preEscapedStringValue bootstrapCSSURL) jsScript bootstrapURL - css "//fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic" jsScript fancyTableURL jsScript sparklinesURL + when has_ticky $ do + css (preEscapedStringValue datatablesCSSURL) + css (preEscapedStringValue datatablesButtonsCSSURL) + jsScript datatablesURL + jsScript datatablesButtonsURL + jsScript datatablesButtonsHTML5URL + when has_ticky $ + script $ preEscapedToHtml datatablesEllipsis -- Include this last to overwrite some milligram styling H.style $ preEscapedToHtml stylesheet - + where + has_ticky = isJust mb_ticky -template :: Header -> Value -> Maybe Value -> Maybe Html -> Args -> Html -template header' dat cc_descs closure_descs as = docTypeHtml $ do +template :: EventlogType + -> Args + -> [TabGroup] + -> Html +template (EventlogType header' x y) as tab_groups = docTypeHtml $ do H.stringComment $ "Generated with eventlog2html-" <> showVersion version - htmlHeader dat cc_descs as - body $ H.div ! class_ "container" $ do - H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - h1 $ a ! href "https://mpickering.github.io/eventlog2html" $ "eventlog2html" - - H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - "Options: " - code $ toHtml $ hJob header' - + htmlHeader x y as + body $ H.div ! class_ "container-fluid" $ do + H.div ! class_ "row" $ navbar tab_groups H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - "Created at: " - code $ toHtml $ hDate header' + H.div ! class_ "col tab-content custom-tab" $ do + forM_ tab_groups $ \group -> do + case group of + SingleTab tab -> renderTab header' tab + ManyTabs _ tabs -> mapM_ (renderTab header') tabs - forM_ (hHeapProfileType header') $ \prof_type -> do - H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - "Type of profile: " - code $ toHtml $ ppHeapProfileType prof_type + script $ preEscapedToHtml tablogic - H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - "Sampling rate in seconds: " - code $ toHtml $ hSamplingRate header' +renderTab :: Header -> Tab -> Html +renderTab header' tab = + H.div ! A.id (toValue (tabIDToTabID (tabId tab))) ! class_ ("tab-pane tabviz " <> status) $ H.div ! class_ "row" $ do + forM_ (tabContent tab) $ \stuff -> H.div ! class_ "col" $ do + stuff + perTabFooter header' + forM_ (tabDocs tab) $ \docs -> H.div ! class_ "col" $ docs + where + status = if tabActive tab then "show active" else "" - H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - button ! class_ "tablink button-black" ! onclick "changeTab('areachart', this)" ! A.id "defaultOpen" $ "Area Chart" - button ! class_ "tablink button-black" ! onclick "changeTab('normalizedchart', this)" $ "Normalized" - button ! class_ "tablink button-black" ! onclick "changeTab('streamgraph', this)" $ "Streamgraph" - button ! class_ "tablink button-black" ! onclick "changeTab('linechart', this)" $ "Linechart" - button ! class_ "tablink button-black" ! onclick "changeTab('heapchart', this)" $ "Heap" - when (isJust cc_descs) $ do - button ! class_ "tablink button-black" ! onclick "changeTab('cost-centres', this)" $ "Cost Centres" - when (isJust closure_descs) $ do - button ! class_ "tablink button-black" ! onclick "changeTab('closures', this)" $ "Detailed" +perTabFooter :: Header -> Html +perTabFooter header' = do H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - let itd = if (noTraces as) then NoTraceData else TraceData - mapM_ (\(vid, chartname, conf) -> - H.div ! A.id chartname ! class_ "tabviz" $ do - renderChart itd conf True vid - (TL.toStrict (encodeToLazyText (vegaJson (htmlConf as conf))))) - [(1, "areachart", AreaChart Stacked) - ,(2, "normalizedchart", AreaChart Normalized) - ,(3, "streamgraph", AreaChart StreamGraph) - ,(4, "linechart", LineChart) - ,(5, "heapchart", HeapChart) ] - - when (isJust cc_descs) $ do - H.div ! A.id "cost-centres" ! class_ "tabviz" $ do - renderChart itd LineChart False 6 treevega - forM_ closure_descs $ \v -> do - H.div ! A.id "closures" ! class_ "tabviz" $ do - v - script $ preEscapedToHtml tablogic + H.div ! class_ "col" $ do + toHtml $ maybe "No heap profile" ppHeapProfileType (hHeapProfileType header') + ", created at " + code $ toHtml $ hDate header' + " by " + code $ toHtml $ hJob header' select_data :: IncludeTraceData -> ChartType -> [Text] @@ -186,27 +181,39 @@ htmlConf :: Args -> ChartType -> ChartConfig -htmlConf as ct = ChartConfig 1200 1000 (not (noTraces as)) (userColourScheme as) "set1" ct (fromIntegral <$> (fixedYAxis as)) +htmlConf as ct = + ChartConfig + { cwidth = 1200 + , cheight = 1000 + , traces = not (noTraces as) + , colourScheme = userColourScheme as + , lineColourScheme = "set1" + , chartType = ct + , fixedYAxisExtent = fromIntegral <$> fixedYAxis as + } -renderChart :: IncludeTraceData -> ChartType -> Bool -> VizID -> Text -> Html +renderChart :: IncludeTraceData -> ChartType -> Bool -> TabID -> Text -> Html renderChart itd ct vega_lite vid vegaSpec = do let fields = select_data itd ct - H.div ! A.id (fromString $ "vis" ++ show vid) ! class_ "chart" $ "" + H.div ! A.id (toValue (tabIDToVizID vid)) ! class_ "chart" $ "" script ! type_ "text/javascript" $ do if vega_lite then encloseScript fields vid vegaSpec else encloseRawVegaScript vid vegaSpec -renderChartWithJson :: IncludeTraceData -> ChartType -> Int -> Value -> Text -> Html +renderChartWithJson :: IncludeTraceData -> ChartType -> TabID -> Value -> Text -> Html renderChartWithJson itd ct k dat vegaSpec = do script $ insertJsonData dat renderChart itd ct True k vegaSpec -templateString :: Header -> Value -> Maybe Value -> Maybe Html -> Args -> String -templateString header' dat cc_descs closure_descs as = - renderHtml $ template header' dat cc_descs closure_descs as +templateString :: EventlogType + -> Args + -> String +templateString x as = + renderHtml $ template x as $ allTabs x as + ppHeapProfileType :: HeapProfBreakdown -> Text ppHeapProfileType (HeapProfBreakdownCostCentre) = "Cost centre profiling (implied by -hc)" ppHeapProfileType (HeapProfBreakdownModule) = "Profiling by module (implied by -hm)" @@ -216,3 +223,95 @@ ppHeapProfileType (HeapProfBreakdownBiography) = "Biographical profiling (implied by -hb)" ppHeapProfileType (HeapProfBreakdownClosureType) = "Basic heap profile (implied by -hT)" ppHeapProfileType (HeapProfBreakdownInfoTable) = "Info table profile (implied by -hi)" + + +allTabs :: EventlogType + -> Args + -> [TabGroup] +allTabs (EventlogType h x y) as = + [SingleTab (metaTab h as)] ++ + maybe [] (allHeapTabs h as) x ++ + [tickyProfileTabs y] + +metaTab :: Header -> Args -> Tab +metaTab header' _as = + (mkTab "Meta" "meta" metadata Nothing) { tabActive = True } + where + metadata = do + "Rendered by " + a ! href "https://mpickering.github.io/eventlog2html" $ "eventlog2html " <> toHtml (showVersion version) + when (has_heap_profile header') $ + H.div ! class_ "row" $ do + H.div ! class_ "col" $ do + "Sampling rate: " + code $ toHtml $ hSamplingRate header' + " seconds between heap samples" + +has_heap_profile :: Header -> Bool +has_heap_profile h = isJust (hHeapProfileType h) + +allHeapTabs :: Header -> Args -> HeapProfileData -> [TabGroup] +allHeapTabs header' as x = + [ heapTab as + , heapProfileTabs header' as x + , costCentresTab as x + , detailedTab x + ] + +heapTab :: Args -> TabGroup +heapTab as = SingleTab $ mkTab "Heap" tabid (mk as HeapChart tabid) (Just heapDocs) + where + tabid = "heapchart" + +heapDocs :: Html +heapDocs = H.div $ preEscapedToHtml $ T.decodeUtf8 $(embedFile "inline-docs/heap.html") + + +heapProfileTabs :: Header -> Args -> HeapProfileData -> TabGroup +heapProfileTabs header' as _ + | has_heap_profile header' = ManyTabs "Heap Profile" $ + [ mkTab "Area Chart" "areachart" (mk as (AreaChart Stacked) "areachart") noDocs + , mkTab "Normalized" "normalizedchart" (mk as (AreaChart Normalized) "normalizedchart") noDocs + , mkTab "Streamgraph" "streamgraph" (mk as (AreaChart StreamGraph) "streamgraph") noDocs + , mkTab "Linechart" "linechart" (mk as LineChart "linechart") noDocs + ] + | otherwise = SingleTab noHeapProfileTab + +noHeapProfileTab :: Tab +noHeapProfileTab = mkUnavailableTab "Heap Profile" "heap_profile" noHeapProfileDocs + +noHeapProfileDocs :: Html +noHeapProfileDocs = H.div $ preEscapedToHtml $ T.decodeUtf8 $(embedFile "inline-docs/no-heap-profile.html") + + +mk :: Args -> ChartType -> TabID -> Html +mk as conf vid = renderChart itd conf True vid + (TL.toStrict (encodeToLazyText (vegaJson (htmlConf as conf)))) + where + itd = if noTraces as then NoTraceData else TraceData + +detailedTab :: HeapProfileData -> TabGroup +detailedTab (HeapProfileData _dat _cc_descs closure_descs) = + SingleTab $ mkOptionalTab "Detailed" "closures" Prelude.id noDocs noDetailedDocs closure_descs + +noDetailedDocs :: Html +noDetailedDocs = H.div $ preEscapedToHtml $ T.decodeUtf8 $(embedFile "inline-docs/no-detailed.html") + + +costCentresTab :: Args -> HeapProfileData -> TabGroup +costCentresTab as (HeapProfileData _dat cc_descs _) = + SingleTab $ mkOptionalTab "Cost Centres" "costcentres" (const stuff) noDocs noCostCentresDocs cc_descs + where + tabIx = "costcentres" + itd = if noTraces as then NoTraceData else TraceData + stuff = renderChart itd LineChart False tabIx treevega + +noCostCentresDocs :: Html +noCostCentresDocs = H.div $ preEscapedToHtml $ T.decodeUtf8 $(embedFile "inline-docs/no-cost-centres.html") + + +tickyProfileTabs :: Maybe TickyProfileData -> TabGroup +tickyProfileTabs = SingleTab . mkOptionalTab "Ticky" "ticky" tickyTab noDocs noTickyDocs + +noTickyDocs :: Html +noTickyDocs = H.div $ preEscapedToHtml $ T.decodeUtf8 $(embedFile "inline-docs/no-ticky.html") diff --git a/src/Eventlog/Javascript.hs b/src/Eventlog/Javascript.hs --- a/src/Eventlog/Javascript.hs +++ b/src/Eventlog/Javascript.hs @@ -21,6 +21,8 @@ , stylesheet , tablogic , treevega + + , popper ) where import Data.Text @@ -81,3 +83,6 @@ treevega :: Text treevega = decodeUtf8 $(embedFile "javascript/ccmap.vg") + +popper :: Text +popper = decodeUtf8 $(embedFile $ "javascript/generated/popper.js@" <> popperVersion) diff --git a/src/Eventlog/Prune.hs b/src/Eventlog/Prune.hs --- a/src/Eventlog/Prune.hs +++ b/src/Eventlog/Prune.hs @@ -1,5 +1,6 @@ {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE ViewPatterns #-} +{-# LANGUAGE TypeApplications #-} module Eventlog.Prune ( pruneBands, pruneDetailed ) where @@ -11,6 +12,9 @@ import Eventlog.Args (Args(..), Sort(..)) import Data.Maybe +import Data.Word (Word64) +import Text.Read (readMaybe) +import qualified Data.Text as T type Compare a = a -> a -> Ordering @@ -21,15 +25,20 @@ getComparison Args { sorting = StdDev, reversing = True } = cmpStdDevAscending getComparison Args { sorting = Name, reversing = True } = cmpNameDescending getComparison Args { sorting = Name, reversing = False } = cmpNameAscending +getComparison Args { sorting = Number, reversing = True } = cmpNumberDescending +getComparison Args { sorting = Number, reversing = False } = cmpNumberAscending getComparison Args { sorting = Gradient, reversing = True } = cmpGradientAscending getComparison Args { sorting = Gradient, reversing = False } = cmpGradientDescending cmpNameAscending, cmpNameDescending, + cmpNumberAscending, cmpNumberDescending, cmpStdDevAscending, cmpStdDevDescending, cmpSizeAscending, cmpSizeDescending, cmpGradientAscending, cmpGradientDescending :: Compare (Bucket, BucketInfo) cmpNameAscending = comparing fst cmpNameDescending = flip cmpNameAscending +cmpNumberAscending (Bucket a, _) (Bucket b, _) = comparing (readMaybe @Word64 . T.unpack) a b <> compare a b +cmpNumberDescending = flip cmpNumberAscending cmpStdDevAscending = comparing (bucketStddev . snd) cmpStdDevDescending = flip cmpStdDevAscending cmpSizeAscending = comparing (bucketTotal . snd) diff --git a/src/Eventlog/Rendering/Bootstrap.hs b/src/Eventlog/Rendering/Bootstrap.hs new file mode 100644 --- /dev/null +++ b/src/Eventlog/Rendering/Bootstrap.hs @@ -0,0 +1,65 @@ +{-# LANGUAGE OverloadedStrings #-} +module Eventlog.Rendering.Bootstrap where + +import Eventlog.Rendering.Types + +import Control.Monad +import Data.String +import qualified Data.Text as T +import Text.Blaze.Html5 as H +import Text.Blaze.Html5.Attributes as A +import Text.Blaze.Internal (attribute) + +dataToggle :: AttributeValue -> Attribute +dataToggle = attribute "data-toggle" " data-toggle=\"" +{-# INLINE dataToggle #-} + +dataTarget :: AttributeValue -> Attribute +dataTarget = attribute "data-target" " data-target=\"" +{-# INLINE dataTarget #-} + +ariaControls :: AttributeValue -> Attribute +ariaControls = attribute "aria-controls" " aria-controls=\"" +{-# INLINE ariaControls #-} + +ariaExpanded :: AttributeValue -> Attribute +ariaExpanded = attribute "aria-expanded" " aria-expanded=\"" +{-# INLINE ariaExpanded #-} + +ariaLabel :: AttributeValue -> Attribute +ariaLabel = attribute "aria-label" " aria-label=\"" +{-# INLINE ariaLabel #-} + +navbar :: [TabGroup] -> Html +navbar tab_groups = do + H.ul ! A.id "vizTabs" ! class_ "nav nav-tabs" $ do + forM_ tab_groups $ \group -> do + case group of + SingleTab tab -> + H.li ! class_ "nav-item" $ + H.a ! A.id (toValue (tabIDToNavItemID (tabId tab))) + ! class_ (tabClasses tab) + ! href (toValue (tabIDToHref (tabId tab))) + ! dataToggle "tab" + ! dataTarget (toValue (tabIDToHref (tabId tab))) + $ fromString (tabName tab) + ManyTabs group_name tabs -> + H.li ! class_ "nav-item dropdown" $ do + H.a ! class_ "nav-link dropdown-toggle" + ! href "#" + ! dataToggle "dropdown" + $ fromString group_name + H.div ! class_ "dropdown-menu" $ + forM_ tabs $ \tab -> + H.a ! A.id (toValue (tabIDToNavItemID (tabId tab))) + ! class_ "dropdown-item" + ! href (toValue (tabIDToHref (tabId tab))) + ! dataToggle "tab" + ! dataTarget (toValue (tabIDToHref (tabId tab))) + $ fromString (tabName tab) + +tabClasses :: Tab -> AttributeValue +tabClasses tab = toValue $ T.intercalate " " $ + "nav-link" : + [ "active" | tabActive tab ] ++ + [ "not-available" | tabDisabled tab ] diff --git a/src/Eventlog/Rendering/Types.hs b/src/Eventlog/Rendering/Types.hs new file mode 100644 --- /dev/null +++ b/src/Eventlog/Rendering/Types.hs @@ -0,0 +1,65 @@ +{-# LANGUAGE OverloadedStrings #-} + +module Eventlog.Rendering.Types where + +import Data.Char +import Data.String +import qualified Data.Text as T +import Text.Blaze.Html5 + +data IncludeTraceData + = TraceData + | NoTraceData + +-- | Tab IDs must be usable as HTML and Javascript identifiers, so we allow a +-- limited selection of characters. This is enforced only at runtime by +-- 'mkTabID' and the 'IsString' instance, but that seems good enough for now. +newtype TabID = TabID T.Text + +instance IsString TabID where + fromString = mkTabID + +mkTabID :: String -> TabID +mkTabID s + | all valid s = TabID (T.pack s) + | otherwise = error $ "mkTabID: invalid tab ID: " ++ s + where + valid c = isAscii c && (isAlpha c || isDigit c || c == '_') + +tabIDToVizID :: TabID -> T.Text +tabIDToVizID (TabID t) = "vis" <> t + +tabIDToNavItemID :: TabID -> T.Text +tabIDToNavItemID (TabID t) = t <> "-tab" + +tabIDToTabID :: TabID -> T.Text +tabIDToTabID (TabID t) = t + +tabIDToHref :: TabID -> T.Text +tabIDToHref (TabID t) = "#" <> t + + +data TabGroup = ManyTabs String [Tab] + | SingleTab Tab + +data Tab = Tab { tabName :: String + , tabId :: TabID + , tabContent :: Maybe Html + , tabDocs :: Maybe Html + , tabActive :: Bool -- ^ Active by default? + , tabDisabled :: Bool + } + +mkTab :: String -> TabID -> Html -> Maybe Html -> Tab +mkTab name id_ content docs = Tab name id_ (Just content) docs False False + +mkUnavailableTab :: String -> TabID -> Html -> Tab +mkUnavailableTab name id_ docs = Tab name id_ Nothing (Just docs) False True + +mkOptionalTab :: String -> TabID -> (a -> Html) -> Maybe Html -> Html -> Maybe a -> Tab +mkOptionalTab name id_ mk_content docs no_docs mb = case mb of + Nothing -> mkUnavailableTab name id_ no_docs + Just v -> mkTab name id_ (mk_content v) docs + +noDocs :: Maybe Html +noDocs = Nothing diff --git a/src/Eventlog/Ticky.hs b/src/Eventlog/Ticky.hs --- a/src/Eventlog/Ticky.hs +++ b/src/Eventlog/Ticky.hs @@ -3,13 +3,11 @@ -- Functions for rendering ticky sample information {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE QuasiQuotes #-} -module Eventlog.Ticky where +module Eventlog.Ticky (tickyTab, renderTicky) where -import Eventlog.Types import qualified Data.Map as Map import Data.Word -import Data.String import qualified Data.Text as T --import Text.Blaze.Html import qualified Text.Blaze.Html5 as H @@ -17,38 +15,20 @@ ( preEscapedToHtml, toHtml, dataAttribute, - preEscapedStringValue, - stringComment, Html, (!), - AttributeValue, - body, - button, code, div, - docTypeHtml, - h1, - head, - link, - meta, script, - style, table, td, th, thead, - title, tr ) import Text.Blaze.Html5.Attributes as A - ( charset, class_, hidden, href, id, onclick, rel, src) -import Text.Blaze (customAttribute) -import Text.Blaze.Html.Renderer.String + ( class_, id ) -import Eventlog.Javascript -import Eventlog.Args -import Eventlog.AssetVersions -import Paths_eventlog2html -import Data.Version ( showVersion ) +import Eventlog.Types import Text.RawString.QQ import Data.Fixed import Control.Monad @@ -86,67 +66,8 @@ (sortBy (comparing tickySampleTime) samples) -jsScript :: String -> Html -jsScript url = script ! src (fromString $ url) $ "" -css :: AttributeValue -> Html -css url = link ! rel "stylesheet" ! href url - -htmlHeader :: Args -> Html -htmlHeader as = - H.head $ do - H.title "eventlog2html - Ticky Profile" - meta ! charset "utf-8" - if not (noIncludejs as) - then do - script $ preEscapedToHtml jquery - H.style $ preEscapedToHtml bootstrapCSS - script $ preEscapedToHtml bootstrap - H.style $ preEscapedToHtml datatablesCSS - H.style $ preEscapedToHtml datatablesButtonsCSS - script $ preEscapedToHtml datatables - script $ preEscapedToHtml datatablesButtons - script $ preEscapedToHtml datatablesHtml5 - H.style $ preEscapedToHtml imagesCSS - script $ preEscapedToHtml sparkline - else do - jsScript vegaURL - jsScript vegaLiteURL - jsScript vegaEmbedURL - jsScript jqueryURL - css (preEscapedStringValue bootstrapCSSURL) - jsScript bootstrapURL - css "https://fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic" - jsScript fancyTableURL - css (preEscapedStringValue datatablesCSSURL) - css (preEscapedStringValue datatablesButtonsCSSURL) - jsScript datatablesURL - jsScript datatablesButtonsURL - jsScript datatablesButtonsHTML5URL - jsScript sparklinesURL - script $ preEscapedToHtml datatablesEllipsis - -- Include this last to overwrite other styling - H.style $ preEscapedToHtml stylesheet - - -template :: Header -> Word64 -> Double -> Html -> Args -> Html -template header' total ticked_percen v as = docTypeHtml $ do - H.stringComment $ "Generated with eventlog2html-" <> showVersion version - htmlHeader as - body $ H.div ! class_ "container" $ do - H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - h1 $ H.a ! href "https://mpickering.github.io/eventlog2html" $ "eventlog2html" - - H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - "Options: " - code $ toHtml $ hJob header' - - H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - "Created at: " - code $ toHtml $ hDate header' - +tickyTab :: TickyProfileData -> Html +tickyTab (TickyProfileData total ticked_percen v) = do H.div ! class_ "row" $ do H.div ! class_ "column" $ do "Total Allocations: " @@ -154,19 +75,9 @@ H.div ! class_ "column cheader" $ do "Allocations Ticked (%): " code $ toHtml $ toHtml (render $ trunc (ticked_percen * 100)) - H.div ! class_ "row" $ do - H.div ! class_ "column" $ do - button ! class_ "tablink button-black" ! onclick "changeTab('table', this)" ! A.id "defaultOpen" $ "Table" - H.div ! class_ "row" $ do H.div ! A.id "table" ! class_ "tabviz" $ v - script $ preEscapedToHtml tablogic - -tickyTemplateString :: Header -> Word64 -> Double -> Html -> Args -> String -tickyTemplateString header' tot_allocs ticked_per ticky_table as = - renderHtml $ template header' tot_allocs ticked_per ticky_table as - -- Table rendering trunc :: Double -> Fixed E2 trunc = realToFrac @@ -178,7 +89,7 @@ -> Map.Map TickyCounterId (InfoTableLocStatus, (TickyCounter, AccumStats, Double)) -> Html renderTickyInfo with_ipe ticky_samples = do - H.table ! A.id "closure_table" ! A.class_ "table table-striped closureTable" ! A.hidden "true" $ do + H.table ! A.id "closure_table" ! A.class_ "table table-striped closureTable" $ do H.thead $ H.tr $ headFoot -- H.th "Profile" -- numTh "n" @@ -266,21 +177,6 @@ | cl_args == 0 = (2 + fvs) * 8 | otherwise = (1 + fvs) * 8 - - -renderSpark :: Int -> [(Double, Word64, Word64)] -> Html -renderSpark size vs = H.span ! A.class_ "linechart" - ! customAttribute "data-allocd" (H.preEscapedTextValue $ T.intercalate "," (map renderLine vs)) - ! customAttribute "data-entries" (H.preEscapedTextValue $ T.intercalate "," (map renderLineEntries vs)) - ! customAttribute "sparkChartRangeMax" (H.toValue max_alloc_n) - $ mempty - where - rdouble = T.pack . showFixed True . realToFrac @Double @(Fixed E2) - renderLine (x,w, _) = rdouble x <> ":" <> T.pack (show (w `Prelude.div` fromIntegral size)) - renderLineEntries (x,_, e) = rdouble x <> ":" <> T.pack (show e) - - max_alloc_n = last_allocd `Prelude.div` (fromIntegral size) - (_, last_allocd, _) = Prelude.head vs initTable :: Bool -> T.Text initTable ipe = diff --git a/src/Eventlog/Types.hs b/src/Eventlog/Types.hs --- a/src/Eventlog/Types.hs +++ b/src/Eventlog/Types.hs @@ -13,6 +13,7 @@ import Numeric import qualified Data.Text as T import qualified Data.Map as Map +import Text.Blaze.Html data Header = Header @@ -103,12 +104,18 @@ show (InfoTablePtr p) = "0x" ++ showHex p "" toItblPointer :: Bucket -> InfoTablePtr -toItblPointer (Bucket t) = +toItblPointer = either error id . toItblPointer_either + +toItblPointer_maybe :: Bucket -> Maybe InfoTablePtr +toItblPointer_maybe = either (const Nothing) Just . toItblPointer_either + +toItblPointer_either :: Bucket -> Either String InfoTablePtr +toItblPointer_either (Bucket t) = let s = drop 2 (T.unpack t) w64 = case readHex s of - ((n, ""):_) -> n - _ -> error (show t) - in InfoTablePtr w64 + ((n, ""):_) -> pure (InfoTablePtr n) + _ -> Left (show t) + in w64 data InfoTableLocStatus = None -- None of the entries have InfoTableLoc | Missing -- This one is just missing @@ -124,3 +131,15 @@ -> Map.Map k (InfoTableLocStatus, a) mkClosureInfo f b ipes = Map.mapWithKey (\k v -> (mkMissing $ Map.lookup (f k v) ipes, v)) b + + +data EventlogType = + EventlogType + { eventlogHeader :: Header + , eventlogHeapProfile :: Maybe HeapProfileData + , eventlogTickyProfile :: Maybe TickyProfileData + } + +data HeapProfileData = HeapProfileData Value (Maybe Value) (Maybe Html) + +data TickyProfileData = TickyProfileData Word64 Double Html diff --git a/src/Eventlog/Vega.hs b/src/Eventlog/Vega.hs --- a/src/Eventlog/Vega.hs +++ b/src/Eventlog/Vega.hs @@ -19,14 +19,15 @@ data VegaEntry = VegaEntry { x :: Double, y :: Double, k :: Int, c :: Text } deriving (Show, ToJSON, Generic) -bandsToVega :: Map Bucket (Int, BucketInfo) +bandsToVega :: (BucketInfo -> Text) + -> Map Bucket (Int, BucketInfo) -> (UArray Int Double, UArray (Int, Int) Double) -> [VegaEntry] -bandsToVega ks (ts, vs) = +bandsToVega bucket_name ks (ts, vs) = let (t1, tn) = bounds ts go (i, binfo) rs = go_1 ++ rs where - txt = shortDescription binfo + txt = bucket_name binfo go_1 :: [VegaEntry] go_1 = flip map [t1 .. tn] $ \t -> VegaEntry (ts ! t) (vs ! (i, t)) i txt diff --git a/src/Eventlog/VegaTemplate.hs b/src/Eventlog/VegaTemplate.hs --- a/src/Eventlog/VegaTemplate.hs +++ b/src/Eventlog/VegaTemplate.hs @@ -199,7 +199,7 @@ encodingHeapSelection c = encoding . tooltip [] - . color [MName "c", MmType Nominal, MScale [lineColourProperty c], MLegend [LValues (LStrings ["Heap Size", "Blocks Size", "Live Bytes"])]] + . color [MName "c", MmType Nominal, MScale [lineColourProperty c, SDomain (DStrings ["Heap Size", "Blocks Size", "Live Bytes"]) ]] . position X [PName "x", PmType Quantitative, PAxis [AxTitle "Time (s)"]] . position Y [PName "y", PmType Quantitative, PAxis [], PSort [ByFieldOp "k" Max]] @@ -260,10 +260,7 @@ . position Y ([PName "y" , PmType Quantitative , PAxis $ case ct of - Stacked -> [AxTitle "Allocation" - , AxFormat "s" - , AxTitlePadding 15.0 - , AxMaxExtent 15.0] + Stacked -> [AxTitle "Allocation", AxFormat "s" ] Normalized -> [AxTitle "Allocation (Normalized)", AxFormat "p"] StreamGraph -> [AxTitle "Allocation (Streamgraph)", AxLabels False, AxTicks False, AxTitlePadding 10.0] , PAggregate Sum