'\"macro stdmacro
.\"
.\" Copyright (c) 2014-2018,2021 Red Hat.
.\"
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; either version 2 of the License, or (at your
.\" option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
.\" or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\"
.\"
.TH PMDADS389 1 "PCP" "Performance Co-Pilot"
.SH NAME
\f3pmdads389\f1 \- 389 Directory Server PMDA
.SH DESCRIPTION
\fBpmdads389\fP is a Performance Metrics Domain Agent (PMDA) which
extracts live performance data from a running 389 Directory Server
instance.
.PP
See the Red Hat Directory Server Administration Guide for description
for each metric.
.SH INSTALLATION
\fBpmdads389\fP reads an optional configuration file
.IP
.PD 0
.RS +4
.IP \(bu 2
.I \f(CW$PCP_PMDAS_DIR\fP/ds389/ds389.conf
.RE
.PD
.PP
This file can contain overridden values (Perl code) for the settings
listed at the start of
.IR pmdads389.pl ,
namely:
.IP
.PD 0
.RS +4
.IP \(bu 2
LDAP server
.IP \(bu
bind DN
.IP \(bu
bind password
.IP \(bu
default search scope
.IP \(bu
default search base
.IP \(bu
default search filter
.IP \(bu
query interval
.IP \(bu
List of sources
.IP \(bu
List of attributes to display for each source
.RE
.PD
.PP
Please use the provided ds389.conf.example as a starting point.
Once this is setup, you can access the names and values for the
389 DS performance metrics by doing the following as root:
.sp 1
.RS +4
.ft B
.nf
# cd $PCP_PMDAS_DIR/ds389
# ./Install
.fi
.ft P
.RE
.sp 1
.PP
To uninstall, do the following as root:
.sp 1
.RS +4
.ft B
.nf
# cd $PCP_PMDAS_DIR/ds389
# ./Remove
.fi
.ft P
.RE
.sp 1
.PP
\fBpmdads389\fP is launched by \fBpmcd\fP(1) and should never be
executed directly.
The Install and Remove scripts notify \fBpmcd\fP(1) when the
agent is installed or removed.
.SH FILES
.TP
.I \f(CW$PCP_PMDAS_DIR\fP/ds389/ds389.conf.example
example configuration file for the \fBpmdads389\fP agent
.TP
.I \f(CW$PCP_PMDAS_DIR\fP/ds389/ds389.conf
configuration file for the \fBpmdads389\fP agent
.TP
.I \f(CW$PCP_PMDAS_DIR\fP/ds389/Install
installation script for the \fBpmdads389\fP agent
.TP
.I \f(CW$PCP_PMDAS_DIR\fP/ds389/Remove
undo installation script for the \fBpmdads389\fP agent
.TP
.I \f(CW$PCP_LOG_DIR\fP/pmcd/ds389.log
default log file for error messages from \fBpmdads389\fP
.SH PCP ENVIRONMENT
Environment variables with the prefix \fBPCP_\fP are used to parameterize
the file and directory names used by PCP.
On each installation, the
file \fI/etc/pcp.conf\fP contains the local values for these variables.
The \fB$PCP_CONF\fP variable may be used to specify an alternative
configuration file, as described in \fBpcp.conf\fP(5).
.SH SEE ALSO
.BR PCPIntro (1),
.BR ldapsearch (1),
.BR pmcd (1)
and
.BR ns-slapd (8).
