1PMLOGREDACT(1)              General Commands Manual             PMLOGREDACT(1)
2
3
4

NAME

6       pmlogredact - remove sensitive information from PCP archives
7

SYNOPSIS

9       pmlogredact [-vx?]  [-c config] inarch [outarch]
10

DESCRIPTION

12       Performance Co-Pilot (PCP) archives may contain a wealth of information
13       collected from across all components of a system.
14
15       Some of this information may be deemed sensitive outside the context of
16       the  original  collection for analysis of system performance.  Examples
17       of sensitive information might include user names, paths to  user  home
18       directories  (that  may imply user names), hostnames, IP addresses, MAC
19       addresses, command line arguments, process environment variables, etc.
20
21       pmlogredact may be used to remove sensitive information before archives
22       are shipped to another organization, or stored in another geography, or
23       to meet regulatory or privacy compliance.  The output  archive  outarch
24       is the redacted version of the input archive inarch.
25
26       pmlogredact  is  a thin wrapper around pmlogrewrite(1), and so the con‐
27       figuration files for pmlogredact follow the same syntax as the configu‐
28       ration files for pmlogrewrite(1).
29
30       There  are  a  default  set of redaction rules in the $PCP_VAR_DIR/con‐
31       fig/pmlogredact/* files.  These rules remove some metrics, rewrite  the
32       instance  domains  of  some metrics and rewrite the values of some met‐
33       rics.  The -x (or --exclude-std) option may be used to not use the  de‐
34       fault set of rules.
35
36       Additional  (or  alternative) configuration files may be specified with
37       one or more -c (or --config) options, where each  config  is  either  a
38       file or a directory (implying all the files within that directory).
39
40       The  -v (or --verbose) option adds verbosity (and is passed directly to
41       pmlogrewrite(1)).
42
43       The -?  (or --help) option displays a usage message and exits.
44

FILES

46       $PCP_VAR_DIR/config/pmlogredact/*
47            default redaction rules
48

PCP ENVIRONMENT

50       Environment variables with the prefix PCP_ are used to parameterize the
51       file  and  directory names used by PCP.  On each installation, the file
52       /etc/pcp.conf contains the  local  values  for  these  variables.   The
53       $PCP_CONF  variable may be used to specify an alternative configuration
54       file, as described in pcp.conf(5).
55

SEE ALSO

57       pmlogrewrite(1), pcp.conf(5) and pcp.env(5).
58
59
60
61Performance Co-Pilot                  PCP                       PMLOGREDACT(1)
Impressum