# pmrepconf

## NAME



           **pmrepconf** - create/edit a pmrep configuration file
    


## SYNOPSIS



           **pmrepconf**[**-crvV?**]  [**-D** _debug_] [**-d** _groupsdir_] [**-g** _grouptag_] [**-o**
           _option_] [**-h** _host_] _configfile_
    


## DESCRIPTION



           **pmrepconf** may be used to create and modify a generic configuration
           file for pmrep(1) and related utilities in the pmrep.conf(5)
           format.
    
           If _configfile_ does not exist, **pmrepconf** will create a generic
           configuration file with a set of discovered metrics in a [metrics]
           section.
    
           Once created, _configfile_ may be used with the **-c** option to
           pmrep(1) and related utilities such as **pcp2elasticsearch**(2) and
           **pcp2spark**(2).
    
           If _configfile_ does exist, **pmrepconf** will prompt for input from the
           user to enable or disable groups of related performance metrics.
    
           Group selection requires a simple **y**(yes) or **n**(no) response to
           the prompt **Log this group?**.
    
           Other responses at this point may be used to select additional
           control functions as follows:
    
           **m** Report the names of the metrics in the current group.
    
           **q** Finish with group selection (quit) and make no further
                     changes to this group or any subsequent group.
    
           **/**_pattern_  Make no change to this group but search for a group
                     containing _pattern_ in the description of the group or
                     the names of the associated metrics.
    
           When run from automated setup processes, the **-c** option is used to
           indicate that _pmrepconf_ is in auto-create mode and no interactive
           dialog takes place.  The output _configfile_ has an additional
           comment message and timestamp indicating this fact, so that it can
           be identified and subsequently updated using **-c** again.  This
           option is not appropriate for interactive use of the tool.
    
           More verbose output may be enabled with the **-v** option.
    


## SETUP GROUP FILES



           When an initial _configfile_ is created, the default specifications
           come from a set of group files below the _groupsdir_ specified with
           the **-d** option (the default _groupsdir_ is
           **$PCP_VAR_DIR/config/pmlogconf** which is most commonly correct, so
           the **-d** option is rarely used in practice).
    
           The directory structure and format of files below _groupsdir_ is
           shared with the pmlogconf(1) utility, and described in detail on
           that manual page.  When used by **pmrepconf** all interval settings
           are ignored.
    


## OPTIONS



           The available command line options are:
    
           **-c** Enable non-interactive, auto-create mode.
    
           **-d** _groupsdir_ , **--groups** =_groupsdir_
                Specify the path to the _groupsdir_ directory.
    
           **-g** _grouptag_ , **--group** =_grouptag_
                Query logging state for the specific group named _grouptag_.
    
           **-h** _host_ , **--host** =_host_
                Performance metrics source is pmcd(1) on _host_ , rather than on
                the default localhost.
    
           **-o** _option_ , **--option** =_option_
                Specify an option to be added to the [option] section of the
                generated pmrep.conf(5) file.  This command line option can
                be presented multiple times in order to added multiple lines
                in the [option] section.
    
           **-r** , **--reprobe**
                Reconsider every group for inclusion in the _configfile_.
    
           **-v** , **--verbose**
                Enable verbose mode.
    
           **-V** , **--version**
                Display version number and exit.
    
           **-?** , **--help**
                Display usage message and exit.
    


## PCP ENVIRONMENT



           Environment variables with the prefix **PCP_** are used to
           parameterize the file and directory names used by PCP.  On each
           installation, the file _/etc/pcp.conf_ contains the local values for
           these variables.  The **$PCP_CONF** variable may be used to specify an
           alternative configuration file, as described in pcp.conf(5).
    
           **pmrepconf** overrides any **$PCP_DERIVED_CONFIG** environment variable
           to an empty string, for performance reasons.
    
           **pmrepconf** honours the **$PMCD_WAIT_TIMEOUT** environment variable when
           probing and creating new **pmrep** configuration files.  It uses a
           default timeout value of 10 seconds for this, in the absence of an
           environment setting.
    


## DEBUGGING OPTIONS



           The **-D** or **--debug** option enables the output of additional
           diagnostics on _stderr_ to help triage problems, although the
           information is sometimes cryptic and primarily intended to provide
           guidance for developers rather end-users.  _debug_ is a comma
           separated list of debugging options; use pmdbg(1) with the **-l**
           option to obtain a list of the available debugging options and
           their meaning.
    


* * *