CereusReporting - User Guide - Urban
Contents
1. The title of the report This will only be displayed if the selected tree item is not a header Report Subtitle The default sub title of the report Eg Provided by your Support Report Footer 1 The default footer of the report U Print Header Footer to PDF Enables Disabled the printing of the Header and Footer Should be disabled when using a CoverPage Template Report Logo The company logo you want to be displayed on the PDF report The default logo is Jimages default lago png Needs to be a PNG file Use HOSTNAME IP in host only reports Displays Report for host hostname a b c d instead of the default report title 1 Graphs link back to cacti click on a graph in the PDF Report links back to the cacti page for that graph Cacti Host Server URL The Cacti Host Server URL to be used in the graph links WebService URL for nmidSmokeping graphs only Url to the webservice http path to plugins 1 nmidWebService webservice php wsdl PHP binary path 2 2 General CereusReporting Setting Report Title Provided by Network OQutsourcing de Print Header Footer to PDF images urban software logo png Use HOSTNHAME IP in host only reports Graphs link back to cacti http cacti network outsourcing de http cact_ network outsourcing de cacti plug Path to the php binary To use the default php installation in the systern path just enter usr bin php2. 108 73 When now going back to the report definition the table beneath the report definition will show the added graphs Local Graphs for this report ID Graph Name Host Description Local Graph Id 6 deadhost Ping Latency deadhost 5 Ly Choose an action Delete The order of the graphs can be changed using the arrows in the Order column CereusReporting User Guide 7 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com 3 2 Multi Reports The multi report type 15 the most advanced PDF report available only on the CereusReporting Corporate Edition The multi report type can contain the following data e Graph The cacti graphs e DSStats Chart Charts based on the dsstats extension e Smokeping Charts Charts based on the nmidSmokeping extension e Text Paragraphs containing text e Title A Sub Title explaining what comes next e Chapter A Chapter title including a page break before it e Availability Chart The new Availability Chart e SQLStatement A Table made up of a custom SQL query of the Cacti database Each of these items on a multi report can be rearranged 3 2 1 Adding items to a Multi Report There are two different ways of adding items to a graph report The simpliest method is by using the same functionality as available for a graph report Go to the Cacti graph tree view page select the graphs you want to add Cacti graphs Smokeping graphs and Avai
3. Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com Availability Start Tag lt 00 00 06 00 12 00 Aug 29 CereusReporting User Guide Urban Software de Copyright 2010 All Rights Reserved Daily Shutdown Er Template Design by SmileTemplates com 16 16
4. the template file In case you are not using a template you can supply a logo with the following data File Format PNG or JPEG File Size 800x200 width x height 4 3 Creating the CSS file The CSS file describes where the different parts of the report will be placed at The PDF document has the following layout 4 3 1 Header nmidSubHeader Title This is a Multi Report type example report nmidHeaderDesign Default Cacti Charts bim bem da CereusReporting User Guide 10 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com 4 3 2 Content nmicRepotDescriptian nmidNormalT ext Localhost Memory Usage nmidimage I ext T Kilobytes 19 15 19 26 19 25 19 34 18 15 19 40 19 45 19 50 19 55 20 00 From 2818 09 08 19 00 06 To 2010 09 09 20 00 00 82 El Free Current 8 Average 25 55 k Maximum 3 k 13 M B E Swap Current Average 2 13 H Maximum 2 nmidimageGraph 4 3 3 Footer nmidFooterText nmidFooterDesign 4 3 4 CSS File naming convention The CSS template file needs to comply with the following naming conventions Generic template name pdf css DIN Portrait name P A4 pdf css DIN A3 landscape name L A3 pdf css DIN A3 Portrait 3 name P A3 spor eee DIN A2 Landscape name L A2 pdf css DIN A2 Portrait nome A che Letter Landscape name L Letter pdf css Letter POrtrale name P Letter pdf css
5. 12 00 14 00 16 00 16 00 20 00 Total Polls Failed Polls Availability Host SLA 288 D 100 00 50 00 7 1 Availability Downtime Schedule Hosts can be scheduled for downtime by using the Availability Downtime Schedule functionality To go there click on Availability under the NMID menu nmidCreatePDF Availability Data Availaiblity Downtime Schedule shortDescription deviceld startTlime5tamp endTime5tamp decreaseAvailability Maintenance 28 Aug 10 23 00 29 Aug 10 12 00 Ly Choose an action Delete You can add a downtime by clicking on the Add link nmidCreatePDF Add Availability Data Availability Data update Device Name x n c RUE deadhost killermaschin dyndns org Change Availability Type z E The type of outtage change planned ki Short Description A short description which will be shown on the graph at the start and end Maintenance of the time frame Maintenance Long Description This is the long description of the outtage change Start Date Time Te 2 Date Time the the outtage change started 2010 08 28 23 00 End Date Time ear eee Ns NE Date Time the the outtage change finished 2010 08 29 12 00 Save You can select the Device an availabilty type planned emergency other and some detailed description The Short Description will be displayed in the graph with the Start Tag and End Tag appended to it CereusReporting User Guide 15 16
6. ABILITY MERCHANTABLE QUALITY OR NONINFRINGEMENT OF THIRD PARTY RIGHTS Some states or jurisdictions do not allow the exclusion of implied warranties so the above limitations may not apply to you LIMIT OF LIABILITY INNO EVENT WILL URBAN SOFTWARE DE BE LIABLE TO YOU FOR ANY LOSS OF USE INTERRUPTION OF BUSINESS OR ANY DIRECT INDIRECT SPECIAL INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND INCLUDING LOST PROFITS REGARDLESS OF THE FORM OF ACTION WHETHER IN CONTRACT TORT INCLUDING NEGLIGENCE STRICT PRODUCT LIABILITY OR OTHERWISE EVEN IF URBAN SOFTWARE DE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES Some states or jurisdictions do not allow the exclusion or limitation of incidental or consequential damages so the above limitation or exclusion may not apply to you CereusReporting User Guide 2 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com 2 Configuration 2 1 Availability Addon Settings NMID Availability Addon CORPORATE Edition License Expiry Date never Global SLA Threshold 85 The global SLA threshold This can be overwritten on a per Device basis Availability Chart Width 900 The width of the availability chart i Availability Chart Height 270 The height of the availability chart Add availaibility table to tree view This will add the availability data table after the tree view graph Add availaibil
7. User buide CereusReporting Corporate Edition 0 Version 1 0 e Unicode Support e JsStats Support e Reporting Engine Enhancements e Support Uptions e Guides far LactiEZ Ubuntu 9 10 Urban Sottware de 1 Introduction 1 1 About CereusReporting CereusReporting is a plugin designed to enhance the reporting functionality of the Cacti Network Monitoring solution nmidCreatePDF adds PDF report generation as well as email and report scheduling functionality of Cacti CereusReporting comes in 3 different editions The Free Edition with limited functionality a Professional Edition with added features and the Corporate Edition with support for DSStats Scheduling and other features 1 2 License By downloading or using a Urban Software de software product you are certifying that you are not a national of Cuba Iran Iraq Libya North Korea Sudan Syria or any country to which the United States embargoes goods and that you are not a person on the Table of Denial Orders the Entity List or the List of Specially Designated Nationals DISCLAIMER OF WARRANTIES YOU AGREE THAT URBAN SOFTWARE DE HAS MADE NO EXPRESS WARRANTIES TO YOU REGARDING THE SOFTWARE AND THAT THE SOFTWARE IS BEING PROVIDED TO YOU AS IS WITHOUT WARRANTY OF ANY KIND URBAN SOFTWARE DE DISCLAIMS ALL WARRANTIES WITH REGARD TO THE SOFTWARE EXPRESS OR IMPLIED INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE MERCHANT
8. ab click on Manage Reports in the NMID menu You will see the following table nmidCreatePDF Reports Reports Add No Reports exist 2 Click on the Add link This will open the Add Report page nmidCreatePDF Add Report Report new Report Name The name of the report Report Description The detailed describtion of this report This will be also be displayed in the report Report Template The POF Template to use for this report Uses default if left empty Report Cover Logo The CoverLogo of this report Uses default if left empty Report Type Select if this is a normal report a graph report or a Graph Heport special DSSTATs report Default Report Timespan The default report timespane of this report OnDemand Report Page Size Ad The default report timespane of this report cw Report Page Orientation Portrait The default report timespane of this report Report Graph Format Default The default report timespane of this report Report Output Format PDF The Qutput Format can be PDF or HTML Save e Report Name The name of the report This will also be used as the report title in the PDF document Report Description A description of the report The description will be added to the beginning of the report It can contain HTML code Report Template A report template provides a general design for a report Look at the Report Template chapter for further details C
9. abore et dolore magna aliquyam erat sed diam voluptua At 1ccusam justo duo dolores et ea rebum Stet clita kasd gubergren Ata sanctus est Lorem ipsum dolor sit amet Lorem ipsum dolor sit sadipscing elitr sed diam nonumy eirmod tempor invidunt ut Ore magna aliquyam erat sed diam voluptua At vero eos et accusam dolores et ea rebum Stet clita kasd gubergren no sea takimata Orem ipsum dolor sit amet Save Click Save to add the item to the report Please note for the mPDF Reporting Engine You need to add at least one Chapter item before you can add the Title item If you fail to do so the resulting PDF file will crash Adobe Reader when clicking on the Bookmarks 3 3 DSStats Reports DSStats reports can only contain the special DSStats type of graphs These graphs are generated by separate php files displaying some statistics provided by the DSStats plugin 3 3 1 Adding items to a DSStats report To add a DSStats item to the report click on the link of the table below the report A new page will be shown with thumbnails of the DSStats report graph Click on the Add to Report link to the left of the graph to add the item to the DSStats report nmidCreatePDF DSStats Graphs DSSTats Graphs Example Image Top I0 Average Hourly Umicaxt Top I0 Average Hourly Traffic Unicast in E Unicast Gul top10_hourly_unicast_stats php Add to Report Traffic iri Traffic ul topi0
10. and other temporary files will not be delted from the tmp directory for troubleshooting purposes PDF Module to use cereusReporting offers different PDF modules for creating the PDF reports The bundled FPDF engine creates PDF reports using standard based fast methods but lacks some additional functionality like Unicode support The mPDF engine offers more functionality with a slight performance decrease e Font Name The default font to use for the Reports Will be changed automatically when using unicode based reports Header Font Size The font size of the header e Page Size The default page size These can also be set on a per report setting e Page Orientation The default page orientation These can also be set on a per report setting Graph Format The default graph report format Can be single column default or a 2 Graphs 2 Columns based type CereusReporting User Guide 5 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com 3 Report Definition CereusReporting offers the ability to create pre defined PDF Reports This chapter will guide you through the process of creating the 3 different types of reports available for CereusReporting 3 1 Graph Reports Graph reports can only contain graphs They are offered within the Corporate edition for easy migration from the free to the corporate edition To create a new graph reports follow these steps 1 On the console t
11. ban Software de Copyright 2010 All Rights Reserved 13 16 Template Design by SmileTemplates com 6 Report Scheduling Reports can be scheduled for a one time creation or on a regular basis 6 1 Defining a report schedule In order to define a report schedule for a selected host go to NMID gt Manage Report Schedule On the Report Schedules table click on the Add link to the top right nmidCreatePDF Add Report Schedule Report Schedule new Schedule Name The name of this report schedule Daily Multi Graph Repor Report The name of the report to schedule Multi Report i This is the daily summary of our Multi Report Report Schedule Description The detailed describtion of this report This will be also be displayed in the report Report Schedule is Recurring d This report will be scheduled on a recurring basis This is a recurring report schedule Recurring frequence This is the recurring frequence the report will be created daily This is only valid for recurring schedules Report Schedule Jv Date Time the report will be scheduled 2010 03 03 00 00 support urban software de requests urban software de Report Recipients The email address s of the report recipients Separate the emails with a Semi Colon Report Schedule Status Report schedules can be disabled 0O This report schedule is active Archive Report v The report will be archived after c
12. dds a default header footer to the PDF report Report Logo A Logo which can be added to the reports These can be defined globally here on a per tree base or per report Use HOSTNAME IP in host only reports This will use a Report for hostname ip as the report title CereusReporting User Guide 4 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com Graphs link back to cacti Users can click on the graphs in the PDF report to directly go to the specific graph within Cacti e Cacti Host Server URL The host Server url to be used within the PDF report Should be in the format http server e WebService URL When using the nmidWebService plugin provide the URL to it here PHP binary path The full path to the PHP binary e g usr bin php Archive Directory The directory where archived reports are to be stored Needs to be writeable by the webserver and Cacti user GZip binary path The full path to the gzip binary e g bin gzip If not set archived reports will not be gziped e Scheduler being used There are two scheduler available For smaller reports the poller based scheduler can be used For large reports it is recommended to use the cron based scheduler e Parallel Threads for Graph Retrieval Graph retrieval 1s threaded You can choose the number of concurrent threads being used Debugging mode When enabling the debugging mode graphs
13. ereusReporting User Guide 6 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com Report Cover Logo The Report Cover Logo can be your company logo or any other image you want to include in the header of the report If you use a report template this should be set to images transparent_logo png Report Type The report type can be Graph Report Multi Report or DSStats Report Default Report Timespan The default report timespan is a predefined time span of the report e g display 1 hour graphs Report Output Format When using the mPDF engine the report output formant can be PDF or HTML For the FPDF engine the report format can only be PDF 3 1 1 Adding Graphs to the report When the report is saved the report will show up in the drop down list of the normal Cacti graph tree view page 8 AddtoRepor 10 Ad Portrait Default Include Sub Leafs 7 Ia Please choose select the report to which graphs should be added You can then add selected graphs by clicking on the checkbox next to the graph only default Cacti graphs can be added to a graph report Clicking on the to Report button will add the graphs to the report deadhost Ping Latency 100 z gt 30 milliseconds B Sun 00 00 Sun 12 00 Mon 00 00 Mon 12 06 From 2010 08 28 22 31 48 To 2010 08 30 22 31 48 Current 18 60 Average 29 49 Maximum
14. hourly traffic stats php Add to Report Go back to report Once you are done click on the Go back to report link at the bottom of the page CereusReporting User Guide 9 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com 4 Report Templates Report templates are a combination of special PDF template files logo images and CSS style definitions The PDF template files can be created with any application but need to be stored as PDF files and follow a specific naming standard 4 1 Creating a PDF template file The PDF template is a one or two page PDF document that can be created by using any application like Word OpenOffice Writer or TextMaker A two page document template starts with the main page as the main cover for the report The second page will be repeated until the end of the generated report The PDF document can contain text graphs images e g Logos or Background images or anything else that you want to be part of the final report 4 1 1 Naming conventions The pdf template file needs to comply with the following naming conventions Landscape Landscape opis Landscape name P A2 post name L A4 2 4 name L A3 name P A3 name L A2 Landscape name L Letter pdf Portrait name P Letter pdf name is the name of the PDF template to use 4 2 Creating a logo image Ideally the Logo should be part of
15. itions To use the backup and restore functionality go to NMID gt Backup Restore You will see a screen showing all your defined reports nmidCreatePDF Report Backup Report Backup Reportid Name Report Type Sample My description Graph Report Multi Report This is a Multi Report type example report Multi Report D55tats Report This is a OSStats type Report DS5S5tats Report Choose an action Backup T Report Restore No Reports exist 5 1 Report Backup In order to backup a report simply select it using the checkbox to the right of it and click the Go button A XML based backup file will be placed in the backup folder of the CereusReporting plugin directory 5 2 Report Import Restore A report can be restored by simply selecting it from the list of available backup files and clicking on the Go button Report Restore File Report Type Schedule Type E This is a Multi Report type example report Multi Report 1 Choose an action Restore A restored report will always be created as a new report Same name but a different report id so the old existing report definition will not be overwritten by a restore Please note Backup files do contain the unique ids of the containing graphs Graphs not existing any more are still restored and need to be manually removed from the report after the restore Multi_Report xml Multi Report L CereusReporting User Guide Ur
16. ity table to tree view Max Raw data to store Time in seconds to store the data e g 7 days 60 seconds 60 minutes 24hours 7 604800 days 604800 Start tag Siart Start tag for the availability data display This will be appended to the cata set on the graph End Tag End Global SLA Threshold The global SLA threshold defines a threshold displayed on each availability chart The SLA threshold can be overwritten on a per device basis e Availibility Chart Width The width in pixel of the availability chart e Availability Chart Height The height in pixel of the availability chart e Add availability table to the tree view Displays the availability data as a table beneath the availability chart e Max Raw data to store The time in seconds to store the polling data After this time the availability data will be deleted e Start Tag The start tag will be displayed as a suffix to a Availaiblity Downtime Schedule starting point End Tag The end tag will be displayed as a suffix to a Availaiblity Downtime Schedule end point _ Availability Repor 100 nc at lt Availability Daily Shutdown El t 00 00 06 00 12 00 Aug 29 CereusReporting User Guide 3 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com NMID Create PDF Report General CORPORATE Edition License Expiry Date never Report Title
17. laiblity Charts can be added select the Multi Report from the drop down box and click the Add to Report button For any other item you need to edit the report Go to the Manage Reports page and click on the multi report where you want to add an item Report Page Orientation The default raport timespane of this report Portrait I Report Graph Format Default The default report timespane of this report T Report Output Format PDF The Output Format can be PDF or HTML Items for this report Type Description graph Localhost Localhost Memory Usage Choose an action Delete 5 Click on the Add link of the Items for this report table to add a new item You can select the item you want to add from the drop down box A description of each item is shown to the left of the text box CereusReporting User Guide 8 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com nmidCreatePDF Update Multi Report Item The item type Item Data The data of the item dsstats graph local graph id smokeping dsstats dsstats php file title smokeping host id title text some string title some string Chapter some string availability availability host id salstatement sglstatement select host as 2c CL Hostname id as HostId from hosts title dolor Sit amet consetetur sadipscing elitr sed diam nonumy eirmod mt ut l
18. php here Archive Directory achive Archive directory for storing the PDF Reports Path to the GZip binary Archived reports will be gziped if this is set Gzip Scheduler being used The poller is fine for small reports but it is still recommended to use cron or windows Poller scheduling Parallel Threads for Graph Rertieval Threads The number of parallel processes for retrieving generating the graphs for the PDF report Debuging mode Enable Disable the debug mode for defined on demand reports Enable Do not delete tmp Enabled files PDF Module to use Choose which PDF Engine you want to use FPDF Font Name Choose which font you want to use Arial Header Fant Size 10 Choose which font size you want to have your header in Page Size Ad S Choose which page format you want to have your PDF reports in Page Orientation Landscape or Portrait Graph Format Report Title The Report Title will be displayed at the top of each report 1f no other report name option is available This option will only be used when using the on demand reports Report Subtitle The Report Subtitle will always be added to all reports e Report Footer The Reports will always be added to all reports Can be a copyright information or any other text e Print Header Footer to PDF If using CSS based report templates this should be checked off otherwise a
19. reation Archive this report after creation Save The above example schedules our Multi Report report on a daily basis Daily reports will always be send out at 00 00 The Report Schedule defines the first starting time of the report E g a report schedule can be defined near a moths end but the Report Schedule 15 set to the first day of the next months Daily reports will the be send out no sooner than the beginning of the next month The timeframe of the graphs is defined in the Report Definition as the Default Report Timeframe So it is possible to create a daily report which will contain only the last hour of data Please note For scheduled reports the Default Report Timeframe should never be set to On Demand It is recommended to use the same time frame as the Recurring frequence E g for daily set the timefram of the report to I Day CereusReporting User Guide 14 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com 7 Availability Charts Availability charts display the hosts device status information in a graphical way Cacti does store the number of successful and unsuccessful polls as a total value The availability charts addon stores the data in a way that it can be presented as a time based chart Availability Report Localhost 127 0 0 1 E Availability 9 40 20 22 00 00 00 02 00 04 00 06 00 08 00 10 00
20. where name is the name of the PDF template to use 4 4 Adding a report template to a report Let us assume you created the following files for a DIN A4 Portrait report template nmidCreatePDF pdf css nmidCreatePDF P A4 pdf The following settings need to be entered to the report definition page CereusReporting User Guide 11 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com Report Template The POF Template to use for this report Uses default if left empty templates nmidCreatePDF pdf Report Cover Logo The CoverLogo of this report Uses default if left empty images transparent logo png Report Type Select if this is a normal report a graph report or a special DSSTATs repart Multi Report Default Report Timespan The default report timespane of this report OnDemand Report Page Size AA The default report timespane of this report Report Page Orientation The default report timespane of this report Portrait Although the file templates nmidCreatePDF pdf does not exist it is used as the basis to automatically choose the correct pdf and css template file based on the Report Page Size and Report Page Orientation definition CereusReporting User Guide 12 16 Urban Software de Copyright 2010 All Rights Reserved Template Design by SmileTemplates com 5 Report Backup Restore CereusReporting has the ability to backup and restore report defin
Download Pdf Manuals
Related Search