# pmlogredact

## NAME



           **pmlogredact** - remove sensitive information from PCP archives
    


## SYNOPSIS



           **pmlogredact**[**-vx?**]  [**-D** _debug_] [**-c** _config_] _inarch_ [_outarch_]
    


## DESCRIPTION



           Performance Co-Pilot (PCP) archives may contain a wealth of
           information collected from across all components of a system.
    
           Some of this information may be deemed sensitive outside the
           context of the original collection for analysis of system
           performance.  Examples of sensitive information might include user
           names, paths to user home directories (that may imply user names),
           hostnames, IP addresses, MAC addresses, command line arguments,
           process environment variables, etc.
    
           **pmlogredact** may be used to remove sensitive information before
           archives are shipped to another organization, or stored in another
           geography, or to meet regulatory or privacy compliance.  The
           output archive _outarch_ is the redacted version of the input
           archive _inarch_.
    
           **pmlogredact** is a thin wrapper around pmlogrewrite(1), and so the
           configuration files for **pmlogredact** follow the same syntax as the
           configuration files for pmlogrewrite(1).
    
           There are a default set of redaction rules in the
           _$PCP_VAR_DIR/config/pmlogredact/*_ files.  These rules remove some
           metrics, rewrite the instance domains of some metrics and rewrite
           the values of some metrics.  The **-x**(or **--exclude-std**) option may
           be used to **not** use the default set of rules.
    
           Additional (or alternative) configuration files may be specified
           with one or more **-c**(or **--config**) options, where each _config_ is
           either a file or a directory (implying all the files within that
           directory).
    
           The **-v**(or **--verbose**) option adds verbosity (and is passed direct‐
           ly to pmlogrewrite(1)).
    
           The **-?**(or **--help)** option displays a usage message and exits.
    


## FILES



           _$PCP_VAR_DIR/config/pmlogredact/*_
                default redaction rules
    


## PCP ENVIRONMENT



           Environment variables with the prefix **PCP_** are used to parameter‐
           ize the file and directory names used by PCP.  On each installa‐
           tion, the file _/etc/pcp.conf_ contains the local values for these
           variables.  The **$PCP_CONF** variable may be used to specify an al‐
           ternative configuration file, as described in pcp.conf(5).
    


## DEBUGGING OPTIONS



           The **-D** or **--debug** option enables the output of additional diagnos‐
           tics 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.
    


* * *