X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=b4fe2f967bd48dbee29f047ba867ab3590096e26;hb=5ee365a2a066bba5c21f510c3397a3ad6034d357;hp=93103437d914788dce36e68f3017f80bfacee59d;hpb=a6f29de68fe19614b0aa90e920e99d72cb0f4468;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 93103437..b4fe2f96 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -2017,6 +2017,7 @@ than those of other plugins. It usually looks something like this: + #PluginName "warehouse" Driver "mysql" Interval 120 DriverOption "host" "localhost" @@ -2198,6 +2199,11 @@ the daemon. Other than that, that name is not used. =over 4 +=item B I + +Use I as the plugin name when submitting query results from +this B. Defaults to 'dbi'. + =item B I Sets the interval (in seconds) in which the values will be collected from this @@ -2408,7 +2414,6 @@ B Coremask "0x1" MemoryChannels "4" - ProcessType "secondary" FilePrefix "rte" @@ -2431,7 +2436,7 @@ B =head3 The EAL block -=over 5 +=over 4 =item B I @@ -2439,10 +2444,6 @@ B Number of memory channels per processor socket. -=item B I - -The type of DPDK process instance. - =item B I The prefix text used for hugepage filenames. The filename will be set to @@ -2457,7 +2458,7 @@ single argument which specifies the name of the event. =head4 Link Status event -=over 5 +=over 4 =item B I @@ -2490,7 +2491,7 @@ value is false. =head4 Keep Alive event -=over 5 +=over 4 =item B I @@ -2526,7 +2527,6 @@ B Coremask "0x4" MemoryChannels "4" - ProcessType "secondary" FilePrefix "rte" SocketMemory "1024" @@ -2540,7 +2540,7 @@ B =head3 The EAL block -=over 5 +=over 4 =item B I @@ -2551,10 +2551,6 @@ core numbering can change between platforms and should be determined beforehand. A string containing a number of memory channels per processor socket. -=item B I - -A string containing the type of DPDK process instance. - =item B I The prefix text used for hugepage filenames. The filename will be set to @@ -2570,6 +2566,7 @@ sockets in MB. This is an optional value. =over 3 =item B I + A string containing the name of the shared memory object that should be used to share stats from the DPDK secondary process to the collectd dpdkstat plugin. Defaults to dpdk_collectd_stats if no other value is configured. @@ -3153,7 +3150,7 @@ See F for details. =item B I|I -If no configuration if given, the B-plugin will collect data from +If no configuration is given, the B-plugin will collect data from all interfaces. This may not be practical, especially for loopback- and similar interfaces. Thus, you can use the B-option to pick the interfaces you're interested in. Sometimes, however, it's easier/preferred @@ -5598,6 +5595,7 @@ plugin's documentation above for details. + #PluginName "warehouse" ConnectID "db01" Username "oracle" Password "secret" @@ -5620,6 +5618,11 @@ values submitted to the daemon. Other than that, that name is not used. =over 4 +=item B I + +Use I as the plugin name when submitting query results from +this B. Defaults to 'oracle'. + =item B I Defines the "database alias" or "service name" to connect to. Usually, these @@ -5973,6 +5976,7 @@ L. + PluginName "kingdom" Host "hostname" Port "5432" User "username" @@ -6294,6 +6298,11 @@ activating this option. The draw-back is, that data covering the specified amount of time will be lost, for example, if a single statement within the transaction fails or if the database server crashes. +=item B I + +Use I as the plugin name when submitting query results from +this B. Defaults to 'postgresql'. + =item B I Specify the plugin instance name that should be used instead of the database @@ -7182,6 +7191,115 @@ Since the configuration of the C is a little more complicated than other plugins, its documentation has been moved to an own manpage, L. Please see there for details. +=head2 Plugin C + +The I plugin is an AgentX subagent that receives and handles queries +from SNMP master agent and returns the data collected by read plugins. +The I plugin handles requests only for OIDs specified in +configuration file. To handle SNMP queries the plugin gets data from collectd +and translates requested values from collectd's internal format to SNMP format. +This plugin is a generic plugin and cannot work without configuration. +For more details on AgentX subagent see + + +B + + + + Plugin "memory" + Type "memory" + TypeInstance "free" + OIDs "1.3.6.1.4.1.2021.4.6.0" + + + IndexOID "IF-MIB::ifIndex" + SizeOID "IF-MIB::ifNumber" + + Instance true + Plugin "interface" + OIDs "IF-MIB::ifDescr" + + + Plugin "interface" + Type "if_octets" + TypeInstance "" + OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" + +
+ + +There are two types of blocks that can be contained in the +CPluginE snmp_agentE> block: B and B: + +=head3 The B block + +The B block defines a list OIDs that are to be handled. This block can +define scalar or table OIDs. If B block is defined inside of B
+block it reperesents table OIDs. +The following options can be set: + +=over 4 + +=item B I + +When B is set to B, the value for requested OID is copied from +plugin instance field of corresponding collectd value. If B block defines +scalar data type B has no effect and can be omitted. + +=item B I + +Read plugin name whose collected data will be mapped to specified OIDs. + +=item B I + +Collectd's type that is to be used for specified OID, e.Eg. "if_octets" +for example. The types are read from the B (see L). + +=item B I + +Collectd's type-instance that is to be used for specified OID. + +=item B I [I ...] + +Configures the OIDs to be handled by I plugin. Values for these OIDs +are taken from collectd data type specified by B, B, +B fields of this B block. Number of the OIDs configured +should correspond to number of values in specified B. +For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to +"rx" and "tx" values of "if_octets" type. + +=item B I + +The values taken from collectd are multiplied by I. The field is optional +and the default is B<1.0>. + +=item B I + +I is added to values from collectd after they have been multiplied by +B value. The field is optional and the default value is B<0.0>. + +=back + +=head3 The B
block + +The B
block defines a collection of B blocks that belong to one +snmp table. In addition to multiple B blocks the following options can be +set: + +=over 4 + +=item B I + +OID that is handled by the plugin and is mapped to numerical index value that is +generated by the plugin for each table record. + +=item B I + +OID that is handled by the plugin. Returned value is the number of records in +the table. The field is optional. + +=back + =head2 Plugin C The I listens to a UDP socket, reads "events" in the statsd