Assertions Configurations Table View¶
| Property Path | Type | Required | Default | Description |
|---|---|---|---|---|
Assertions |
list or string or null |
✖ | The list of assertions performed on the sessions' results in order to decide the test's status, each assertion produces a different test result. | |
Assertions[] |
object or string |
✖ | ||
Assertions[].Assertion |
string |
✔ | The name of the assertion to use | |
Assertions[].Name |
string |
✔ | The name of the test as presented in the test report with this assertion's result, if none is given creates a name as the type of the assertion and guid | |
Assertions[].AssertionConfiguration |
object or string or null |
✖ | Implementation configuration for the assertion, the configuration given here is loaded into the provided assertion dynamically. | |
Assertions[].Category |
string or null |
✖ | The category of the assersion. Can filter which categories to run using the -A flag | |
Assertions[].Configuration |
object or string |
✖ | ||
Assertions[].DisplayTrace |
string or true/false |
✖ | True | Whether to display the assertion's message trace in the assertion results or not. Should be set to false when the assertion trace is massive and displaying it can cause performance issues |
Assertions[].SaveAttachments |
string or true/false |
✖ | True | Whether to save the attachments of the assertion in the test report (true) or not (false) |
Assertions[].SaveLogs |
string or true/false |
✖ | True | Whether to save the session logs belonging to this assertion in the test report |
Assertions[].SaveSessionData |
string or true/false |
✖ | True | Whether to save the data of the session's belonging to this assertion in the test report |
Assertions[].SaveTemplate |
string or true/false |
✖ | True | Whether to save the configuration template in the test report (true) or not (false) |
Assertions[].Severity |
one of [Trivial / Minor / Normal / Critical / Blocker] |
✖ | The severity of the assertion, can be used to set the severity of the test in the test report. | |
Assertions[].DataSourceNames |
list or string |
✖ | Names of the pre defined data sources to pass to the assertion | |
Assertions[].DataSourceNames[] |
string |
✖ | ||
Assertions[].DataSourcePatterns |
list or string |
✖ | Regex patterns of data sources | |
Assertions[].DataSourcePatterns[] |
string |
✖ | ||
Assertions[].Links |
list or string |
✖ | The assertion's specific links. Will be added with the general links. | |
Assertions[].Links[] |
object or string |
✖ | ||
Assertions[].Links[].Configuration |
object or string |
✖ | ||
Assertions[].Links[].Name |
string or null |
✖ | The display name of the link in the test results, if none is given uses the Type as the name |
|
Assertions[].Links[].Grafana |
object or string |
✖ | Links the grafana dashboard filtered for the test's session times to each test result. | |
Assertions[].Links[].Grafana.DashboardId |
string |
✔ | The Id of the desired dashboard to view | |
Assertions[].Links[].Grafana.Url |
string |
✔ | The grafana's url, the base url without any route | |
Assertions[].Links[].Grafana.Variables |
list or string |
✖ | The variables to display the dashboard with | |
Assertions[].Links[].Grafana.Variables[] |
object or string |
✖ | ||
Assertions[].Links[].Grafana.Variables[].Key |
string |
✖ | ||
Assertions[].Links[].Grafana.Variables[].Value |
string |
✖ | ||
Assertions[].Links[].Kibana |
object or string |
✖ | Links the kibana's discovery filtered for the test's session times to each test result. | |
Assertions[].Links[].Kibana.DataViewId |
string |
✔ | The Id of the desired data view to view | |
Assertions[].Links[].Kibana.Url |
string |
✔ | The kibana's url, the base url without any route | |
Assertions[].Links[].Kibana.KqlQuery |
string or null |
✖ | A custom Kql query to add to the generated URL, this query is added to the session time filtering query with and |
|
Assertions[].Links[].Kibana.TimestampField |
string |
✖ | @timestamp | The name of the main timestamp field to use to query on specific times in given data view |
Assertions[].Links[].Prometheus |
object or string |
✖ | Links the prometheus' graph filtered for the test's session times to each test result. | |
Assertions[].Links[].Prometheus.Url |
string |
✔ | The prometheus' url, the base url without any route | |
Assertions[].Links[].Prometheus.Expressions |
list or string |
✖ | [ "" ] |
The expressions to generate prometheus panels for |
Assertions[].Links[].Prometheus.Expressions[] |
string |
✖ | ||
Assertions[].SessionNamePatterns |
list or string or null |
✖ | Regex patterns of session names | |
Assertions[].SessionNamePatterns[] |
string |
✖ | ||
Assertions[].SessionNames |
list or string or null |
✖ | The names of session datas to give the assertion | |
Assertions[].SessionNames[] |
string |
✖ | ||
Assertions[].StatusesToReport |
list or string |
✖ | List containing all assertion statuses | Defines which assertion statuses will appear in the final report. Statuses explicitly listed will be included in the report, while all others will be exluded.Options: [Passed Broken Failed Skipped Unknown ] |
Assertions[].StatusesToReport[] |
one of [Passed / Failed / Broken / Unknown / Skipped] |
✖ | 0 = Passed 1 = Failed 2 = Broken 3 = Unknown 4 = Skipped |