Project

General

Profile

Guide » Configuration »

SysScope Configuration - Directive Index

Comment

Type: Simple

Syntax:

 Comment <text>

Description::
Prints the comment text on the graph. Colons need to be escaped. Can contain the newline character \n.

Context::
Graph

Example:

 Comment This is a comment\n
 Comment this is another comment on line 2

Consolidate

Type: Special

Syntax:

 Consolidate <variable_name> <RPN_expression>

Description: This is exactly the same as rrdgraph's CDEF option.

Context: Graph

Example:

 Consolidate total p1,p2,+,p3,+

DataSource

Type: Special

Syntax:

 DataSource <variable_name> <rrd_path(RRD)>::<data_source_name(DS)>::<round_robin_archive(RRA)>

Description: This is used to define a data source.

Context: Graph

Example:

 DataSource lavg_shortterm /var/lib/collectd/rrd/load/load.rrd::shortterm::AVERAGE
 DataSource lavg_longterm @RRDBase@/load/load.rrd::longterm::AVERAGE

DrawGraph

Type: Special

Syntax:

 DrawGraph <variable_name> <graph_type>::<color>::<legend_label>

Description: This instructs rrdgraph to draw a graph for <variable>.

Context: Graph

Example:

 DrawGraph lavg_short AREA::#64dfe8::Short-term

Gprint

Type: Special

Syntax:

 Gprint <variable>::<GPRINT_format>

Description: This adds <variable> on the graph in the specified format. The item is placed after the legend details.

Context: Graph

Example:

 Gprint lavg_short::%10.2lf%

Hostname

Type: Simple

Syntax:

 Hostname <hostname>

Description: Set the hostname manually. If missing, a hostname is automatically determined. Can be FQDN or any simple name. The variable @Hostname@ can be used in the value of the @RRDBase@ directive.

Context: GLOBAL

Example:

 Hostname server.example.org

Hrule

Type: Simple

Syntax:

 Hrule <text>

Description: The same as the HRULE option of rrdgraph. Prints a horizontal rule at value.

Context: Graph

Example:

 Hrule 4000#000000:Nominal Fan Speed

Include

Type: Simple

Syntax:

 Include <path>

Description: The include directive instructs the configuration file parser to import the additional configuration file from <path>.

Context: any

Example:

 Include /etc/sysscope.d/memory.conf
 Include /etc/sysscope.d/*.conf

Legend

Type: Simple

Syntax:

 Legend On|Off

Default:

 Legend On

Description: This directive accepts an On or Off value and instructs RRDtool not create a legend for any data source in the current graph. If omitted, a legend is always generated.

Context: Graph

Example:

 Legend Off

LegendColumns

Type: Simple

Syntax:

 LegendColumns Last,Min,Avg,Max,95th

Default:

 LegendColumns Last,Min,Avg,Max,95th

Description: LegendColumns accepts a comma-delimited list of items that should be displayed in the legend details. If the legend has been disabled, then the presence of this directive has no effect on the graph.

Context: Graph

Example:

 LegendColumns Min,Max

LegendFormat

Type: Simple

Syntax:

 LegendFormat <GPRINT_format>

Default:

 LegendFormat %9.3lf

Description: This determines the format of all LegendColumns items. Please read the RRDtool documentation for more information on the format specification.

Context: Graph

Example:

 LegendFormat %10.2lf
 LegendFormat %6.2lf %sb

Logfile

Type: Simple

Syntax:

 Logfile <path>

Description: A log is always recorded, unless it is disabled with the relevant command line option.

Context: GLOBAL

Example:

 Logfile /var/log/sysscope.log

LogLevel

Type: Simple

Syntax:

 LogLevel debug|info|warning|error|critical

Default:

 LogLevel info

Description: This directive determines the amount of information that will be recorded in the log file. The value can be one of debug, info, warning, error, critical. debug will cause the logger to log messages of the greatest detail.

Context: GLOBAL

Example:

 LogLevel debug

Option

Type: Simple

Syntax:

 Option <stripped_rrdgraph_option> [<value>]

Description: This directive accepts any valid RRDgraph option. The -- part should be stripped from the option name before it can be used in this directive.

Context: Template, Graph

Example:

 Option base 1024

OptionCacheDir

Type: Simple

Syntax:

 OptionCacheDir <path>

Description: The path to a directory where a cache with rrdgraph options will be saved. This is only required if dynamic pages are generated.

Context: GLOBAL

Example:

 OptionCacheDir /var/cache/sysscope/

RawOption

Type: Simple

Syntax:

 RawOption <rrdgraph_option> [<value>]

Description: This directive accepts any valid RRDgraph option like Option, but in this case it is not necessary to strip the -- part of the option name. In short the option should be used in the exact form it would be passed to rrdgraph.

Context: Template, Graph

Example:

 RawOption --base 1024

RRDBase

Type: Simple

Syntax:

 RRDBase <path>

Description: This directive is completely optional and the only reason it exists is to facilitate the inclusion of the RRD path inside the DataSource directive. It is available only inside a Section and whenever it is set, you can use @RRDBase@ anywhere in the path of the RRD inside the DataSource directive. Additionally, the @RRDBase@ directive may contain the special @Hostname@ variable, which is expanded to the value of the Hostname directive of the global section or to the autocalculated FQDN hostname in case the the Hostname directive has not been set in the global section.

Context: Section

Example:

 <Section ...>
   RRDBase /var/lib/collectd/rrd
   # Using the @Hostname@ variable
   #RRDBase /var/lib/collectd/@Hostname@/rrd
   <Graph ...>
     ...
     DataSource mem @RRDBase@/memory/memory-used.rrd::value::AVERAGE
     ...
   </Graph>
 </Section>

OutputDir

Type: Simple

Syntax:

 OutputDir <path>

Description: Where the HTML and image file will be stored.

Context: GLOBAL

Example:

 OutputDir /var/lib/sysscope/www/

TemplateName

Type: Simple

Syntax:

 TemplateName <template_name> or None

Description: Defines a template name that should be used for the current graph. If a template is not defined, then the first template configuration that was read from the config file will be used.

Context: Graph

Example:

 TemplateName Basic

VDataSource

Type: Special

Syntax:

 VDataSource <variable_name> <RPN_expression>

Description: Virtual data source definition. This is exactly the same as the VDEF rrdgraph option.

Context: Graph

Example:

 VDataSource t_max t,MAXIMUM
 VDataSource p_95th p,95/PERCENT

VerticalLabel

Type: Simple

Syntax:

 VerticalLabel <label>

Description: Sets a label for the Y-axis.

Context: Graph

Example:

 VerticalLabel connections

Vrule

Type: Simple

Syntax:

 Vrule <text>

Description: The same as the VRULE option of rrdgraph. Prints a vertical rule at the specified time.

Context: Graph

Example:

 Vrule 3600#000000:Low Cost Electrical Power