REST Resource: projects.locations.instances.logTypes.parserExtensions.validationReports

Resource: ValidationReport

ValidationReport describes the validation status of a parser/extension when it was created.

JSON representation 
{
  "name": string,
  "verdict": enum (Verdict),
  "stats": {
    object (Stats)
  },
  "error": {
    object (ParsingValidationErrors)
  }
}
Fields
name

string

Output only. name of the validation report resource.
verdict

enum (Verdict)

Verdict of the validation.
stats

object (Stats)

Stats of the validation.
error

object (ParsingValidationErrors)

Errors occurred during validation.

Verdict

Verdict represents verdict of the parser validation.

Enums
VERDICT_UNSPECIFIED The verdict is unspecified.
PASS The validation has passed.
FAIL The validation has failed.

Stats

Stats represents the statistics generated by running the parser/extension over a set of sample logs.

JSON representation 
{
  "log_entry_count": string,
  "successfully_normalized_log_count": string,
  "failed_log_count": string,
  "invalid_log_count": string,
  "on_error_count": string,
  "event_count": string,
  "generic_event_count": string,
  "event_category_counts": {
    string: string,
    ...
  },
  "drop_tag_counts": {
    string: string,
    ...
  },
  "max_parse_duration": string,
  "avg_parse_duration": string,
  "normalization_percentage": string,
  "generic_event_percentage": string
}
Fields
log_entry_count

string (int64 format)

Count of log entries parsed.
successfully_normalized_log_count

string (int64 format)

Count of log entries which successfully created valid events.
failed_log_count

string (int64 format)

Count of log entries which failed to create a valid event.
invalid_log_count

string (int64 format)

Count of log entries which were skipped in parsing because they were invalid.
on_error_count

string (int64 format)

Count of times "on_error" was encountered while parsing. An on_error field is used in CBN config to catch an error and handle. on_error_count counts the number of times errors were handled while parsing the logs.
event_count

string (int64 format)

Count of events generated.
generic_event_count

string (int64 format)

Count of events created of type GENERIC_EVENT.
event_category_counts

map (key: string, value: string (int64 format))

Stats to account for events created. It stores invalid event reasons and the count corresponding to it.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
drop_tag_counts

map (key: string, value: string (int64 format))

Stats to account for number of logs dropped. When we drop a log line from parsing, we specify a drop tag. We tag it to identify the reason of drop. drop_tag_counts stores the reason for drop and the count corresponding to it.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
max_parse_duration

string (Duration format)

Max time taken to parse a log entry.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
avg_parse_duration

string (Duration format)

Average parse time taken to parse a log entry.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
normalization_percentage

string (int64 format)

Percentage of log lines that successfully generated at least 1 valid event.
generic_event_percentage

string (int64 format)

Percentage of events that have event_type as GENERIC_EVENT.

ParsingValidationErrors

Validation Errors encountered during parser/extension creation.

JSON representation 
{
  "parsing_errors": [
    string
  ],
  "invalid_config_error": string,
  "has_more_parsing_error": boolean
}
Fields
parsing_errors[]

string

Any parsing errors encountered while parsing a log entry, this has cap of size 10.
invalid_config_error

string

Error for invalid config.
has_more_parsing_error

boolean

True, if there are more validation errors.

Methods

get

 Get a validation report.