Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
Sometimes it is necessary to run plugins or local checks asynchronously. Here is guidance on how to achieve this!

Status
colourGreen
titleLAST TESTED ON CHECKMK 2.13.0P1


Panel
borderColorblack
bgColor#f8f8f8
titleTable of Contents

Table of Contents

Step-by-step guide

Required settings

Set cache age for

...

plug-ins and local checks

A cache age limit on plugins and local checks. If set, the output of plugins is cached and reused until this much time has passed.

Setup → Agents → Windows, Linux, Solaris, AIX → Agent rules → Set cache age for plugins plug-ins and local checks → Add rule
Screenshot of adding a new rule for Set cache age for plugins and local checks. The max cache age is set to 600 seconds.Image RemovedImage Added

Set execution mode for

...

plug-ins and local checks

Some scripts are slow and can therefore stall the execution of the agent. To remedy this, such scripts may be run asynchronously. With this rule, asynchronous execution can be set on a per-script basis.

Setup → Agents → Windows, Linux, Solaris, AIX → Agent rules → Set execution mode for plugins and local checks → Edit rule: AIX → Agent rules → Set execution mode for plugins plug-ins and local checks → Add rule

Screenshot of adding a new rule for set execution mode for plugins and local checks. Execution mode is set to Asynchronous. Image RemovedImage Added



Set timeouts for

...

plug-ins and local checks

A timeout on plugins and local checks keeps those checks from stalling the whole agent. If no timeout is configured here, the default is 60 seconds.

Setup → Agents → Windows, Linux, Solaris, AIX → Agent rules → Set timeouts for plugins plug-ins and local checks → New rule: Set timeouts for plugins and local checks Screenshot of adding a new rule for set timeouts for plugin and local checks. The timeout is set to 180 seconds.Image RemovedAdd rule

Image Added



Optional settings

Set retry count for

...

plug-ins and local checks

If set, the plugin may be called repeatedly - up to this many times or until it finishes successfully.

Setup → Agents → Windows, Linux, Solaris, AIX → Agent rules → Set retry count for plugins plug-ins and local checks → New rule: Set retry count for plugins and local checksScreenshot of adding a new rule for set retry count for plugins and local checks. The retry count is set to 60.Image RemovedAdd rule

Image Added


Note

Please don't forget to set some conditions!

...

Note

About the pattern: The pattern (wildcards supported) by which to select the affected scripts.

Recommended values for caching and timeout: >60 seconds


Info

All options are explained here if you're not able to use agent bakery: https://docs.checkmk.com/latest/en/agent_windows.html#customizeexecutionIf you are not using the agent bakery, check this documentation page to see how to manually perform the configuration.

Filter by label (Content by label)
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel in ( "windows" , "windows_agent" , "agent_bakery" ) and type = "page" and space = "KB"
labelssecurity

...