pmdasockets(1)

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

NAME

6       pmdasockets - sockets statistics PMDA
7

DESCRIPTION

9       pmdasockets  is a Performance Metrics Domain Agent (PMDA) which exports
10       metric values for current sockets on the local system.
11
12       This PMDA currently collects its data through  the  ss(8)  utility  and
13       requires  that  the  program  is  installed in order to function.  This
14       dependency may change in the future.
15

INSTALLATION

17       To install (enable) the sockets PMDA, do the following as root:
18
19           # cd $PCP_PMDAS_DIR/sockets
20           # ./Install
21
22       To uninstall (disable), do the following as root:
23
24           # cd $PCP_PMDAS_DIR/sockets
25           # ./Remove
26
27       pmdasockets is  launched  by  pmcd(1)  and  should  never  be  executed
28       directly.  The Install and Remove scripts notify pmcd(1) when the agent
29       is installed or removed.
30

FILTER CONFIGURATION

32       The string valued metric network.persocket.filter specifies  the  ss(1)
33       filter  to  be applied to optionally select socket states, IP addresses
34       and other options that  pmdasockets  will  collect  (to  populate  it's
35       instance  domain).   By  default,  this is state connected meaning only
36       sockets in the connected state will be included.  This can  be  changed
37       dynamically  by  using  pmstore(1)  to store a new filter string in the
38       network.persocket.filter metric.  E.g.
39
40           # pmstore network.persocket.filter "state all"
41
42       will change the filter to include sockets in all states.  Note that the
43       filter  string  is  not persisted across PMDA restarts or reboots (this
44       may change in the future).  For further details of  the  filter  syntax
45       and options, consult ss(8).
46

LOGGING CONFIGURATION

48       The    pmlogconf(1)    configuration    file    for    pmdasockets   is
49       $PCP_VAR_DIR/config/pmlogconf/networking/persocket-linux         (where
50       $PCP_VAR_DIR is typically /var/lib/pcp) which specifies to log all met‐
51       rics below network.persocket in the PCP namespace with a  default  sam‐
52       pling  interval  of 60 seconds.  The logging interval and metrics to be
53       logged can be changed by editing that  file  and  then  restarting  the
54       pmlogger service.  For details of the syntax, see pmlogconf(1).
55

METRICS

57       The  metrics and metadata supported by pmdasockets correspond to fields
58       reported by ss -noemitauOH and are also available as help text provided
59       by  the  PMDA,  e.g. to list all metrics, metadata descriptors and help
60       text:
61
62           # pminfo -fmdtT network.persocket
63
64       Note that the PMDA must be installed (enabled) for this command to work
65       correctly, see above.
66

PCP ENVIRONMENT

68       Environment variables with the prefix PCP_ are used to parameterize the
69       file and directory names used by PCP. On each  installation,  the  file
70       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
71       $PCP_CONF variable may be used to specify an alternative  configuration
72       file, as described in pcp.conf(5).
73