diff --git a/ldms/man/Makefile.am b/ldms/man/Makefile.am index 2a76a6152..889decbec 100644 --- a/ldms/man/Makefile.am +++ b/ldms/man/Makefile.am @@ -35,7 +35,8 @@ Plugin_shm_sampler.man \ Plugin_store_papi.man \ Plugin_store_app.man \ ldmsd_decomposition.man \ -Plugin_store_kafka.man +Plugin_store_kafka.man \ +ldmsd_peer_daemon_advertisement.man if ENABLE_SLURMTEST dist_man8_MANS += pll-ldms-static-test.man diff --git a/ldms/man/ldmsd_sampler_advertisement.man b/ldms/man/ldmsd_peer_daemon_advertisement.man similarity index 75% rename from ldms/man/ldmsd_sampler_advertisement.man rename to ldms/man/ldmsd_peer_daemon_advertisement.man index 83bf09b55..864a15ed8 100644 --- a/ldms/man/ldmsd_sampler_advertisement.man +++ b/ldms/man/ldmsd_peer_daemon_advertisement.man @@ -1,9 +1,8 @@ -\" Manpage for ldmsd_sampler_advertisement -.TH man 7 "27 March 2024" "v5" "LDMSD Sampler Advertisement man page" +a prdcr_listenv 2024" "v5" "LDMSD Peer Daemon Advertisement man page" .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""/. .SH NAME -ldmsd_sampler_advertisement - Manual for LDMSD Sampler Advertisement +ldmsd_peer_daemon_advertisement - Manual for LDMSD Peer Daemon Advertisement .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""/. .SH SYNOPSIS @@ -47,30 +46,35 @@ ldmsd_sampler_advertisement - Manual for LDMSD Sampler Advertisement .SH DESCRIPTION -LDMSD Sampler Discovery is a capability that enables LDMSD automatically add -producers that its hostname matches a given regular expression. The feature -eliminates the need for manual configuration of sampler hostname in the -aggregator configuration file. +LDMSD Peer Daemon Advertisement is a capability that enables LDMSD to +automatically add producers for advertisers whose hostname matches a regular +expression or whose IP address is in a range. The feature reduces the need for +manual configuration of producers in configuration files. -Admins specify the aggregator hostname and the listening port in sampler +Admins specify the aggregator's hostname and listening port in the peer's configuration via the \fBadvertiser_add\fR command and start the advertisement -with the \fBadvertiser_start\fR command. The samplers now advertise their +with the \fBadvertiser_start\fR command. The peer daemon advertises their hostname to the aggregator. On the aggregator, admins specify a regular -expression to be matched with sampler hostname via the \fBprdcr_listen_add\fR -command. The \fBprdcr_listen_start\fR command is used to tell the aggregator to -automatically add producers corresponding to a sampler of which the hostname -matches the regular expression. - -The auto-generated producers is of the ‘advertised’ type. The producer name is -the same as the name given at the \fBadvertiser_add\fR line in the sampler -configuration file. LDMSD automatically starts them; however, admins need to -stop them manually by using the command \fBprdcr_stop\fR or -\fBprdcr_stop_regex\fR. They can be restarted by using the command +expression to be matched with the peer hostname or an IP range that the peer IP +address falls in via the \fBprdcr_listen_add\fR command. The +\fBprdcr_listen_start\fR command is used to tell the aggregator to +automatically add producers corresponding to a peer daemon whose +hostname matches the regular expression or whose IP address falls in the IP +range. If neither a regular expression nor an IP range is given, the aggregator +will create a producer upon receiving any advertisement messages. + +The auto-generated producers are of the ‘advertised’ type. The producer name is +the same as the name given at the \fBadvertiser_add\fR or +\fBadvertiser_start\fR line in the peer daemon configuration file. LDMSD +automatically starts the advertised producers, unless the 'disable_start' +attribute is given on the \fBprdcr_listen_add\fR line. The advertised +producers need to be stopped manually by using the command \fBprdcr_stop\fR or +\fBprdcr_stop_regex\fR. They can be restarted by using the command \fBprdcr_start\fR or \fBprdcr_start_regex\fR. The description for each command and its parameters are as follows. -**Sampler Side Commands** +**Peer Side Commands** \fBadvertiser_add\fR adds a new advertisement. The parameters are: .RS @@ -125,31 +129,31 @@ Advertisement name .PP **Aggregator Side commands** -\fBprdcr_listen_add\fR adds a regular expression to match sampler advertisements. The parameters are: +\fBprdcr_listen_add\fR adds a prdcr_listen. The parameters are: .RS .IP \fBname\fR=\fINAME String of the prdcr_listen name. .IP \fB[disable_start\fR=\fITRUE|FALSE\fB] True to tell LDMSD not to start producers automatically .IP \fB[regex\fR=\fIREGEX\fB] -Regular expression to match with hostnames in sampler advertisements -.IP \fBip\fR=\fICIDR\fB] -IP Range in the CIDR format either in IPV4 or IPV6 +Regular expression to match with hostnames of peer daemons +.IP \fB[ip\fR=\fICIDR\fB] +IP Range in the CIDR format either in IPV4 .RE -\fBprdcr_listen_start\fR starts accepting sampler advertisement with matches hostnames. The parameters are: +\fBprdcr_listen_start\fR starts accepting peer advertisement with matches hostnames. The parameters are: .RS .IP \fBname\fR=\fINAME Name of prdcr_listen to be started .RE -\fBprdcr_listen_stop\fR stops accepting sampler advertisement with matches hostnames. The parameters are: +\fBprdcr_listen_stop\fR stops accepting peer advertisement with matches hostnames. The parameters are: .RS .IP \fBname\fR=\fINAME Name of prdcr_listen to be stopped .RE -\fBprdcr_listen_del\fR deletes a regular expression to match hostnames in sampler advertisements. The parameters are: +\fBprdcr_listen_del\fR deletes a prdcr_listen. The parameters are: .RS .IP \fBname\fR=\fINAME Name of prdcr_listen to be deleted diff --git a/ldms/src/ldmsd/ldmsd_request.c b/ldms/src/ldmsd/ldmsd_request.c index e7fe4b90f..667d249da 100644 --- a/ldms/src/ldmsd/ldmsd_request.c +++ b/ldms/src/ldmsd/ldmsd_request.c @@ -300,7 +300,7 @@ static int auth_del_handler(ldmsd_req_ctxt_t reqc); static int set_default_authz_handler(ldmsd_req_ctxt_t reqc); static int cmd_line_arg_set_handler(ldmsd_req_ctxt_t reqc); -/* Sampler Advertisement */ +/* Peer Daemon Advertisement */ static int prdcr_listen_add_handler(ldmsd_req_ctxt_t reqc); static int prdcr_listen_del_handler(ldmsd_req_ctxt_t reqc); static int prdcr_listen_start_handler(ldmsd_req_ctxt_t reqc);