Splunk Search

How to include arguments in search macros with non-alphanumeric values

cherrypick
Path Finder

I have arguments for my macro that contain other values e.g. $env:user$ and $timepicker.earliest$/$timepicker.latest$. How do I include these in my macro definition as it doesn't allow me since macro arguments must only contain alphanumeric, '_' and '-' characters?

 

 

Labels (1)
0 Karma
1 Solution

yuanliu
SplunkTrust
SplunkTrust

Use macro params to pass these tokens.  Here is an example:

NameDefinitionArguments
non-alphabetic-token(2)index=_internal earliest=$earliest_tok$ latest=$latest_tok$earliest_tok, latest_tok

 

<form version="1.1" theme="light">
  <label>Non-alphabetic tokens</label>
  <description>https://community.splunk.com/t5/Splunk-Search/How-to-include-arguments-in-search-macros-with-non-alphanumeric/m-p/696333#M236667</description>
  <fieldset submitButton="false">
    <input type="time" token="timepicker" searchWhenChanged="true">
      <label>pick time</label>
      <default>
        <earliest>-15m</earliest>
        <latest>now</latest>
      </default>
    </input>
  </fieldset>
  <row>
    <panel>
      <title>$timepicker.earliest$</title>
      <table>
        <search>
          <query>`non-alphabetic-token($timepicker.earliest$, $timepicker.latest$)`
| addinfo
| stats count by info_min_time info_max_time
| foreach info_*
    [eval &lt;&lt;FIELD&gt;&gt; = strftime(&lt;&lt;FIELD&gt;&gt;, "%F %T")]</query>
          <earliest>-24h@h</earliest>
          <latest>now</latest>
        </search>
        <option name="drilldown">none</option>
        <option name="refresh.display">progressbar</option>
      </table>
    </panel>
  </row>
</form>

 

Here are some sample interactions:

non-alphabetic-token-recent.png

non-alphabetic-token-past.png

  

View solution in original post

0 Karma

PickleRick
SplunkTrust
SplunkTrust

I'm not sure you understand the macros correctly.

if you define a macro with two parameters paramA and paramB it will get substituted in your search with whatever values you specify for them. These are separate layers.

0 Karma

yuanliu
SplunkTrust
SplunkTrust

Use macro params to pass these tokens.  Here is an example:

NameDefinitionArguments
non-alphabetic-token(2)index=_internal earliest=$earliest_tok$ latest=$latest_tok$earliest_tok, latest_tok

 

<form version="1.1" theme="light">
  <label>Non-alphabetic tokens</label>
  <description>https://community.splunk.com/t5/Splunk-Search/How-to-include-arguments-in-search-macros-with-non-alphanumeric/m-p/696333#M236667</description>
  <fieldset submitButton="false">
    <input type="time" token="timepicker" searchWhenChanged="true">
      <label>pick time</label>
      <default>
        <earliest>-15m</earliest>
        <latest>now</latest>
      </default>
    </input>
  </fieldset>
  <row>
    <panel>
      <title>$timepicker.earliest$</title>
      <table>
        <search>
          <query>`non-alphabetic-token($timepicker.earliest$, $timepicker.latest$)`
| addinfo
| stats count by info_min_time info_max_time
| foreach info_*
    [eval &lt;&lt;FIELD&gt;&gt; = strftime(&lt;&lt;FIELD&gt;&gt;, "%F %T")]</query>
          <earliest>-24h@h</earliest>
          <latest>now</latest>
        </search>
        <option name="drilldown">none</option>
        <option name="refresh.display">progressbar</option>
      </table>
    </panel>
  </row>
</form>

 

Here are some sample interactions:

non-alphabetic-token-recent.png

non-alphabetic-token-past.png

  

0 Karma

cherrypick
Path Finder

Amazing! Thank you. Yes I misunderstood macros.

0 Karma

cherrypick
Path Finder

Or is there another way to use re-usable SPL searches that can take these values into account?

0 Karma
Get Updates on the Splunk Community!

Cloud Platform & Enterprise: Classic Dashboard Export Feature Deprecation

As of Splunk Cloud Platform 9.3.2408 and Splunk Enterprise 9.4, classic dashboard export features are now ...

Explore the Latest Educational Offerings from Splunk (November Releases)

At Splunk Education, we are committed to providing a robust learning experience for all users, regardless of ...

New This Month in Splunk Observability Cloud - Metrics Usage Analytics, Enhanced K8s ...

The latest enhancements across the Splunk Observability portfolio deliver greater flexibility, better data and ...