REST Resource: projects.locations.instances.logTypes.analysisReports

Resource: ParserAnalysisReport

ParserAnalysisReport containing the findings of a parser analysis.

JSON representation 
{
  "name": string,
  "reportType": enum (ReportType),
  "reportStage": enum (ParserAnalysisReportStage),
  "createTime": string,
  "endTime": string,

  // Union field results can be only one of the following:
  "didResults": {
    object (DIDResults)
  },
  "parserValidationResults": {
    object (ParserValidationResults)
  }
  // End of list of possible types for union field results.
}
Fields
name

string

Output only. Identifier. The unique resource name of the analysis report.
reportType

enum (ReportType)

Output only. Type of analysis performed.
reportStage

enum (ParserAnalysisReportStage)

Output only. The current execution state of the analysis.
createTime

string (Timestamp format)

Output only. The time the analysis report was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Output only. The time the analysis operation finished or failed.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Union field results. Output only. Type-specific results. results can be only one of the following:
didResults

object (DIDResults)

Analysis result of the Downstream Impact Detection (DID) analysis.
parserValidationResults

object (ParserValidationResults)

Analysis result of the GitHub Parser analysis.

DIDResults

Result of the DID analysis.

JSON representation 
{
  "impactedRules": [
    {
      object (RuleImpact)
    }
  ],
  "summary": {
    object (ReportSummary)
  },
  "detectionCount": integer,
  "oldParserVersion": string,
  "newParserVersion": string
}
Fields
impactedRules[]

object (RuleImpact)

Output only. A list of rules that are impacted by the parser change.
summary

object (ReportSummary)

Output only. A high-level summary of the analysis results.
detectionCount

integer

Output only. The total number of log detections sampled and processed.
oldParserVersion

string

Output only. The version of the parser currently active.
newParserVersion

string

Output only. The target version of the parser being evaluated.

RuleImpact

Detailed impact analysis for a specific detection rule.

JSON representation 
{
  "rule": string,
  "ruleType": enum (RuleType),
  "ruleDisplayName": string,
  "impactResult": enum (ImpactResult),
  "impactDetails": string,
  "diffFields": [
    string
  ],
  "outcomeFields": [
    {
      object (RuleField)
    }
  ],
  "matchedFields": [
    {
      object (RuleField)
    }
  ],
  "eventFields": [
    {
      object (RuleField)
    }
  ]
}
Fields
rule

string

The unique resource name of the detection rule. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
ruleType

enum (RuleType)

Type of the Rule.
ruleDisplayName

string

The display name of the rule.
impactResult

enum (ImpactResult)

The classification of the impact.
impactDetails

string

Human-readable description of why the rule was flagged.
diffFields[]

string

A list of UDM fields with detected data differences.
outcomeFields[]

object (RuleField)

UDM fields categorized by rule section.
matchedFields[]

object (RuleField)

Matched UDM fields.
eventFields[]

object (RuleField)

Event UDM fields.

ImpactResult

Severity level of the impact on a detection rule.

Enums
IMPACT_RESULT_UNSPECIFIED Impact result unspecified.
NO_IMPACT No impact.
POTENTIAL_IMPACT Potential impact.
BREAKAGE Breakage.

RuleField

Represents a UDM field within a rule.

JSON representation 
{
  "fieldPath": string,
  "diffFound": boolean
}
Fields
fieldPath

string

The UDM path (e.g., "principal.hostname").
diffFound

boolean

Whether this specific field was part of the diff.

ReportSummary

Aggregated statistics summarizing the impact of parser changes.

JSON representation 
{
  "totalRulesAnalyzed": integer,
  "ruleBreakageCount": integer,
  "rulePotentialImpactCount": integer
}
Fields
totalRulesAnalyzed

integer

Total number of unique detection rules evaluated.
ruleBreakageCount

integer

Number of rules with a definitive logic breakage.
rulePotentialImpactCount

integer

Number of rules with potential impact due to data changes.

ParserValidationResults

Result of the Fast Parser Validation analysis.

JSON representation 
{
  "parsingErrors": [
    {
      object (ParsingError)
    }
  ],
  "invalidConfigError": string,
  "fieldCoverageCountDiffLogs": {
    string: {
      object (DifferentiatorLogIndexes)
    },
    ...
  },
  "impUdmFieldsValueDiffLogs": {
    string: {
      object (DifferentiatorLogIndexes)
    },
    ...
  },
  "differentiatorLogs": {
    object (DifferentiatorLogs)
  }
}
Fields
parsingErrors[]

object (ParsingError)

Output only. Parsing errors.
invalidConfigError

string

Output only. Error for invalid config.
fieldCoverageCountDiffLogs

map (key: string, value: object (DifferentiatorLogIndexes))

Output only. The UDM fields and corresponding logs which produced different field count.

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

map (key: string, value: object (DifferentiatorLogIndexes))

Output only. The important UDM Field and corresponding logs which produced different value for the field.

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

object (DifferentiatorLogs)

Output only. The logs which produced different metric value.

ParsingError

Parsing error encountered while validating the parser extension.

JSON representation 
{
  "name": string,
  "logData": string,
  "error": {
    object (Status)
  }
}
Fields
name

string

Output only. The name of this Parsing Error . Output only. The resource name of the parsing error. Format: projects/{project}/locations/{location}/instances/{instance}/validationReports/{report}/parsingErrors/{id}
logData

string (bytes format)

Output only. Data of the Log entry that caused the error.

A base64-encoded string.
error

object (Status)

Output only. Error message when parsing the log.

DifferentiatorLogIndexes

Represents DifferentiatorLogIndexes.

JSON representation 
{
  "logIndexes": [
    integer
  ]
}
Fields
logIndexes[]

integer

Output only. The indexes of the differentiator logs.

DifferentiatorLogs

Represents DifferentiatorLogs.

JSON representation 
{
  "indexedLogs": {
    integer: string,
    ...
  }
}
Fields
indexedLogs

map (key: integer, value: string (bytes format))

The index and corresponding values of the log.

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

ReportType

Enum for the type of analysis.

Enums
REPORT_TYPE_UNSPECIFIED Unspecified analysis type.
DID_ANALYSIS Downstream Impact Detection (DID) analysis.
GITHUB_PARSER_VALIDATION GitHub Parser analysis.

ParserAnalysisReportStage

Possible states of an analysis report.

Enums
PARSER_ANALYSIS_REPORT_STAGE_UNSPECIFIED Invalid status.
PARSER_ANALYSIS_REPORT_STAGE_QUEUED The analysis is queued and waiting for processing resources.
PARSER_ANALYSIS_REPORT_STAGE_RUNNING The analysis is currently in progress.
PARSER_ANALYSIS_REPORT_STAGE_COMPLETED The analysis finished successfully; findings are available in the report.
PARSER_ANALYSIS_REPORT_STAGE_FAILED The analysis failed due to an error. Review the operation metadata for details.
PARSER_ANALYSIS_REPORT_STAGE_ARCHIVED Report is archived. This is set when the new report is generated and current report is obsolete.

Methods

get

 GetParserAnalysisReport gets an analysis report.

list

 ListParserAnalysisReports lists analysis reports.