Customize Consent Preferences

We use cookies to help you navigate efficiently and perform certain functions. You will find detailed information about all cookies under each consent category below.

The cookies that are categorized as "Necessary" are stored on your browser as they are essential for enabling the basic functionalities of the site. ... 

Always Active

Necessary cookies are required to enable the basic features of this site, such as providing secure log-in or adjusting your consent preferences. These cookies do not store any personally identifiable data.

No cookies to display.

Functional cookies help perform certain functionalities like sharing the content of the website on social media platforms, collecting feedback, and other third-party features.

No cookies to display.

Analytical cookies are used to understand how visitors interact with the website. These cookies help provide information on metrics such as the number of visitors, bounce rate, traffic source, etc.

No cookies to display.

Performance cookies are used to understand and analyze the key performance indexes of the website which helps in delivering a better user experience for the visitors.

No cookies to display.

Advertisement cookies are used to provide visitors with customized advertisements based on the pages you visited previously and to analyze the effectiveness of the ad campaigns.

No cookies to display.

Parameter Types: grep

Created on June 21, 2022

“grep” Parameter Properties

A grep parameter defines report data that comes from searching a log file for a particular string.

Example

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
{
"type": "grep",
"marker": "T2_btime_dsLock_split",
"search": "Downstream Lock Success=",
"logFile": "BootTime.log",
"use": "absolute"
}
{ "type": "grep", "marker": "T2_btime_dsLock_split", "search": "Downstream Lock Success=", "logFile": "BootTime.log", "use": "absolute" }
{
   "type": "grep",
   "marker": "T2_btime_dsLock_split",
   "search": "Downstream Lock Success=", 
   "logFile": "BootTime.log",
   "use": "absolute"
}

Available Properties

Property

Type

Required

typestringRequired
markerstringRequired
searchstringRequired
logFilestringRequired
usestringOptional
reportEmptybooleanOptional

type


Defines a grep parameter

type

  • is required
  • Type: string

type Constraints

constant: the value of this property must be equal to:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code class="language-json">"grep"</code><br><br>
<code class="language-json">"grep"</code><br><br>
"grep"

marker


The key name to be used for this data in the generated report.

marker

  • is required
  • Type: string


search


The string for which to search within the log file.

search

  • is required
  • Type: string


logFile


The name of the log file to be searched.

logFile

  • is required
  • Type: string


use


This property indicates how the data for this parameter should be gathered and reported.

use

  • is optional
  • Type: string
  • example:
Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code class="language-json"> "use":"count"
</code>
<code class="language-json"> "use":"count" </code>
  "use":"count"

use Constraints

enum: the value of this property must be equal to one of the following values:

Value

Explanation

"count"Indicates that the value to report for this parameter is the number of times it has occurred during the reporting interval.
"absolute"Indicates that the value to report for this parameter is the last actual value received, in the case of events, or found in the log file, in the case of greps.
"csv"Indicates that the value to report for this parameter is a comma separated list of all the actual values received, in the case of events, or found in the log file, in the case of greps. NOTE: “csv” is not currently supported in Telemetry 2.0.

use Default Value

The default value is:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code class="language-json">"absolute"
</code>
<code class="language-json">"absolute" </code>
"absolute"


reportEmpty


Should this marker name be included in the generated report even if the search string was not found in the log file?

reportEmpty

  • is optional
  • Type: boolean

reportEmpty Default Value

The default value is:

Plain text
Copy to clipboard
Open code in new window
EnlighterJS 3 Syntax Highlighter
<code class="language-json">"false"
</code>
<code class="language-json">"false" </code>
"false"