lib/mcollective/locales/en.yml

   1 en:
   2   PLMC1:
   3     example: "The Marionette Collective version 2.2.2 started by /usr/bin/mco using config file /etc/mcollective/client.cfg"
   4     expanded: "This message gets logged each time MCollective reads it's config file.  Generally this only happens once per process.  It shows the version, process name and config file as a simple debugging aid"
   5     pattern: "The Marionette Collective version %{version} started by %{name} using config file %{config}"
   6   PLMC10:
   7     example: "Failed to handle message: RuntimeError: none.rb:15:in `decodemsg': Could not decrypt message "
   8     expanded: |-
   9         When a message arrives from the middleware it gets decoded, security validated and then dispatched to the agent code.
  10
  11         There exist a number of errors that can happen here, some are handled specifically others will be logged by this "catch all" handler.
  12
  13         Generally there should not be many messages logged here but we include a stack trace to assist with debugging these.
  14
  15         The messages here do not tend to originate from your Agents unless they are syntax error related but more likely to be situations like security failures due to incorrect SSL keys and so forth
  16
  17         Should you come across one that is a regular accorance in your logs please open a ticket including your backtrace and we will improve the handling of that situation
  18     pattern: "Failed to handle message: %{error}"
  19   PLMC11:
  20     example: "Cache expired on 'ddl' key 'agent/nrpe'"
  21     expanded: |-
  22         MCollective has an internal Cache used to speed up operations like parsing of DDL files.  The cache is also usable from the agents and other plugins you write.
  23
  24         Each entry in the cache has an associated TTL or maximum life time, once the maximum time on an item is reached it is considered expired.  Next time anything attempts to read this entry from the cache this log line will be logged.
  25
  26         This is part of the normal operations of MCollective and doesn't indicate any problem.  We log this debug message to help you debug your own use of the cache.
  27     pattern: "Cache expired on '%{cache_name}' key '%{item}'"
  28   PLMC12:
  29     example: "Cache hit on 'ddl' key 'agent/nrpe'"
  30     expanded: |-
  31         MCollective has an internal Cache used to speed up operations like parsing of DDL files.  The cache is also usable from the agents and other plugins you write.
  32
  33         Each entry in the cache has an associated TTL or maximum life time, once the maximum time on an item is reached it is considered expired.
  34
  35         This log line indicates that a request for a cache entry was made, the entry had not yet expired and so the cached data is being returned.
  36
  37         It does not indicate a problem, it's just a debugging aid
  38     pattern: "Cache hit on '%{cache_name}' key '%{item}'"
  39   PLMC13:
  40     example: "Could not find a cache called 'my_cache'"
  41     expanded: |-
  42         MCollective has an internal Cache used to speed up operations like parsing of DDL files.  The cache is also usable from the agents and other plugins you write.
  43
  44         The cache is made up of many named caches, this error indicates that a cache has not yet been setup prior to trying to use it.
  45     pattern: "Could not find a cache called '%{cache_name}'"
  46   PLMC14:
  47     example: "No block supplied to synchronize on cache 'my_cache'"
  48     expanded: |-
  49         When using the Cache to synchronize your own code across agents or other plugins you have to supply a block to synchronise.
  50
  51         Correct usage would be:
  52
  53             Cache.setup(:customer, 600)
  54             Cache(:customer).synchronize do
  55                # update customer record
  56             end
  57
  58         This error is raise when the logic to update the customer record is not in a block as in the example
  59     pattern: "No block supplied to synchronize on cache '%{cache_name}'"
  60   PLMC15:
  61     example: "No item called 'nrpe_agent' for cache 'ddl'"
  62     expanded: |-
  63         MCollective has an internal Cache used to speed up operations like parsing of DDL files.  The cache is also usable from the agents and other plugins you write.
  64
  65         The cache stored items using a key, this error will be logged and raised when you try to access a item that does not yet exist in the cache.
  66     pattern: "No item called '%{item}' for cache '%{cache_name}'"
  67   PLMC16:
  68     example: "'hello' does not look like a numeric value"
  69     expanded: |-
  70         When MCollective receives an argument from the command line like port=fello it consults the DDL file to determine the desired type of this parameter, it then tries to convert the input string into the correct numeric value.
  71
  72         This error indicates the input you provided could not be converted into the desired format.
  73
  74         You'll usually see this when using the 'mco rpc' command to interact with an agent.  This is usually a fatal error, the request will not be sent if it does not validate against the DDL.
  75     pattern: "'%{value}' does not look like a numeric value"
  76   PLMC17:
  77     example: "'flase' does not look like a boolean value"
  78     expanded: |-
  79         When MCollective receives an argument from the command line like force=true it consults the DDL file to determine the desired type of this parameter, it then tries to convert the input string into the correct boolean value.
  80
  81         This error indicates the input you provided could not be converted into the desired boolean format.  It wil accept "true", "t", "yes", "y" and "1" as being true.  It will accept "false", "f", "no", "n", "0" as being false.
  82
  83         You'll usually see this when using the 'mco rpc' command to interact with an agent.  This is usually a fatal error, the request will not be sent if it does not validate against the DDL.
  84     pattern: "'%{value}' does not look like a boolean value"
  85   PLMC18:
  86     example: "Found 'rpcutil' ddl at '/usr/libexec/mcollective/mcollective/agent/rpcutil.ddl'"
  87     expanded: |-
  88         Most plugin types have a DDL file that needs to be correctly installed for the plugin to function.  There can be multiple libdirs that can provide the DDL file for a specific plugin.
  89
  90         This message is a message designed to help you debug issues when you think the wrong DDL file is being used.
  91     pattern: "Found '%{ddlname}' ddl at '%{ddlfile}'"
  92   PLMC19:
  93     expanded: |-
  94         Usually when MCollective run it validates all requirements are met before publishing a request or processing a request against the DDL file for the agent.
  95
  96         This can be difficult to satisfy in development perhaps because you are still writing your DDL files or debugging issues.
  97
  98         This message indicates that when MCollective detects it's running against an unreleased version of MCollective - like directly out of a Git clone - it will skip the DDL validation steps.  It is logged at a warning level as this significantly changes the behaviour of the client and server.
  99     pattern: "DDL requirements validation being skipped in development"
 100   PLMC2:
 101     expanded: "When sending the mcollectived process the USR1 signal on a Unix based machine this message will indicate that the signal got received and all agents are being reloaded from disk\n"
 102     pattern: "Reloading all agents after receiving USR1 signal"
 103   PLMC20:
 104     example: "Agent plugin 'example' requires MCollective version 2.2.1 or newer"
 105     expanded: |-
 106         MCollective plugins can declare a minimum version of MCollective that they require to be functional.
 107
 108         MCollective validates this when it loads the plugin and this error will be logged or shown to the user when this requirement cannot be satisfied.
 109     pattern: "%{type} plugin '%{name}' requires MCollective version %{requirement} or newer"
 110   PLMC21:
 111     example: "Cannot validate input 'service': Input string is longer than 40 character(s)"
 112     expanded: |-
 113         Every input you provide to a RPC request is validated against it's DDL file. This error will be shown when the supplied data does not pass validation against the DDL.
 114
 115         Consult the 'mco plugin doc' command to view the DDL file for your action and input.
 116     pattern: "Cannot validate input '%{input}: %{error}"
 117   PLMC22:
 118     example: "Cannot determine what entity input 'port' belongs to"
 119     expanded: |-
 120         When writing a DDL you declare inputs into plugins using the input keyword.  Each input has to belong to a wrapping entity like in the example below:
 121
 122             action "get_data", :description => "Get data from a data plugin" do
 123                 input :source,
 124                       :prompt      => "Data Source",
 125                       :description => "The data plugin to retrieve information from",
 126                       :type        => :string,
 127                       :validation  => '^\w+$',
 128                       :optional    => false,
 129                       :maxlength   => 50
 130             end
 131
 132         Here the input belongs to the action entity "get_data", this error indicates that an input were found without it belonging to any specific entity
 133     pattern: "Cannot determine what entity input '%{input}' belongs to"
 134   PLMC23:
 135     example: "Input needs a :prompt property"
 136     expanded: "When writing a DDL you declare inputs for all data that you pass into the plugin.  Inputs have a minimally required field set and this error indicate that you did not provide some key field while describing the input."
 137     pattern: "Input needs a :%{property} property"
 138   PLMC24:
 139     example: "Failed to load DDL for the 'rpcutil' agent, DDLs are required: RuntimeError: failed to parse DDL file"
 140     expanded: |-
 141         As of version 2.0.0 DDL files are required by the MCollective server.  This server indicates that it either could not find the DDL for the rpcutil agent or that there was a syntax error.
 142
 143         Confirm that the DDL file is installed in the agent directory and that it parses correctly using the 'mco plugin doc' command.
 144     pattern: "Failed to load DDL for the '%{agent}' agent, DDLs are required: %{error_class}: %{error}"
 145   PLMC25:
 146     example: "aggregate method for action 'rpcutil' is missing a function parameter"
 147     expanded: |-
 148         DDL files can declare aggregation rules for the data returned by actions as seen below:
 149
 150                  summarize do
 151                     aggregate summary(:collectives)
 152                  end
 153
 154         This error indicates that you did not supply the argument - :collectives in this example.
 155     pattern: "aggregate method for action '%{action}' is missing a function parameter"
 156   PLMC26:
 157     expanded: |-
 158         Internally when MCollective parse the DDL it converts the aggregate functions into a hash with the function name and any arguments.
 159
 160         This error indicates that the internal translation failed, this is a critical error and would probably indicate a structure problem in your DDL or a bug in MCollective
 161     pattern: "Functions supplied to aggregate should be a hash"
 162   PLMC27:
 163     expanded: |-
 164         DDL aggregate functions can take a custom format as in the example below:
 165
 166             aggregate average(:total_resources, :format => "Average: %d")
 167
 168         This error indicate that the :format above could not be correctly parsed.
 169     pattern: "Formats supplied to aggregation functions must have a :format key"
 170   PLMC28:
 171     expanded: |-
 172         DDL aggregate functions can take a custom format as in the example below:
 173
 174             aggregate average(:total_resources, :format => "Average: %d")
 175
 176         This error indicate that the :format above was not supplied as a hash as in the above example
 177     pattern: "Formats supplied to aggregation functions should be a hash"
 178   PLMC29:
 179     example: "Attempted to call action 'yum_clean' for 'package' but it's not declared in the DDL"
 180     expanded: |-
 181         Every agent has a DDL file that describes valid actions that they can perform
 182
 183         This error indicates you attempted to perform an action that does not exist.  Review the plugin documentation using 'mco plugin doc' for correct usage
 184     pattern: "Attempted to call action '%{action}' for '%{plugin}' but it's not declared in the DDL"
 185   PLMC3:
 186     expanded: |-
 187         When sending the mcollectived process the USR2 signal on a Unix based machine this message indicates that the signal for received and the logging level is being adjusted to the next higher level or back down to debug if it was already at it's highest level.
 188
 189         This message will be followed by another message similar to the one below:
 190
 191             Logging level is now WARN
 192     pattern: "Cycling logging level due to USR2 signal"
 193   PLMC30:
 194     example: "Action 'get_fact' needs a 'fact' argument"
 195     expanded: "Actions can declare that they expect a required input, this error indicates that you did not supply the required input"
 196     pattern: "Action '%{action}' needs a '%{key}' argument"
 197   PLMC31:
 198     example: "No dataquery has been defined in the DDL for data plugin 'package'"
 199     expanded: |-
 200         Each data plugin requires a DDL that has a 'dataquery' block in it.
 201
 202             dataquery :description => "Agent Meta Data" do
 203                 .
 204                 .
 205             end
 206
 207         This error indicates that the DDL file for a specific data plugin did not contain this block.
 208     pattern: "No dataquery has been defined in the DDL for data plugin '%{plugin}'"
 209   PLMC32:
 210     expanded: "Data plugins must return data.  The DDL files for a data plugin must declare at least one output parameter else you will see this error."
 211     pattern: "No output has been defined in the DDL for data plugin '%{plugin}'"
 212   PLMC33:
 213     example: "No data plugin argument was declared in the 'puppet' DDL but an input was supplied"
 214     expanded: |-
 215         Data plugins can take an optional input argument.  This error indicate that you supplied an input argument but the plugin does not actually expect any input.
 216
 217         Review the documentation for the data plugin using 'mco plugin doc'
 218     pattern: "No data plugin argument was declared in the '%{plugin}' DDL but an input was supplied"
 219   PLMC34:
 220     example: "setting meta data in agents have been deprecated, DDL files are now being used for this information. Please update the 'package' agent"
 221     expanded: |-
 222         In the past each MCollective agent had a metadata section containing information like the timeout.
 223
 224         As of 2.2.0 the agents will now consult the DDL files that ship with each agent for this purpose so the metadata in agents are not used at all.
 225
 226         In order to remove confusing duplication setting metadata in agents have been deprecated and from version 2.4.0 will not be supported at all.
 227
 228         Please update your agent by removing the metadata section from it and make sure the DDL file has the correct information instead.
 229     pattern: "setting meta data in agents have been deprecated, DDL files are now being used for this information. Please update the '%{agent}' agent"
 230   PLMC35:
 231     expanded: |-
 232         The MCollective client can ask that the agent just performs the action and never respond.  Like when supplying the --no-results option to the 'mco rpc' application.
 233
 234         This log line indicates that the request was received and interpreted as such and no reply will be sent.  This does not indicate a problem generally it's just there to assist with debugging of problems.
 235     pattern: "Client did not request a response, surpressing reply"
 236   PLMC36:
 237     example: "Unknown action 'png' for agent 'rpcutil'"
 238     expanded: |-
 239         Agents are made up of a number of named actions.  When the MCollective Server receives a request it double checks if the agent in question actually implements the logic for a specific action.
 240
 241         When it cannot find the implementation this error will be raised.  This is an unusual situation since at this point on both the client and the server the DDL will already have been used to validate the request and the DDL would have indicated that the action is valid.
 242
 243         Check your agent code and make sure you have code like:
 244
 245             action "the_action" do
 246                 .
 247                 .
 248             end
 249     pattern: "Unknown action '%{action}' for agent '%{agent}'"
 250   PLMC37:
 251     example: "Starting default activation checks for the 'rpcutil' agent"
 252     expanded: |-
 253         Each time the MCollective daemon starts it loads each agent from disk.  It then tries to determine if the agent should start on this node by using the activate_when method or per-agent configuration.
 254
 255         This is a debug statement that shows you it is about to start interacting with the logic in the agent to determine if it should be made available or not.
 256     pattern: "Starting default activation checks for the '%{agent}' agent"
 257   PLMC38:
 258     example: "Found plugin configuration 'exim.activate_agent' with value 'y'"
 259     expanded: |-
 260         The administrator can choose that a certain agent that is deployed on this machine should not be made available to the network.
 261
 262         To do this you would add a configuration value like this example to the mcollective server.cfg:
 263
 264             plugin.exim.activate_agent = n
 265
 266         If this value is "1", "y" or "true" the agent will be activated else it will be disabled.
 267     pattern: "Found plugin configuration '%{agent}.activate_agent' with value '%{should_activate}'"
 268   PLMC39:
 269     example: "Audit failed with an error, processing the request will continue."
 270     expanded: |-
 271         Every MCollective request can be audited.  In the event where the auditing fails the processing continues.
 272
 273         At present the failure handling is not configurable, in future the administrator might elect to not run unaudited requests via configuration.
 274   PLMC4:
 275     example: "Failed to start registration plugin: ArgumentError: meta.rb:6:in `gsub': wrong number of arguments (0 for 2)"
 276     expanded: |
 277         Registration plugins are loaded into the MCollective daemon at startup and ran on a regular interval.
 278
 279         This message indicate that on first start this plugin failed to run, it will show the exception class, line and exception message to assist with debugging
 280     pattern: "Failed to start registration plugin: %{error}"
 281   PLMC40:
 282     example: "Can't find DDL for agent plugin 'puppet'"
 283     expanded: |-
 284         MCollective plugins come with DDL files that describe their behaviours, versions, capabilities and requirements.
 285
 286         This error indicate that a DDL file for the plugin mentioned could not be found - it could be that you have a typing error in your command line or an installation error.
 287     pattern: "Can't find DDL for %{type} plugin '%{name}'"
 288   PLMC5:
 289     expanded: |-
 290         In previous versions of MCollective a application called 'controller' were included that had the ability to request agent reloads and other commands that would control the runner.
 291
 292         Unfortunately this method of controlling the daemon was never considered stable or reliable and has since been deprecate for removal during the 2.3.x development series
 293     pattern: "Received a control message, possibly via 'mco controller' but this has been deprecated"
 294   PLMC6:
 295     expanded: |-
 296         When a specific MCollective daemon receives a message from a network it validates the filter before processing the message.  The filter is the list of classes, facts or other conditions that are associated with any message.
 297
 298         In the case where the filter does not match the specific host this line gets logged.
 299
 300         It's often the case for broadcast messages that all MCollective nodes will receive a message but only a subset of nodes are targetted using the filters, in that situation the nodes that received the request but should not respond to it will see this log line.
 301
 302         It does not indicate anything to be concerned about but if you find debugging a problem and expect a node to have responded when it shouldn't this log line will give you a hint that some condition specified in the filter did not match the local host
 303     pattern: "Message does not pass filters, ignoring"
 304   PLMC7:
 305     example: "Exiting after signal: SignalException: runner.rb:6:in `run': Interrupt"
 306     expanded: |-
 307         When the MCollective daemon gets a signal from the Operating System that it does not specifically handle it will log this line before exiting.
 308
 309         You would see this whenever the daemon is stopped by init script or when sending it a kill signal, it will then proceed to disconnect from the middleware and exit its main loop
 310     pattern: "Exiting after signal: %{error}"
 311   PLMC8:
 312     example: "Handling message for agent 'rpcutil' on collective 'eu_collective' with requestid 'a8a78d0ff555c931f045b6f448129846'"
 313     expanded: |-
 314         After receiving a message from the middleware, decoding it, validating it's security credentials and doing other checks on it the MCollective daemon will pass it off to the actual agent code for processing.
 315
 316         Prior to doing so it will log this line indicating the agent name and sub-collective and other information that will assist in correlating the message sent from the client with those in the server logs being processed.
 317     pattern: "Handling message for agent '%{agent}' on collective '%{collective} with requestid '%{requestid}'"
 318   PLMC9:
 319     example: "Expired Message: message 8b4fe522f0d0541dabe83ec10b7fa446 from cert=client@node created at 1358840888 is 653 seconds old, TTL is 60"
 320     expanded: |-
 321         Requests sent from clients to servers all have a creation time and a maximum validity time called a TTL.
 322
 323         This message indicates that a message was received from the network but that it was determined to be too based on the TTL settings.
 324
 325         Usually this happens because your clocks are not in sync - something that can be fixed by rolling out a tool like ntp across your server estate.
 326
 327         It might also happen during very slow network conditions or when the TTL is set too low for your general network latency.
 328     pattern: "Expired Message: %{error}"