-
Notifications
You must be signed in to change notification settings - Fork 54
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Slingshot Switch Samplers Plus Config fixes #1363
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| libslingshot_switch_la_SOURCES = \ | ||
| slingshot_switch.c | ||
| libslingshot_switch_la_LIBADD = \ | ||
| $(top_builddir)/ldms/src/core/libldms.la \ | ||
| $(top_builddir)/lib/src/coll/libcoll.la \ | ||
| $(top_builddir)/ldms/src/sampler/libsampler_base.la | ||
| libslingshot_switch_la_LDFLAGS = \ | ||
| -no-undefined \ | ||
| -export-symbols-regex 'get_plugin' | ||
| libslingshot_switch_la_CPPFLAGS = @OVIS_INCLUDE_ABS@ | ||
|
|
||
| libslingshot_switch_1_la_SOURCES = \ | ||
| slingshot_switch_1.c | ||
| libslingshot_switch_1_la_LIBADD = \ | ||
| $(top_builddir)/ldms/src/core/libldms.la \ | ||
| $(top_builddir)/lib/src/coll/libcoll.la \ | ||
| $(top_builddir)/ldms/src/sampler/libsampler_base.la | ||
| libslingshot_switch_1_la_LDFLAGS = \ | ||
| -no-undefined \ | ||
| -export-symbols-regex 'get_plugin' | ||
| libslingshot_switch_1_la_CPPFLAGS = @OVIS_INCLUDE_ABS@ | ||
|
|
||
| pkglib_LTLIBRARIES = libslingshot_switch.la libslingshot_switch_1.la | ||
|
|
||
| dist_man7_MANS = Plugin_slingshot_switch.man |
131 changes: 131 additions & 0 deletions
131
ldms/src/sampler/slingshot_switch/Plugin_slingshot_switch.man
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| \" Manpage for Plugin_slingshot_switch | ||
| .\" Contact ovis-help@ca.sandia.gov to correct errors or typos. | ||
| .TH man 7 "17 Nov 2023" "v4" "LDMS Plugin slingshot_switch man page" | ||
|
|
||
| .SH NAME | ||
| Plugin_slingshot_switch - man page for the LDMS slingshot_switch plugin | ||
|
|
||
| .SH SYNOPSIS | ||
| Within ldmsd_controller or a configuration file: | ||
| .br | ||
| config name=slingshot_switch [ <attr> = <value> ] | ||
|
|
||
| .SH DESCRIPTION | ||
| With LDMS (Lightweight Distributed Metric Service), plugins for the ldmsd (ldms | ||
| daemon) are configured via ldmsd_controller or a configuration file. The | ||
| slingshot_switch plugin uses LDMS_V_LIST and LDMS_V_RECORD to provide slingshot | ||
| switch info via the dump_counters command run on the switch. | ||
|
|
||
| slingshot_switch and slingshot_switch_1 are the same plugins. There are two copies | ||
| to enable sampling at two different rates. | ||
|
|
||
| .SH CONFIGURATION ATTRIBUTE SYNTAX | ||
| The slingshot_switch plugin uses the sampler_base base class. This man page covers | ||
| only the configuration attributes, or those with default values, specific to the | ||
| this plugin; see ldms_sampler_base.man for the attributes of the base class. | ||
|
|
||
| .TP | ||
| .BR config | ||
| name=<plugin_name> | ||
| .br | ||
| configuration line | ||
| .RS | ||
| .TP | ||
| name=<plugin_name> | ||
| .br | ||
| This MUST be slingshot_switch (or slingshot_switch_1). | ||
| .TP | ||
| conffile=<conffile> | ||
| .br | ||
| Configuration file. First non-comment line must be "n=XXX" or "p=XXX,YYY,ZZZ". | ||
| p does not support ranges. Then variables or groups are listed one | ||
| per line. Comments lines can be in the file designated by the first line | ||
| being a '#'. | ||
|
|
||
| Arguments are those of dump_counters. | ||
| .TP | ||
| schema=<schema> | ||
| .br | ||
| Optional schema name. It is intended that the same sampler on different nodes | ||
| with different metrics have a different schema. If not specified, will | ||
| default to `slingshot_switch` (or `slingshot_switch_1`). | ||
| .RE | ||
|
|
||
| .SH BUGS (and future enhancements) | ||
| \[bu] This is still under development. | ||
|
|
||
| \[bu] Does not yet support ranges for the ports. | ||
|
|
||
| \[bu] Does not check for duplicate ports. | ||
|
|
||
| \[bu] Could have more robust handling of errors in the config file. | ||
|
|
||
| \[bu] MAX Ports is 70. | ||
|
|
||
| \[bu] Possibly can reduce unnecessary allocations in schema_metric_list. | ||
|
|
||
| \[bu] DEBUG messages are excessive, while this is in development. | ||
|
|
||
| \[bu] Need to check for extra whitespace in variable names. | ||
|
|
||
| \[bu] Only checking for the expected number of data output lines. Note that the output has at least one extra line. | ||
|
|
||
|
|
||
| .SH EXAMPLES | ||
| .PP | ||
| 1) Within ldmsd_controller or a configuration file: | ||
| .nf | ||
| load name=slingshot_switch | ||
| config name=slingshot_switch producer=vm1_1 instance=vm1_1/slingshot_switch conffile=/home/confffile.txt | ||
| start name=slingshot_switch interval=1000000 offset=0 | ||
| .fi | ||
| or the above with `slingshot_switch_1`. | ||
|
|
||
| conffile.txt can look something like: | ||
| .nf | ||
| #This can be a leading comment(s) | ||
| n=65 | ||
| # This can be an interspersed comment(s) | ||
| cfrx | ||
| #This is yet another comment(s) | ||
| .fi | ||
|
|
||
| .PP | ||
| 2) For confile sampler_ss.conf: | ||
| .nf | ||
| env SWITCH=$(hostname) | ||
| env COMPONENT_ID=1 | ||
|
|
||
| load name=slingshot_switch | ||
| config name=slingshot_switch producer=${SWITCH} component_id=${COMPONENT_ID} instance=${SWITCH}/port_metrics conffile=/rwfs/OVIS_slingshot-4.4.1/etc/ldms/slingshot_ldms_1s.txt | ||
| start name=slingshot_switch interval=1000000 | ||
| .fi | ||
|
|
||
| with slingshot_ldms_1s.txt: | ||
| .nf | ||
| p=0,1,2,3 | ||
| rfc_3635 | ||
| .fi | ||
|
|
||
| Command line to start ldmsd using the above: | ||
| .nf | ||
| /rwfs/OVIS_slingshot-4.4.1/etc/ldms# ldmsd -x sock:411 -c /rwfs/OVIS_slingshot-4.4.1/etc/ldms/sampler_ss.conf -m 2M -v QUIET | ||
| .fi | ||
|
|
||
| Then ldms_ls output: | ||
| .nf | ||
| x3000c0r42b0/port_metrics1: consistent, last update: Fri Nov 17 17:24:08 2023 +0000 [23292us] | ||
| M u64 component_id 1 | ||
| D u64 job_id 0 | ||
| D u64 app_id 0 | ||
| M record_type slingshot_port LDMS_V_RECORD_TYPE | ||
| D list<> slingshot_port_list | ||
| port (x) IfInDiscards (x) IfInErrors (x) IfInUnknownProtos (x) IfOutDiscards (x) IfOutErrors (x) Dot3HCInPauseFrames (x) Dot3HCOutPauseFrames (x) IfHCInOctets (x) IfHCInUcastPkts (x) IfHCInMulticastPkts (x) IfHCInBroadcastPkts (x) IfHCOutOctets (x) IfHCOutUcastPkts (x) IfHCOutMulticastPkts (x) IfHCOutBroadcastPkts (x) | ||
| 0 3135102637 0 3135102637 0 0 0 0 147205648261491 2495004354147 2471 0 1536216301 20234005 0 0 | ||
| 1 3135102637 0 3135102637 0 0 0 0 147204949152872 2494992497033 0 0 698442077 10279716 0 0 | ||
| 2 3135102637 0 3135102637 0 0 0 0 147205081815556 2494994737508 0 0 698345785 10272362 0 0 | ||
| 3 3135102637 0 3135102637 0 0 0 0 147205460019681 2495001153446 0 0 698845184 10277326 0 0 | ||
| .fi | ||
|
|
||
| .SH SEE ALSO | ||
| ldmsd(8), ldms_quickstart(7), ldmsd_controller(8), ldms_sampler_base(7) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The first "no" here should be "xno"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In line 432 you mean?